diff options
Diffstat (limited to 'bdb/docs/api_cxx/db_upgrade.html')
| -rw-r--r-- | bdb/docs/api_cxx/db_upgrade.html | 135 |
1 files changed, 0 insertions, 135 deletions
diff --git a/bdb/docs/api_cxx/db_upgrade.html b/bdb/docs/api_cxx/db_upgrade.html deleted file mode 100644 index 8cbc3561fe3..00000000000 --- a/bdb/docs/api_cxx/db_upgrade.html +++ /dev/null @@ -1,135 +0,0 @@ -<!--$Id: db_upgrade.so,v 10.18 2000/05/01 15:58:04 krinsky Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: Db::upgrade</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>Db::upgrade</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> -</td></tr></table> -<hr size=1 noshade> -<tt> -<h3><pre> -#include <db_cxx.h> -<p> -int -Db::upgrade(const char *file, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::upgrade method upgrades all of the databases included in the -file <b>file</b>, if necessary. If no upgrade is necessary, -Db::upgrade always returns success. -<p><b>Database upgrades are done in place and are destructive, e.g., if pages -need to be allocated and no disk space is available, the database may be -left corrupted. Backups should be made before databases are upgraded. -See <a href="../ref/am/upgrade.html">Upgrading databases</a> for more -information.</b> -<p>Unlike all other database operations, Db::upgrade may only be done -on a system with the same byte-order as the database. -<p>The <b>flags</b> parameter must be set to 0 or one of the following -values: -<p><dl compact> -<p><dt><a name="DB_DUPSORT">DB_DUPSORT</a><dd><b>This flag is only meaningful when upgrading databases from -releases before the Berkeley DB 3.1 release.</b> -<p>As part of the upgrade from the Berkeley DB 3.0 release to the 3.1 release, the -on-disk format of duplicate data items changed. To correctly upgrade the -format requires applications specify if duplicate data items in the -database are sorted or not. Specifying the DB_DUPSORT flag -informs Db::upgrade that the duplicates are sorted, otherwise they -are assumed to be unsorted. Incorrectly specifying the value of this flag -may lead to database corruption. -<p>Further, because the Db::upgrade method upgrades a physical file -(including all of the databases it contains), it is not possible to use -Db::upgrade to upgrade files where some of the databases it -includes have sorted duplicate data items and some of the databases it -includes have unsorted duplicate data items. If the file does not have -more than a single database, or the databases do not support duplicate -data items, or all of the databases that support duplicate data items -support the same style of duplicates (either sorted or unsorted), -Db::upgrade will work correctly as long as the DB_DUPSORT -flag is correctly specified. Otherwise, the file cannot be upgraded using -Db::upgrade, and must be upgraded manually by dumping and -re-loading the databases. -</dl> -<p>The Db::upgrade method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Environment Variables</h1> -<p><dl compact> -<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using -<a href="../api_cxx/env_open.html">DbEnv::open</a> the environment variable <b>DB_HOME</b> may be used -as the path of the database environment home. Specifically, Db::upgrade -is affected by the configuration value DB_DATA_DIR. -</dl> -<h1>Errors</h1> -<p>The Db::upgrade method may fail and throw an exception or return a non-zero error for the following conditions: -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -<p>The database is not in the same byte-order as the system. -</dl> -<p><dl compact> -<p><dt><a name="DB_OLD_VERSION">DB_OLD_VERSION</a><dd>The database cannot be upgraded by this version of the Berkeley DB software. -</dl> -<p>The Db::upgrade method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::upgrade method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail -in the same way. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> -</td></tr></table> -<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> |