<!--$Id: db_verify.so,v 10.11 2001/10/22 15:24:26 bostic Exp $-->
<!--Copyright 1997-2001 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 width="100%"><tr valign=top>
<td>
<h1>Db.verify</h1>
</td>
<td align=right>
<a href="../../db4-devel-4.0.14/api_java/c_index.html"><img src="../../db4-4.0.14/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.0.14/images/ref.gif" alt="Ref"></a>
</td></tr></table>
<hr size=1 noshade>
<tt>
<h3><pre>
import com.sleepycat.db.*;
<p>
public void verify(String file,
String database, java.io.OutputStream outfile, int flags)
throws DbException;
</pre></h3>
<h1>Description</h1>
<p>The Db.verify method verifies the integrity of all databases in the
file specified by the <b>file</b> argument, and optionally outputs the
databases' key/data pairs to the file stream specified by the
<b>outfile</b> argument.
<p>The <b>flags</b> value must be set to 0 or
the following value:
<p><dl compact>
<p><dt><a name="Db.DB_SALVAGE">Db.DB_SALVAGE</a><dd>Write the key/data pairs from all databases in the file to the file stream
named in
the <b>outfile</b> argument. The output format is the same as that
specified for the <a href="../../db4-4.0.14/utility/db_dump.html">db_dump</a> utility, and can be used as input for
the <a href="../../db4-4.0.14/utility/db_load.html">db_load</a> utility.
<p>Because the key/data pairs are output in page order as opposed to the sort
order used by <a href="../../db4-4.0.14/utility/db_dump.html">db_dump</a>, using Db.verify to dump key/data
pairs normally produces less than optimal loads for Btree databases.
</dl>
<p>In addition, the following flags may be set by bitwise inclusively <b>OR</b>'ing them into the
<b>flags</b> parameter:
<p><dl compact>
<p><dt><a name="Db.DB_AGGRESSIVE">Db.DB_AGGRESSIVE</a><dd>Output <b>all</b> the key/data pairs in the file that can be found.
By default, Db.verify does not assume corruption. For example,
if a key/data pair on a page is marked as deleted, it is not then written
to the output file. When Db.DB_AGGRESSIVE is specified, corruption
is assumed, and any key/data pair that can be found is written. In this
case, key/data pairs that are corrupted or have been deleted may appear
in the output (even if the file being salvaged is in no way corrupt), and
the output will almost certainly require editing before being loaded into
a database.
<p><dt><a name="Db.DB_NOORDERCHK">Db.DB_NOORDERCHK</a><dd>Skip the database checks for btree and duplicate sort order and for
hashing.
<p>The Db.verify method normally verifies that btree keys and duplicate
items are correctly sorted, and hash keys are correctly hashed. If the
file being verified contains multiple databases using differing sorting
or hashing algorithms, some of them must necessarily fail database
verification because only one sort order or hash function can be
specified before Db.verify is called. To verify files with
multiple databases having differing sorting orders or hashing functions,
first perform verification of the file as a whole by using the
Db.DB_NOORDERCHK flag, and then individually verify the sort order
and hashing function for each database in the file using the
Db.DB_ORDERCHKONLY flag.
<p><dt><a name="Db.DB_ORDERCHKONLY">Db.DB_ORDERCHKONLY</a><dd>Perform the database checks for btree and duplicate sort order and for
hashing, skipped by Db.DB_NOORDERCHK.
<p>When this flag is specified, a <b>database</b> argument should also be
specified, indicating the database in the physical file which is to be
checked. This flag is only safe to use on databases that have already
successfully been verified using Db.verify with the
Db.DB_NOORDERCHK flag set.
</dl>
<p><b>The Db.verify method does not perform any locking, even in
Berkeley DB environments that are configured with a locking subsystem. As such, it
should only be used on files that are not being modified by another thread of
control.</b>
<p>The database argument must be set to null except when the
Db.DB_ORDERCHKONLY flag is set.
<a name="3"><!--meow--></a>
<p>The Db.verify method throws an exception that encapsulates a non-zero error value on
failure, and <a href="../../db4-devel-4.0.14/ref/program/errorret.html#DB_VERIFY_BAD">Db.DB_VERIFY_BAD</a> if a database is corrupted. When the
Db.DB_SALVAGE flag is specified, the <a href="../../db4-devel-4.0.14/ref/program/errorret.html#DB_VERIFY_BAD">Db.DB_VERIFY_BAD</a> return
means that all key/data pairs in the file may not have been successfully
output.
<h1>Environment Variables</h1>
<p><dl compact>
<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../../db4-devel-4.0.14/api_c/db_create.html">db_create</a> was initialized using
<a href="../../db4-devel-4.0.14/api_java/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.verify
is affected by the configuration value DB_DATA_DIR.
</dl>
<h1>Errors</h1>
<p>The Db.verify method may fail and throw an exception encapsulating a non-zero error for the following conditions:
<p><dl compact>
<p><dt>EINVAL<dd>An invalid flag value or parameter was specified.
</dl>
<p>The Db.verify method may fail and throw an exception for errors specified for other Berkeley DB and C library or system methods.
If a catastrophic error has occurred, the Db.verify method may fail and throw
a <a href="../../db4-devel-4.0.14/api_java/runrec_class.html">DbRunRecoveryException</a>, in which case all subsequent Berkeley DB calls
will fail in the same way.
<h1>Class</h1>
<a href="../../db4-devel-4.0.14/api_java/db_class.html">Db</a>
<h1>See Also</h1>
<a href="../../db4-devel-4.0.14/api_java/db_associate.html">Db.associate</a>,
<a href="../../db4-devel-4.0.14/api_java/db_close.html">Db.close</a>,
<a href="../../db4-devel-4.0.14/api_java/db_cursor.html">Db.cursor</a>,
<a href="../../db4-devel-4.0.14/api_java/db_del.html">Db.del</a>,
<a href="../../db4-devel-4.0.14/api_java/db_fd.html">Db.fd</a>,
<a href="../../db4-devel-4.0.14/api_java/db_get.html">Db.get</a>,
<a href="../../db4-devel-4.0.14/api_java/db_get.html">Db.pget</a>,
<a href="../../db4-devel-4.0.14/api_java/db_get_byteswapped.html">Db.get_byteswapped</a>,
<a href="../../db4-devel-4.0.14/api_java/db_get_type.html">Db.get_type</a>,
<a href="../../db4-devel-4.0.14/api_java/db_join.html">Db.join</a>,
<a href="../../db4-devel-4.0.14/api_java/db_key_range.html">Db.key_range</a>,
<a href="../../db4-devel-4.0.14/api_java/db_open.html">Db.open</a>,
<a href="../../db4-devel-4.0.14/api_java/db_put.html">Db.put</a>,
<a href="../../db4-devel-4.0.14/api_java/db_remove.html">Db.remove</a>,
<a href="../../db4-devel-4.0.14/api_java/db_rename.html">Db.rename</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_append_recno.html">Db.set_append_recno</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_cachesize.html">Db.set_cachesize</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_errcall.html">Db.set_errcall</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_errpfx.html">Db.set_errpfx</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_feedback.html">Db.set_feedback</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_flags.html">Db.set_flags</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_h_nelem.html">Db.set_h_nelem</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_lorder.html">Db.set_lorder</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_pagesize.html">Db.set_pagesize</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_re_delim.html">Db.set_re_delim</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_re_len.html">Db.set_re_len</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_re_pad.html">Db.set_re_pad</a>,
<a href="../../db4-devel-4.0.14/api_java/db_set_re_source.html">Db.set_re_source</a>,
<a href="../../db4-devel-4.0.14/api_java/db_stat.html">Db.stat</a>,
<a href="../../db4-devel-4.0.14/api_java/db_sync.html">Db.sync</a>,
<a href="../../db4-devel-4.0.14/api_java/db_truncate.html">Db.truncate</a>,
<a href="../../db4-devel-4.0.14/api_java/db_upgrade.html">Db.upgrade</a>,
and
<a href="../../db4-devel-4.0.14/api_java/db_verify.html">Db.verify</a>.
</tt>
<table width="100%"><tr><td><br></td><td align=right>
<a href="../../db4-devel-4.0.14/api_java/c_index.html"><img src="../../db4-4.0.14/images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../../db4-4.0.14/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>
