diff options
Diffstat (limited to 'db/docs/utility')
| -rw-r--r-- | db/docs/utility/berkeley_db_svc.html | 88 | ||||
| -rw-r--r-- | db/docs/utility/db_archive.html | 85 | ||||
| -rw-r--r-- | db/docs/utility/db_checkpoint.html | 82 | ||||
| -rw-r--r-- | db/docs/utility/db_deadlock.html | 85 | ||||
| -rw-r--r-- | db/docs/utility/db_dump.html | 128 | ||||
| -rw-r--r-- | db/docs/utility/db_load.html | 151 | ||||
| -rw-r--r-- | db/docs/utility/db_printlog.html | 69 | ||||
| -rw-r--r-- | db/docs/utility/db_recover.html | 97 | ||||
| -rw-r--r-- | db/docs/utility/db_stat.html | 104 | ||||
| -rw-r--r-- | db/docs/utility/db_upgrade.html | 93 | ||||
| -rw-r--r-- | db/docs/utility/db_verify.html | 73 | ||||
| -rw-r--r-- | db/docs/utility/index.html | 28 |
12 files changed, 1083 insertions, 0 deletions
diff --git a/db/docs/utility/berkeley_db_svc.html b/db/docs/utility/berkeley_db_svc.html new file mode 100644 index 000000000..9e9c7bb4e --- /dev/null +++ b/db/docs/utility/berkeley_db_svc.html @@ -0,0 +1,88 @@ +<!--$Id: berkeley_db_svc.so,v 10.11 2000/04/15 16:57:38 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: berkeley_db_svc</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>berkeley_db_svc</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>berkeley_db_svc [<b>-Vv</b>] [<b>-h home</b>] + [<b>-I seconds</b>] [<b>-L file</b>] [<b>-t seconds</b>] [<b>-T seconds</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The berkeley_db_svc utility is the Berkeley DB RPC server. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-h</b><dd>Add the specified home directory to the list of allowed home directories +that can be specified by the client. The home directory should be an +absolute pathname. The last component of each home directory specified +must be unique, as that is how clients specify which database environment +they wish to join. +<p>Recovery will be run on each specified environment before the server +begins accepting requests from clients. For this reason, only one copy +of the server program should ever be run at any time, as recovery must +always be single-threaded. +<p><dt><b>-I</b><dd>Set the default idle timeout for client environments to the specified +number of seconds. The default timeout is 24 hours. +<p><dt><b>-L</b><dd>Log the execution of the berkeley_db_svc utility to the specified file in the +following format, where <i>###</i> is the process ID, and the date +is the time the utility was started. +<p><blockquote><pre>berkeley_db_svc: ### Wed Jun 15 01:23:45 EDT 1995</pre></blockquote> +This file will be removed if the berkeley_db_svc utility exits gracefully. +<p><dt><b>-t</b><dd>Set the default timeout for client resources (idle transactions and +cursors) to the +specified number of seconds. When the timeout expires, if the +resource is a transaction, it is aborted, if the resource is +a cursor, it is closed. +The default timeout is 5 minutes. +<p><dt><b>-T</b><dd>Set the maximum timeout allowed for client resources. +The default timeout is 20 minutes. +If a client application requests a server timeout +greater than the maximum timeout set for this server, then the client's +timeout will be capped at the maximum timeout value. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +<p><dt><b>-v</b><dd>Run in verbose mode. +</dl> +<p>The berkeley_db_svc utility uses a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, berkeley_db_svc should always be given the chance to detach from +the environment and exit gracefully. To cause berkeley_db_svc to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The berkeley_db_svc utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +berkeley_db_svc, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_archive.html b/db/docs/utility/db_archive.html new file mode 100644 index 000000000..5cc56a428 --- /dev/null +++ b/db/docs/utility/db_archive.html @@ -0,0 +1,85 @@ +<!--$Id: db_archive.so,v 10.19 2000/04/03 20:10:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_archive</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_archive</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_archive [<b>-alsVv</b>] [<b>-h home</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_archive utility writes the pathnames of log files that are +no longer in use (e.g., no longer involved in active transactions), to +the standard output, one pathname per line. These log files should be +written to backup media to provide for recovery in the case of +catastrophic failure (which also requires a snapshot of the database +files), but they may then be deleted from the system to reclaim disk +space. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-a</b><dd>Write all pathnames as absolute pathnames, +instead of relative to the database home directories. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-l</b><dd>Write out the pathnames of all of the database log files, +whether or not they are involved in active transactions. +<p><dt><b>-s</b><dd>Write the pathnames of all of the database files that need to be archived +in order to recover the database from catastrophic failure. +If any of the database files have not been accessed during the lifetime of +the current log files, db_archive will +not include them in this +output. +<p>It is possible that some of the files referenced in the log have since +been deleted from the system. +In this case, db_archive will ignore them. +When <a href="../utility/db_recover.html">db_recover</a> is run, any files referenced in the log that +are not present during recovery are assumed to have been deleted and will +not be recovered. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +<p><dt><b>-v</b><dd>Run in verbose mode, listing the checkpoints in the log files as they +are reviewed. +</dl> +<p>The db_archive utility uses a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_archive should always be given the chance to detach from +the environment and exit gracefully. To cause db_archive to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_archive utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +db_archive, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_checkpoint.html b/db/docs/utility/db_checkpoint.html new file mode 100644 index 000000000..dc49d03d8 --- /dev/null +++ b/db/docs/utility/db_checkpoint.html @@ -0,0 +1,82 @@ +<!--$Id: db_checkpoint.so,v 10.22 2000/04/03 20:10:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_checkpoint</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_checkpoint</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_checkpoint [<b>-1Vv</b>] + [<b>-h home</b>] [<b>-k kbytes</b>] [<b>-L file</b>] [<b>-p min</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_checkpoint utility is a daemon process that monitors the +database log and periodically calls <a href="../api_c/txn_checkpoint.html">txn_checkpoint</a> to checkpoint it. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-1</b><dd>Checkpoint the log once, regardless of whether or not there has +been activity since the last checkpoint, and then exit. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-k</b><dd>Checkpoint the database at least as often as every <b>kbytes</b> of log +file are written. +<p><dt><b>-L</b><dd>Log the execution of the db_checkpoint utility to the specified file in the +following format, where <i>###</i> is the process ID, and the date +is the time the utility was started. +<p><blockquote><pre>db_checkpoint: ### Wed Jun 15 01:23:45 EDT 1995</pre></blockquote> +This file will be removed if the db_checkpoint utility exits gracefully. +<p><dt><b>-p</b><dd>Checkpoint the database at least every <b>min</b> minutes if +there has been any activity since the last checkpoint. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +<p><dt><b>-v</b><dd>Write the time of each checkpoint attempt to the standard +output. +</dl> +<p>At least one of the <b>-1</b>, <b>-k</b> and <b>-p</b> options must +be specified. +<p>The db_checkpoint utility uses a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_checkpoint should always be given the chance to detach from +the environment and exit gracefully. To cause db_checkpoint to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_checkpoint utility does not attempt to create the Berkeley DB +shared memory regions if they do not already exist. The application +which creates the region should be started first, and then, once the +region is created, the db_checkpoint utility should be started. +<p>The db_checkpoint utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +db_checkpoint, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_deadlock.html b/db/docs/utility/db_deadlock.html new file mode 100644 index 000000000..dfd23a903 --- /dev/null +++ b/db/docs/utility/db_deadlock.html @@ -0,0 +1,85 @@ +<!--$Id: db_deadlock.so,v 10.22 2000/11/29 16:52:38 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_deadlock</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_deadlock</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_deadlock [<b>-Vvw</b>] + [<b>-a o | y</b>] [<b>-h home</b>] [<b>-L file</b>] [<b>-t sec</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_deadlock utility traverses the database lock structures +and aborts a lock request each time it detects a deadlock. By default, +a random lock request is chosen to be aborted. This utility should be +run as a background daemon, or the underlying Berkeley DB deadlock detection +interfaces should be called in some other way, whenever there are +multiple threads or processes accessing a database and at least one of +them is modifying it. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-a</b><dd>When a deadlock is detected, abort the oldest (o) lock request or the +youngest (y) lock request. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-L</b><dd>Log the execution of the db_deadlock utility to the specified file in the +following format, where <i>###</i> is the process ID, and the date +is the time the utility was started. +<p><blockquote><pre>db_deadlock: ### Wed Jun 15 01:23:45 EDT 1995</pre></blockquote> +This file will be removed if the db_deadlock utility exits gracefully. +<p><dt><b>-t</b><dd>Initiate a pass over the database locks at least every <b>sec</b> +seconds. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +<p><dt><b>-v</b><dd>Run in verbose mode, generating messages each time the detector runs. +<p><dt><b>-w</b><dd>Make a single pass over the database locks every time a process is +forced to wait for a lock. +</dl> +<p>At least one of the <b>-t</b> and <b>-w</b> options must be specified. +<p>The db_deadlock utility uses a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_deadlock should always be given the chance to detach from +the environment and exit gracefully. To cause db_deadlock to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_deadlock utility does not attempt to create the Berkeley DB +shared memory regions if they do not already exist. The application +which creates the region should be started first, and then, once the +region is created, the db_deadlock utility should be started. +<p>The db_deadlock utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +db_deadlock, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_dump.html b/db/docs/utility/db_dump.html new file mode 100644 index 000000000..bd97b307c --- /dev/null +++ b/db/docs/utility/db_dump.html @@ -0,0 +1,128 @@ +<!--$Id: db_dump.so,v 10.26 2000/09/04 16:00:50 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_dump</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_dump</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_dump [<b>-klNpRrV</b>] [<b>-d ahr</b>] + [<b>-f output</b>] [<b>-h home</b>] [<b>-s database</b>] file +db_dump185 [<b>-p</b>] [<b>-f output</b>] file</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_dump utility reads the database file <b>file</b> and +writes it to the standard output using a portable flat-text format +understood by the <a href="../utility/db_load.html">db_load</a> utility. The argument <b>file</b> +must be a file produced using the Berkeley DB library functions. +<p>The <a href="../utility/db_dump.html">db_dump185</a> utility is similar to the db_dump utility +except that it reads databases in the format used by Berkeley DB versions 1.85 +and 1.86. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-d</b><dd>Dump the specified database in a format helpful for debugging the Berkeley DB +library routines. +<p><dl compact> +<p><dt>a<dd>Display all information. +<dt>h<dd>Display only page headers. +<dt>r<dd>Do not display the free-list or pages on the free list. This +mode is used by the recovery tests. +</dl> +<p><b>The output format of the <b>-d</b> option is not standard and may change, +without notice, between releases of the Berkeley DB library.</b> +<p><dt><b>-f</b><dd>Write to the specified <b>file</b> instead of to the standard output. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-k</b><dd>Dump record numbers from Queue and Recno databases as keys. +<p><dt><b>-l</b><dd>List the databases stored in the file. +<p><dt><b>-N</b><dd>Do not acquire shared region locks while running. Other problems such as +potentially fatal errors in Berkeley DB will be ignored as well. This option +is intended only for debugging errors and should not be used under any +other circumstances. +<p><dt><b>-p</b><dd>If characters in either the key or data items are printing characters (as +defined by <b>isprint</b>(3)), use printing characters in <b>file</b> +to represent them. This option permits users to use standard text editors +and tools to modify the contents of databases. +<p>Note, different systems may have different notions as to what characters +are considered <i>printing characters</i>, and databases dumped in +this manner may be less portable to external systems. +<p><dt><b>-R</b><dd>Aggressively salvage data from a possibly corrupt file. The <b>-R</b> +flag differs from the <b>-r</b> option in that it will return all +possible data from the file at the risk of also returning already deleted +or otherwise nonsensical items. Data dumped in this fashion will almost +certainly have to be edited by hand or other means before the data is +ready for re-load into another database +<p><dt><b>-r</b><dd>Salvage data from a possibly corrupt file. When used on a uncorrupted +database, this option should return equivalent data to a normal dump, but +most likely in a different order. +<p><dt><b>-s</b><dd>Specify a single database to dump. If no database is specified, all +databases in the database file are dumped. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +</dl> +<p>Dumping and reloading Hash databases that use user-defined hash functions +will result in new databases that use the default hash function. +While using the default hash function may not be optimal for the new database, +it will continue to work correctly. +<p>Dumping and reloading Btree databases that use user-defined prefix or +comparison functions will result in new databases that use the default +prefix and comparison functions. +<b>In this case, it is quite likely that the database will be damaged +beyond repair permitting neither record storage or retrieval.</b> +<p>The only available workaround for either case is to modify the sources +for the <a href="../utility/db_load.html">db_load</a> utility to load the database using the correct +hash, prefix and comparison functions. +<p>The <a href="../utility/db_dump.html">db_dump185</a> utility may not be available on your system as it +is not always built when the Berkeley DB libraries and utilities are installed. +If you are unable to find it, see your system administrator for further +information. +<p>The db_dump and <a href="../utility/db_dump.html">db_dump185</a> utility output formats are +documented in the <a href="../ref/dumpload/format.html">Dump Output +Formats</a> section of the Reference Guide. +<p>The db_dump utility may be used with a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_dump should always be given the chance to detach from +the environment and exit gracefully. To cause db_dump to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>When using an Berkeley DB database environment, the db_dump utility +does not configure for any kind of database locking and so should not +be used with active Berkeley DB environments. If db_dump is used in +an active database environment, corruption may result. +<p>The db_dump utility exits 0 on success, and >0 if an error occurs. +<p>The <a href="../utility/db_dump.html">db_dump185</a> utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +db_dump, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_load.html b/db/docs/utility/db_load.html new file mode 100644 index 000000000..41084f09c --- /dev/null +++ b/db/docs/utility/db_load.html @@ -0,0 +1,151 @@ +<!--$Id: db_load.so,v 10.29 2000/12/04 18:05:45 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_load</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_load</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_load [<b>-nTV</b>] [<b>-c name=value</b>] [<b>-f file</b>] + [<b>-h home</b>] [<b>-t btree | hash | queue | recno</b>] file</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_load utility reads from the standard input and loads it +into the database <b>file</b>. The database <b>file</b> is created if +it does not already exist. +<p>The input to db_load must be in the output format specified by the +<a href="../utility/db_dump.html">db_dump</a> utility, utilities, or as specified for the <b>-T</b> +below. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-c</b><dd>Specify configuration options ignoring any value they may have based on +the input. The command-line format is <b>name=value</b>. See +<a href="db_load.html#Supported Keywords">Supported Keywords</a> for a +list of supported words for the <b>-c</b> option. +<p><dt><b>-f</b><dd>Read from the specified <b>input</b> file instead of from the standard +input. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment. +<p>If a home directory is specified, the database environment is opened using +the <a href="../api_c/env_open.html#DB_INIT_LOCK">DB_INIT_LOCK</a>, <a href="../api_c/env_open.html#DB_INIT_LOG">DB_INIT_LOG</a>, <a href="../api_c/env_open.html#DB_INIT_MPOOL">DB_INIT_MPOOL</a>, +<a href="../api_c/env_open.html#DB_INIT_TXN">DB_INIT_TXN</a> and <a href="../api_c/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a> flags to +<a href="../api_c/env_open.html">DBENV->open</a>. (This means that db_load can be used to load +data into databases while they are in use by other processes.) If the +<a href="../api_c/env_open.html">DBENV->open</a> call fails, or if no home directory is specified, the +database is still updated, but the environment is ignored, e.g., no +locking is done. +<p><dt><b>-n</b><dd>Do not overwrite existing keys in the database when loading into an +already existing database. If a key/data pair cannot be loaded into the +database for this reason, a warning message is displayed on the standard +error output and the key/data pair are skipped. +<p><dt><b>-T</b><dd>The <b>-T</b> option allows non-Berkeley DB applications to easily load text +files into databases. +<p>If the database to be created is of type Btree or Hash, or the keyword +<b>keys</b> is specified as set, the input must be paired lines of text, +where the first line of the pair is the key item, and the second line of +the pair is its corresponding data item. If the database to be created +is of type Queue or Recno and the keywork <b>keys</b> is not set, the +input must be lines of text, where each line is a new data item for the +database. +<p>A simple escape mechanism, where newline and backslash (\) +characters are special, is applied to the text input. Newline characters +are interpreted as record separators. Backslash characters in the text +will be interpreted in one of two ways: if the backslash character +precedes another backslash character, the pair will be interpreted as a +literal backslash. If the backslash character precedes any other +character, the two characters following the backslash will be interpreted +as hexadecimal specification of a single character, e.g., \0a +is a newline character in the ASCII character set. +<p>For this reason, any backslash or newline characters that naturally +occur in the text input must be escaped to avoid misinterpretation by +db_load. +<p>If the <b>-T</b> option is specified, the underlying access method type +must be specified using the <b>-t</b> option. +<p><dt><b>-t</b><dd>Specify the underlying access method. If no <b>-t</b> option is +specified, the database will be loaded into a database of the same type +as was dumped, e.g., a Hash database will be created if a Hash database +was dumped. +<p>Btree and Hash databases may be converted from one to the other. Queue +and Recno databases may be converted from one to the other. If the +<b>-k</b> option was specified on the call to <a href="../utility/db_dump.html">db_dump</a> then Queue +and Recno databases may be converted to Btree or Hash, with the key being +the integer record number. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +</dl> +<p>The db_load utility may be used with a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_load should always be given the chance to detach from +the environment and exit gracefully. To cause db_load to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_load utility exits 0 on success, 1 if one or more key/data +pairs were not loaded into the database because the key already existed, +and >1 if an error occurs. +<h3>Examples</h3> +<p>The db_load utility can be used to load text files into databases. +For example, the following command loads the standard UNIX +<i>/etc/passwd</i> file into a database, with the login name as the +key item and the entire password entry as the data item: +<p><blockquote><pre>awk -F: '{print $1; print $0}' < /etc/passwd | + sed 's/\\/\\\\/g' | db_load -T -t hash passwd.db</pre></blockquote> +<p>Note that backslash characters naturally occurring in the text are escaped +to avoid interpretation as escape characters by db_load. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h3>Supported Keywords</h3> +The following keywords are supported for the <b>-c</b> command-line +option to the db_load utility. See <a href="../api_c/db_open.html">DB->open</a> for further +discussion of these keywords and what values should be specified. +<p>The parenthetical listing specifies how the value part of the +<b>name=value</b> pair is interpreted. Items listed as (boolean) expect +value to be <b>1</b> (set) or <b>0</b> (unset). Items listed as +(number) convert value to a number. Items listed as (string) use the +string value without modification. +<p><dl compact> +<dt>bt_minkey (number)<dd>The minimum number of keys per page. +<dt>database (string)<dd>The database to load. +<dt>db_lorder (number)<dd>The byte order for integers in the stored database metadata. +<dt>db_pagesize (number)<dd>The size of pages used for nodes in the tree, in bytes. +<dt>duplicates (boolean)<dd>The value of the <a href="../api_c/db_set_flags.html#DB_DUP">DB_DUP</a> flag. +<dt>dupsort (boolean)<dd>The value of the <a href="../api_c/db_set_flags.html#DB_DUPSORT">DB_DUPSORT</a> flag. +<dt>h_ffactor (number)<dd>The density within the Hash database. +<dt>h_nelem (number)<dd>The size of the Hash database. +<dt>keys (boolean)<dd>Specify if keys are present for Queue or Recno databases. +<dt>re_len (number)<dd>Specify fixed-length records of the specified length. +<dt>re_pad (string)<dd>Specify the fixed-length record pad character. +<dt>recnum (boolean)<dd>The value of the <a href="../api_c/db_set_flags.html#DB_RECNUM">DB_RECNUM</a> flag. +<dt>renumber (boolean)<dd>The value of the <a href="../api_c/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +db_load, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_printlog.html b/db/docs/utility/db_printlog.html new file mode 100644 index 000000000..10033e094 --- /dev/null +++ b/db/docs/utility/db_printlog.html @@ -0,0 +1,69 @@ +<!--$Id: db_printlog.so,v 10.10 2000/04/03 20:10:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_printlog</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_printlog</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_printlog [<b>-NV</b>] [<b>-h home</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_printlog utility is a debugging utility that dumps Berkeley DB +log files in a human-readable format. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-N</b><dd>Do not acquire shared region locks while running. Other problems such as +potentially fatal errors in Berkeley DB will be ignored as well. This option +is intended only for debugging errors and should not be used under any +other circumstances. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +</dl> +<p>For more information on the db_printlog output and using it to +debug applications, see <a href="../ref/debug/printlog.html">Reviewing +Berkeley DB log files</a>. +<p>The db_printlog utility uses a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_printlog should always be given the chance to detach from +the environment and exit gracefully. To cause db_printlog to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_printlog utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_recover.html b/db/docs/utility/db_recover.html new file mode 100644 index 000000000..80341597c --- /dev/null +++ b/db/docs/utility/db_recover.html @@ -0,0 +1,97 @@ +<!--$Id: db_recover.so,v 10.22 2000/05/10 17:56:02 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_recover</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_recover</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_recover [<b>-cVv</b>] [<b>-h home</b>] [<b>-t [[CC]YY]MMDDhhmm[.SS]]</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_recover utility must be run after an unexpected application, +Berkeley DB, or system failure to restore the database to a consistent state. +All committed transactions are guaranteed to appear after db_recover +has run, and all uncommitted transactions will be completely undone. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-c</b><dd>Perform catastrophic recovery instead of normal recovery. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-t</b><dd>Recover to the time specified rather than to the most current possible +date. The timestamp argument should be in the form +[[CC]YY]MMDDhhmm[.SS] where each pair of +letters represents the following: +<p><dl compact> +<p><dt>CC<dd>The first two digits of the year (the century). +<dt>YY<dd>The second two digits of the year. If "YY" is specified, but "CC" is not, +a value for "YY" between 69 and 99 results in a "YY" value of 19. Otherwise, +a "YY" value of 20 is used. +<dt>MM<dd>The month of the year, from 1 to 12. +<dt>DD<dd>The day of the month, from 1 to 31. +<dt>hh<dd>The hour of the day, from 0 to 23. +<dt>mm<dd>The minute of the hour, from 0 to 59. +<dt>SS<dd>The second of the minute, from 0 to 61. +</dl> +<p>If the "CC" and "YY" letter pairs are not specified, the values default +to the current year. If the "SS" letter pair is not specified, the value +defaults to 0. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +<p><dt><b>-v</b><dd>Run in verbose mode. +</dl> +<p>In the case of catastrophic recovery, an archival copy, or +<i>snapshot</i> of all database files must be restored along with all +of the log files written since the database file snapshot was made. (If +disk space is a problem, log files may be referenced by symbolic links). +For further information on creating a database snapshot, see +<a href="../ref/transapp/archival.html">Archival Procedures</a>. +For further information on performing recovery, see +<a href="../ref/transapp/recovery.html">Recovery Procedures</a>. +<p>If the failure was not catastrophic, the files present on the system at the +time of failure are sufficient to perform recovery. +<p>If log files are missing, db_recover will identify the missing +log file(s) and fail, in which case the missing log files need to be +restored and recovery performed again. +<p>The db_recover utility uses a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_recover should always be given the chance to detach from +the environment and exit gracefully. To cause db_recover to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_recover utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +db_recover, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_stat.html b/db/docs/utility/db_stat.html new file mode 100644 index 000000000..ba9263e32 --- /dev/null +++ b/db/docs/utility/db_stat.html @@ -0,0 +1,104 @@ +<!--$Id: db_stat.so,v 10.27 2000/04/03 20:10:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_stat</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_stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_stat [<b>-celmNtV</b>] + [<b>-C Acfhlmo</b>] [<b>-d file [<b>-s database</b>]</b>] [<b>-h home</b>] [<b>-M Ahlm</b>]</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> +<p>The db_stat utility displays statistics for Berkeley DB environments. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-C</b><dd>Display internal information about the lock region. (The output from this +option is often both voluminous and meaningless, and is intended only for +debugging.) +<p><dl compact> +<p><dt>A<dd>Display all information. +<dt>c<dd>Display lock conflict matrix. +<dt>f<dd>Display lock and object free lists. +<dt>l<dd>Display lockers within hash chains. +<dt>m<dd>Display region memory information. +<dt>o<dd>Display objects within hash chains. +</dl> +<p><dt><b>-c</b><dd>Display lock region statistics as described in <a href="../api_c/lock_stat.html">lock_stat</a>. +<p><dt><b>-d</b><dd>Display database statistics for the specified file, as described in +<a href="../api_c/db_stat.html">DB->stat</a>. +<p>If the database contains multiple databases and the <b>-s</b> flag is +not specified, the statistics are for the internal database that describes +the other databases the file contains, and not for the file as a whole. +<p><dt><b>-e</b><dd>Display current environment statistics. +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-l</b><dd>Display log region statistics as described in <a href="../api_c/log_stat.html">log_stat</a>. +<p><dt><b>-M</b><dd>Display internal information about the shared memory buffer pool. (The +output from this option is often both voluminous and meaningless, and is +intended only for debugging.) +<p><dl compact> +<p><dt>A<dd>Display all information. +<dt>h<dd>Display buffers within hash chains. +<dt>l<dd>Display buffers within LRU chains. +<dt>m<dd>Display region memory information. +</dl> +<p><dt><b>-m</b><dd>Display shared memory buffer pool statistics as described in +<a href="../api_c/memp_stat.html">memp_stat</a>. +<p><dt><b>-N</b><dd>Do not acquire shared region locks while running. Other problems such as +potentially fatal errors in Berkeley DB will be ignored as well. This option +is intended only for debugging errors and should not be used under any +other circumstances. +<p><dt><b>-s</b><dd>Display statistics for the specified database contained in the file +specified with the <b>-d</b> flag. +<p><dt><b>-t</b><dd>Display transaction region statistics as described in <a href="../api_c/txn_stat.html">txn_stat</a>. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +</dl> +<p>Only one set of statistics is displayed for each run, and the last option +specifying a set of statistics takes precedence. +<p>Values smaller than 10 million are generally displayed without any special +notation. Values larger than 10 million are normally displayed as +<b><number>M</b>. +<p>The db_stat utility may be used with a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_stat should always be given the chance to detach from +the environment and exit gracefully. To cause db_stat to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_stat utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +db_stat, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_upgrade.html b/db/docs/utility/db_upgrade.html new file mode 100644 index 000000000..6375f380e --- /dev/null +++ b/db/docs/utility/db_upgrade.html @@ -0,0 +1,93 @@ +<!--$Id: db_upgrade.so,v 1.4 2000/08/10 17:54:50 bostic 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_c/c_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>db_upgrade [<b>-NsV</b>] [<b>-h home</b>] file ...</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> <a name="4"><!--meow--></a> +<p>The db_upgrade utility upgrades the Berkeley DB version of one or more +files and the databases they contain to the current release version. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-N</b><dd>Do not acquire shared region locks while running. Other problems such as +potentially fatal errors in Berkeley DB will be ignored as well. This option +is intended only for debugging errors and should not be used under any +other circumstances. +<p><dt><b>-s</b><dd>This flag is only meaningful when upgrading databases from releases before the +Berkeley DB 3.1 release. +<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 <b>-s</b> flag means 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>Because the db_upgrade utility 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 <b>-s</b> flag is +correctly specified. Otherwise, the file cannot be upgraded using +db_upgrade, and must be upgraded manually using the <a href="../utility/db_dump.html">db_dump</a> +and <a href="../utility/db_load.html">db_load</a> utilities. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +</dl> +<p><b>It is important to realize that Berkeley DB database upgrades are done +in place, and so are potentially destructive.</b> This means that if the +system crashes during the upgrade procedure, or if the upgrade procedure +runs out of disk space, the databases may be left in an inconsistent and +unrecoverable state. See <a href="../ref/am/upgrade.html">Upgrading +databases</a> for more information. +<p>The db_upgrade utility may be used with a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_upgrade should always be given the chance to detach from +the environment and exit gracefully. To cause db_upgrade to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_upgrade utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +db_upgrade, +and +<a href="../utility/db_verify.html">db_verify</a>. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/db_verify.html b/db/docs/utility/db_verify.html new file mode 100644 index 000000000..610e857a9 --- /dev/null +++ b/db/docs/utility/db_verify.html @@ -0,0 +1,73 @@ +<!--$Id: db_verify.so,v 10.3 2000/07/13 16:41:50 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_verify</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_verify</h1> +</td> +<td width="1%"> +<a href="../api_c/c_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>db_verify [<b>-NqV</b>] [<b>-h home</b>] file ...</pre></h3> +<h1>Description</h1> + <a name="3"><!--meow--></a> <a name="4"><!--meow--></a> +<p>The db_verify utility verifies the structure of one or more +files and the databases they contain. +<p>The options are as follows: +<p><dl compact> +<p><dt><b>-h</b><dd>Specify a home directory for the database environment; by +default, the current working directory is used. +<p><dt><b>-N</b><dd>Do not acquire shared region locks while running. Other problems such as +potentially fatal errors in Berkeley DB will be ignored as well. This option +is intended only for debugging errors and should not be used under any +other circumstances. +<p><dt><b>-q</b><dd>Suppress the printing of any error descriptions, simply exit success or +failure. +<p><dt><b>-V</b><dd>Write the version number to the standard output and exit. +</dl> +<p>If the file being verified contains databases using non-default +comparison or hashing functions, the db_verify utility may +not be used for verification, as it will likely always return failure. +Such files must be verified explicitly, using the <a href="../api_c/db_verify.html">DB->verify</a> function, +after setting the correct comparison or hashing functions. +<p>The db_verify utility may be used with a Berkeley DB environment (as described for the +<b>-h</b> option, the environment variable <b>DB_HOME</b>, or, +because the utility was run in a directory containing a Berkeley DB +environment). In order to avoid environment corruption when using a Berkeley DB +environment, db_verify should always be given the chance to detach from +the environment and exit gracefully. To cause db_verify to release all +environment resources and exit cleanly, send it an interrupt signal +(SIGINT). +<p>The db_verify utility exits 0 on success, and >0 if an error occurs. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>-h</b> option is not specified and the environment variable +DB_HOME is set, it is used as the path of the database home, as described +in <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<h1>See Also</h1> +<a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a>, +<a href="../utility/db_archive.html">db_archive</a>, +<a href="../utility/db_checkpoint.html">db_checkpoint</a>, +<a href="../utility/db_deadlock.html">db_deadlock</a>, +<a href="../utility/db_dump.html">db_dump</a>, +<a href="../utility/db_load.html">db_load</a>, +<a href="../utility/db_recover.html">db_recover</a>, +<a href="../utility/db_stat.html">db_stat</a>, +<a href="../utility/db_upgrade.html">db_upgrade</a>, +and +db_verify. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/utility/index.html b/db/docs/utility/index.html new file mode 100644 index 000000000..3f0c430ab --- /dev/null +++ b/db/docs/utility/index.html @@ -0,0 +1,28 @@ +<!--$Id: index.so,v 10.10 2000/04/03 20:10:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB Supporting Utilities</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> +<h1 align=center>Berkeley DB Supporting Utilities</h1> +<p><table border=1 align=center> +<tr><th>Utility</th><th>Description</th></tr> +<tr><td><a href="../utility/berkeley_db_svc.html">berkeley_db_svc</a></td><td>RPC server utility</td></tr> +<tr><td><a href="../utility/db_archive.html">db_archive</a></td><td>Archival utility</td></tr> +<tr><td><a href="../utility/db_checkpoint.html">db_checkpoint</a></td><td>Transaction checkpoint utility</td></tr> +<tr><td><a href="../utility/db_deadlock.html">db_deadlock</a></td><td>Deadlock detection utility</td></tr> +<tr><td><a href="../utility/db_dump.html">db_dump</a></td><td>Database dump utility</td></tr> +<tr><td><a href="../utility/db_load.html">db_load</a></td><td>Database load utility</td></tr> +<tr><td><a href="../utility/db_printlog.html">db_printlog</a></td><td>Transaction log display utility</td></tr> +<tr><td><a href="../utility/db_recover.html">db_recover</a></td><td>Recovery utility</td></tr> +<tr><td><a href="../utility/db_stat.html">db_stat</a></td><td>Statistics utility</td></tr> +<tr><td><a href="../utility/db_upgrade.html">db_upgrade</a></td><td>Database upgrade utility</td></tr> +<tr><td><a href="../utility/db_verify.html">db_verify</a></td><td>Verification utility</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> |