← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to libdb/docs/api_java/db_upgrade.html

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
libdb/docs/api_java/db_upgrade.html
1
 
<!--$Id$-->
2
 
<!--Copyright 1997-2002 by Sleepycat Software, Inc.-->
3
 
<!--All rights reserved.-->
4
 
<!--See the file LICENSE for redistribution information.-->
5
 
<html>
6
 
<head>
7
 
<title>Berkeley DB: Db.upgrade</title>
8
 
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
9
 
<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++">
10
 
</head>
11
 
<body bgcolor=white>
12
 
<a name="2"><!--meow--></a>
13
 
<table width="100%"><tr valign=top>
14
 
<td>
15
 
<h1>Db.upgrade</h1>
16
 
</td>
17
 
<td align=right>
18
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
19
 
</td></tr></table>
20
 
<hr size=1 noshade>
21
 
<tt>
22
 
<h3><pre>
23
 
import com.sleepycat.db.*;
24
 
<p>
25
 
public void upgrade(String file, int flags)
26
 
    throws DbException;
27
 
</pre></h3>
28
 
<h1>Description</h1>
29
 
<p>The Db.upgrade method upgrades all of the databases included in the
30
 
file <b>file</b>, if necessary.  If no upgrade is necessary,
31
 
Db.upgrade always returns success.
32
 
<p><b>Database upgrades are done in place and are destructive. For example,
33
 
if pages need to be allocated and no disk space is available, the
34
 
database may be left corrupted.  Backups should be made before databases
35
 
are upgraded.  See <a href="../ref/am/upgrade.html">Upgrading databases</a>
36
 
for more information.</b>
37
 
<p>Unlike all other database operations, Db.upgrade may only be done
38
 
on a system with the same byte-order as the database.
39
 
<p>The <b>flags</b> value must be set to 0 or
40
 
the following value:
41
 
<p><dl compact>
42
 
<p><dt><a name="Db.DB_DUPSORT">Db.DB_DUPSORT</a><dd><b>This flag is only meaningful when upgrading databases from
43
 
releases before the Berkeley DB 3.1 release.</b>
44
 
<p>As part of the upgrade from the Berkeley DB 3.0 release to the 3.1 release,
45
 
the on-disk format of duplicate data items changed.  To correctly
46
 
upgrade the format requires applications to specify whether duplicate
47
 
data items in the database are sorted or not.  Specifying the
48
 
Db.DB_DUPSORT flag informs Db.upgrade that the duplicates
49
 
are sorted; otherwise they are assumed to be unsorted.  Incorrectly
50
 
specifying the value of this flag may lead to database corruption.
51
 
<p>Further, because the Db.upgrade method upgrades a physical file
52
 
(including all the databases it contains), it is not possible to use
53
 
Db.upgrade to upgrade files in which some of the databases it
54
 
includes have sorted duplicate data items, and some of the databases it
55
 
includes have unsorted duplicate data items.  If the file does not have
56
 
more than a single database, if the databases do not support duplicate
57
 
data items, or if all of the databases that support duplicate data items
58
 
support the same style of duplicates (either sorted or unsorted),
59
 
Db.upgrade will work correctly as long as the
60
 
Db.DB_DUPSORT flag is correctly specified.  Otherwise, the file
61
 
cannot be upgraded using Db.upgrade; it must be upgraded
62
 
manually by dumping and reloading the databases.
63
 
</dl>
64
 
<p>The Db.upgrade method throws an exception that encapsulates a non-zero error value on
65
 
failure.
66
 
<h1>Environment Variables</h1>
67
 
<p><dl compact>
68
 
<p><dt>DB_HOME<dd>If a <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was specified, the
69
 
environment variable <b>DB_HOME</b> may be used as the path of the
70
 
database environment home.
71
 
<p>Db.upgrade is affected by any database directory specified using the
72
 
<a href="../api_java/env_set_data_dir.html">DbEnv.set_data_dir</a> method, or by setting the "set_data_dir" string
73
 
in the environment's <b>DB_CONFIG</b> file.
74
 
</dl>
75
 
<h1>Errors</h1>
76
 
<p>The Db.upgrade method may fail and throw an exception encapsulating a non-zero error for the following conditions:
77
 
<p><dl compact>
78
 
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
79
 
<p>The database is not in the same byte-order as the system.
80
 
</dl>
81
 
<p><dl compact>
82
 
<p><dt><a name="Db.DB_OLD_VERSION">Db.DB_OLD_VERSION</a><dd>The database cannot be upgraded by this version of the Berkeley DB software.
83
 
</dl>
84
 
<p>The Db.upgrade method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
85
 
If a catastrophic error has occurred, the Db.upgrade method may fail and
86
 
throw a <a href="../api_java/runrec_class.html">DbRunRecoveryException</a>,
87
 
in which case all subsequent Berkeley DB calls will fail in the same way.
88
 
<h1>Class</h1>
89
 
<a href="../api_java/db_class.html">Db</a>
90
 
<h1>See Also</h1>
91
 
<a href="../api_java/db_list.html">Databases and Related Methods</a>
92
 
</tt>
93
 
<table width="100%"><tr><td><br></td><td align=right>
94
 
<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a>
95
 
</td></tr></table>
96
 
<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font>
97
 
</body>
98
 
</html>