DB_ENV->log_archive(DB_ENV *env, char *(*listp), u_int32_t flags);
The DB_ENV->log_archive method
creates a NULL-terminated array of log or database filenames, and copies
a pointer to them into the user-specified memory location listp.
By default, DB_ENV->log_archive returns the names of all of the log
files that are no longer in use (for example, that are no longer
involved in active transactions), and that may safely be archived for
catastrophic recovery and then removed from the system. If there are
no filenames to return,
the memory location to which listp refers will be set to NULL.
Arrays of log filenames are created in allocated memory. If application-specific allocation
routines have been declared (see DB_ENV->set_alloc for more
information), they are used to allocate the memory; otherwise, the
library malloc(3) interface is used. The caller is
responsible for deallocating the memory. To deallocate the memory, free
the memory reference; references inside the returned memory need not be
The flags value must be set to 0 or by bitwise inclusively OR'ing together one or
more of the following values:
- All pathnames are returned as absolute pathnames, instead of relative
to the database home directory.
- Return the database files that need to be archived in order to recover
the database from catastrophic failure. If any of the database files
have not been accessed during the lifetime of the current log files,
DB_ENV->log_archive will not include them in this list. It is also
possible that some of the files referred to by the log have since been
deleted from the system.
- Return all the log filenames, regardless of whether or not they are in
The DB_ARCH_DATA and DB_ARCH_LOG flags are mutually
Log cursor handles (returned by the DB_ENV->log_cursor method) may have open
file descriptors for log files in the database environment. Also, the
Berkeley DB interfaces to the database environment logging subsystem (for
example, DB_ENV->log_put and DB_TXN->abort) may allocate log cursors
and have open file descriptors for log files as well. On operating
systems where filesystem related system calls (for example, rename and
unlink on Windows/NT) can fail if a process has an open file descriptor
for the affected file, attempting to move or remove the log files listed
by DB_ENV->log_archive may fail. All Berkeley DB internal use of log cursors
operates on active log files only and furthermore, is short-lived in
nature. So, an application seeing such a failure should be restructured
to close any open log cursors it may have, and otherwise to retry the
operation until it succeeds. (Although the latter is not likely to be
necessary; it is hard to imagine a reason to move or rename a log file
in which transactions are being logged or aborted.)
See the db_archive manual page for more information on database
The DB_ENV->log_archive method is the underlying interface used by the db_archive utility.
See the db_archive utility source code for an example of using DB_ENV->log_archive
in a IEEE/ANSI Std 1003.1 (POSIX) environment.
The DB_ENV->log_archive method returns a non-zero error value on failure and 0 on success.
The DB_ENV->log_archive method may fail and return a non-zero error for the following conditions:
- An invalid flag value or parameter was specified.
The log was corrupted.
The DB_ENV->log_archive method may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions.
If a catastrophic error has occurred, the DB_ENV->log_archive method may fail and
in which case all subsequent Berkeley DB calls will fail in the same way.
DB_ENV, DB_LOGC, DB_LSN
Logging Subsystem and Related Methods
Copyright Sleepycat Software