MAN page from CentOS 7 libdb-utils-5.3.21-20.el7.x86_64.rpm

DB_DUMP

Section: BerkeleyDB Utilities (1)
Updated: 06 December 2016
Index

NAME

db_dump - Write database file using flat-text format

SYNOPSIS

db_dump[-klNpRrV] [-d ahr][-f output] [-h home] [-P password] [-s database] file

db_dump[-kNpV] [-d ahr] [-f output] [-h home] -m database

db_dump185[-p] [-f output] file

DESCRIPTION

The db_dump utility reads the database file and writes it to the standardoutput using a portable flat-text format understood by the db_load utility.The file argument must be a file produced using the Berkeley DB libraryfunctions.The db_dump185 utility is similar to the db_dump utility, except that it readsdatabases in the format used by Berkeley DB versions 1.85 and 1.86.

OPTIONS

-d

Dump the specified database in a format helpful for debugging the Berkeley DBlibrary routines.

a: Display all information.
h: Display only page headers.
r: Do not display the free-list or pages on the free list. Thismode is used by the recovery tests.

The output format of the -d option is not standard and may change,without notice, between releases of the Berkeley DB library.

-f output

Write to the specified output file instead of to the standard output.

-h home

Specify a home directory for the database environment; bydefault, the current working directory is used.

-k

Dump record numbers from Queue and Recno databases as keys.

-l

List the databases stored in the file.

-N

Do not acquire shared region mutexes 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 beused under any other circumstances.

-P password

Specify an environment password. Although Berkeley DB utilities overwritepassword strings as soon as possible, be aware there may be a window ofvulnerability on systems where unprivileged users can see command-linearguments or where utilities are not able to overwrite the memorycontaining the command-line arguments.

-p

If characters in either the key or data items are printing characters (asdefined by isprint(3)), use printing characters in fileto represent them. This option permits users to use standard text editorsand tools to modify the contents of databases.

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

-R

Aggressively salvage data from a possibly corrupt file. The -Rflag differs from the -r option in that it will return allpossible data from the file at the risk of also returning already deletedor otherwise nonsensical items. Data dumped in this fashion will almostcertainly have to be edited by hand or other means before the data isready for reload into another database

-r

Salvage data from a possibly corrupt file. When used on a uncorrupteddatabase, this option should return equivalent data to a normal dump, butmost likely in a different order.

-s database

Specify a single database to dump. If no database is specified, alldatabases in the database file are dumped.

-V

Write the library version number to the standard output, and exit.

Dumping and reloading Hash databases that use user-defined hashfunctions will result in new databases that use the default hashfunction. Although using the default hash function may not be optimalfor the new database, it will continue to work correctly.

Dumping and reloading Btree databases that use user-defined prefix orcomparison functions will result in new databases that use the defaultprefix and comparison functions.In this case, it is quite likely that the database will be damagedbeyond repair permitting neither record storage or retrieval.

The only available workaround for either case is to modify the sourcesfor the db_load utility to load the database using the correcthash, prefix, and comparison functions.

The db_dump utility output format is documented in theDump Output Formats section of the Berkeley DB Reference Guide.

The db_dump utility may be used with a Berkeley DB environment (as described for the-h option, the environment variable DB_HOME, orbecause the utility was run in a directory containing a Berkeley DBenvironment). In order to avoid environment corruption when using aBerkeley DB environment, db_dump should always be given the chance todetach from the environment and exit gracefully. To cause db_dumpto release all environment resources and exit cleanly, send it aninterrupt signal (SIGINT).

Even when using a Berkeley DB database environment, the db_dumputility does not use any kind of database locking if it is invoked withthe -d, -R, or -r arguments. If used withone of these arguments, the db_dump utility may only be safelyrun on databases that are not being modified by any other process;otherwise, the output may be corrupt.

EXIT STATUS

The db_dump utility exits 0 on success, and >0 if an error occurs.

ENVIRONMENT

DB_HOME: If the -h option is not specified and the environment variableDB_HOME is set, it is used as the path of the database home, as describedin DB_ENV->open.

This document was created byman2html,using the manual pages.