1
.\" Manual Page for Berkely DB utils, created from upstream
2
.\" documentation by Thijs Kinkhorst <thijs@kinkhorst.com>.
3
.TH DB4.8_ARCHIVE 1 "28 January 2005"
5
db4.8_archive \- Find unused log files for archiving purposes
8
[-adlsVv] [-h home] [-P password]
10
The db4.8_archive utility writes the pathnames of log files that
11
are no longer in use (for example, no longer involved in active
12
transactions), to the standard output, one pathname per line. These
13
log files should be written to backup media to provide for recovery in
14
the case of catastrophic failure (which also requires a snapshot of the
15
database files), but they may then be deleted from the system to reclaim
20
Write all pathnames as absolute pathnames, instead of relative to the
21
database home directories.
23
Remove log files that are no longer needed; no filenames are written.
24
Automatic log file removal is likely to make catastrophic recovery
27
Specify a home directory for the database environment; by
28
default, the current working directory is used.
30
Write out the pathnames of all the database log files, whether or not
31
they are involved in active transactions.
33
Specify an environment password. Although Berkeley DB utilities overwrite
34
password strings as soon as possible, be aware there may be a window of
35
vulnerability on systems where unprivileged users can see command-line
36
arguments or where utilities are not able to overwrite the memory
37
containing the command-line arguments.
39
Write the pathnames of all the database files that need to be archived
40
in order to recover the database from catastrophic failure. If any of
41
the database files have not been accessed during the lifetime of the
42
current log files, db4.8_archive will not include them in this
45
It is possible that some of the files to which the log refers have since
46
been deleted from the system. In this case, db4.8_archive will
47
ignore them. When db4.8_recover is run, any files to which the
48
log refers that are not present during recovery are assumed to have been
49
deleted and will not be recovered.
51
Write the library version number to the standard output, and exit.
53
Run in verbose mode, listing the checkpoints in the log files as they
56
Log cursor handles (returned by the DB_ENV->log_cursor method) may have open
57
file descriptors for log files in the database environment. Also, the
58
Berkeley DB interfaces to the database environment logging subsystem (for
59
example, DB_ENV->log_put and DB_TXN->abort) may allocate log cursors
60
and have open file descriptors for log files as well. On operating
61
systems where filesystem related system calls (for example, rename and
62
unlink on Windows/NT) can fail if a process has an open file descriptor
63
for the affected file, attempting to move or remove the log files listed
64
by db4.8_archive may fail. All Berkeley DB internal use of log cursors
65
operates on active log files only and furthermore, is short-lived in
66
nature. So, an application seeing such a failure should be restructured
67
to close any open log cursors it may have, and otherwise to retry the
68
operation until it succeeds. (Although the latter is not likely to be
69
necessary; it is hard to imagine a reason to move or rename a log file
70
in which transactions are being logged or aborted.)
72
The db4.8_archive utility uses a Berkeley DB environment (as described for the
73
\fB-h\fR option, the environment variable \fBDB_HOME\fR, or
74
because the utility was run in a directory containing a Berkeley DB
75
environment). In order to avoid environment corruption when using a
76
Berkeley DB environment, db4.8_archive should always be given the chance to
77
detach from the environment and exit gracefully. To cause db4.8_archive
78
to release all environment resources and exit cleanly, send it an
79
interrupt signal (SIGINT).
81
The DB_ENV->log_archive method is the underlying method used by the db4.8_archive utility.
82
See the db4.8_archive utility source code for an example of using
83
DB_ENV->log_archive in a IEEE/ANSI Std 1003.1 (POSIX) environment.
85
The db4.8_archive utility exits 0 on success, and >0 if an error occurs.
88
If the \fB-h\fR option is not specified and the environment variable
89
DB_HOME is set, it is used as the path of the database home, as described
92
Sleepycat Software, Inc. This manual page was created based on
93
the HTML documentation for db_archive from Sleepycat,
94
by Thijs Kinkhorst <thijs@kinkhorst.com>,
95
for the Debian system (but may be used by others).
added
removed
debian/manpages/db4.8_archive.1
