1DB_UPGRADE(1) BerkeleyDB Utilities DB_UPGRADE(1)
2
6 db_upgrade - Upgrade files and databases to the current release ver‐
7 sion.
8
10 db_upgrade [-NsVv] [-h home] [-P password] file ...
11
13 The db_upgrade utility upgrades the Berkeley DB version of one or more
14 files and the databases they contain to the current release version.
15
17 -h home
18 Specify a home directory for the database environment; by
19 default, the current working directory is used.
20 -N Do not acquire shared region mutexes while running. Other prob‐
22 lems, such as potentially fatal errors in Berkeley DB, will be
23 ignored as well. This option is intended only for debugging
24 errors, and should not be used under any other circumstances.
25 -P password
27 Specify an environment password. Although Berkeley DB utilities
28 overwrite password strings as soon as possible, be aware there
29 may be a window of vulnerability on systems where unprivileged
30 users can see command-line arguments or where utilities are not
31 able to overwrite the memory containing the command-line argu‐
32 ments.
33 -s This flag is only meaningful when upgrading databases from
35 releases before the Berkeley DB 3.1 release.
36 As part of the upgrade from the Berkeley DB 3.0 release to the
38 3.1 release, the on-disk format of duplicate data items changed.
39 To correctly upgrade the format requires that applications spec‐
40 ify whether duplicate data items in the database are sorted or
41 not. Specifying the -s flag means that the duplicates are
42 sorted; otherwise, they are assumed to be unsorted. Incorrectly
43 specifying the value of this flag may lead to database corrup‐
44 tion.
45 Because the db_upgrade utility upgrades a physical file (includ‐
47 ing all the databases it contains), it is not possible to use
48 db_upgrade to upgrade files where some of the databases it
49 includes have sorted duplicate data items, and some of the data‐
50 bases it includes have unsorted duplicate data items. If the
51 file does not have more than a single database, if the databases
52 do not support duplicate data items, or if all the databases
53 that support duplicate data items support the same style of
54 duplicates (either sorted or unsorted), db_upgrade will work
55 correctly as long as the -s flag is correctly specified. Other‐
56 wise, the file cannot be upgraded using db_upgrade, and must be
57 upgraded manually using the db_dump and db_load utilities.
58 -V Write the library version number to the standard output, and
60 exit.
61 -v Run in verbose mode, displaying a message for each successful
63 upgrade.
64 It is important to realize that Berkeley DB database upgrades are done
66 in place, and so are potentially destructive. This means that if the
67 system crashes during the upgrade procedure, or if the upgrade proce‐
68 dure runs out of disk space, the databases may be left in an inconsis‐
69 tent and unrecoverable state.
70 The db_upgrade utility may be used with a Berkeley DB environment (as
72 described for the -h option, the environment variable DB_HOME, or
73 because the utility was run in a directory containing a Berkeley DB
74 environment). In order to avoid environment corruption when using a
75 Berkeley DB environment, db_upgrade should always be given the chance
76 to detach from the environment and exit gracefully. To cause
77 db_upgrade to release all environment resources and exit cleanly, send
78 it an interrupt signal (SIGINT).
79
81 The db_upgrade utility exits 0 on success, and >0 if an error occurs.
82
84 DB_HOME
85 If the -h option is not specified and the environment variable
86 DB_HOME is set, it is used as the path of the database home, as
87 described in DB_ENV->open.
88
90 db_archive(1) db_checkpoint(1) db_deadlock(1) db_dump(1) db_hot‐
91 backup(1) db_log_verify(1) db_load(1) db_printlog(1) db_recover(1)
92 db_replicate(1) db_stat(1) db_tuner(1) db_verify(1)
93BerkeleyDB 5.3.28 06 December 2016 DB_UPGRADE(1)