#include <db_cxx.h>

int
Db::verify(const char *file,
    const char *database, ostream *outfile, u_int32_t flags);

Description

The Db::verify method verifies the integrity of all databases in the file specified by the file argument, and optionally outputs the databases' key/data pairs to the file stream specified by the outfile argument.

The flags value must be set to 0 or the following value:

DB_SALVAGE

Write the key/data pairs from all databases in the file to the file stream named in the outfile argument. The output format is the same as that specified for the db_dump utility, and can be used as input for the db_load utility.

Because the key/data pairs are output in page order as opposed to the sort order used by db_dump, using Db::verify to dump key/data pairs normally produces less than optimal loads for Btree databases.

In addition, the following flags may be set by bitwise inclusively OR'ing them into the flags parameter:

DB_AGGRESSIVE

Output all 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_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.

DB_PRINTABLE

When using the DB_SALVAGE flag, if characters in either the key or data items are printing characters (as defined by isprint(3)), use printing characters to represent them. This flag permits users to use standard text editors and tools to modify the contents of databases or selectively remove data from salvager output.

Note: different systems may have different notions about what characters are considered printing characters, and databases dumped in this manner may be less portable to external systems.

DB_NOORDERCHK

Skip the database checks for btree and duplicate sort order and for hashing.

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_NOORDERCHK flag, and then individually verify the sort order and hashing function for each database in the file using the DB_ORDERCHKONLY flag.

DB_ORDERCHKONLY

Perform the database checks for btree and duplicate sort order and for hashing, skipped by DB_NOORDERCHK.

When this flag is specified, a database 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_NOORDERCHK flag set.

The database argument must be set to NULL except when the DB_ORDERCHKONLY flag is set.

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.

The Db::verify interface may not be called after the Db::open interface is called.

The Db::verify method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, 0 on success, and DB_VERIFY_BAD if a database is corrupted. When the DB_SALVAGE flag is specified, the DB_VERIFY_BAD return means that all key/data pairs in the file may not have been successfully output.

Environment Variables

DB_HOME

If a dbenv argument to db_create was specified, the environment variable DB_HOME may be used as the path of the database environment home.

Db::verify is affected by any database directory specified using the DbEnv::set_data_dir method, or by setting the "set_data_dir" string in the environment's DB_CONFIG file.

Errors

The Db::verify method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL

An invalid flag value or parameter was specified.

Db::verify was called after Db::open.

The Db::verify 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::verify method may fail and either return DB_RUNRECOVERY or throw a DbRunRecoveryException, in which case all subsequent Berkeley DB calls will fail in the same way.

Class

See Also