.I*Berkeley DB: DbLog::archive[P

DbLog::archive





#include <db_cxx.h>

intDbLog::archive(char **list[],1 u_int32_t flags, void *(*db_malloc)(size_t));





Description



The DbLog::archive methodHcreates a NULL-terminated array of log or database file names and copiesFa pointer to them into the user-specified memory location list.

DBy default, DbLog::archive returns the names of all of the log filesLthat are no longer in use (e.g., no longer involved in active transactions),Jand that may safely be archived for catastrophic recovery and then removedfrom the system.GIf there were no file names to return, list will be set to NULL.

9Arrays of log file names are created in allocated memory.IfBdb_malloc is non-NULL, it is called to allocate the memory,:otherwise, the library function malloc(3)) is used.CThe function db_malloc must match the calling conventions of&the malloc(3)) library routine.CRegardless, the caller is responsible for deallocating the returnedmemory.ETo deallocate the returned memory, free each returned memory pointer;@pointers inside the memory do not need to be individually freed.

YThe flags argument is specified by logically OR'ing together one or more ofthe following values:

G

DB_ARCH_ABS
All pathnames are returned as absolute pathnames,3instead of relative to the database home directory.]

DB_ARCH_DATA
Return the database files that need to be archived in order to recoverEthe database from catastrophic failure. If any of the database filesDhave not been accessed during the lifetime of the current log files,>DbLog::archive will not include them in this list. It is alsoEpossible that some of the files referenced in the log have since beendeleted from the system.\

DB_ARCH_LOG
Return all the log file names regardless of whether or not they are inuse.


3The DB_ARCH_DATA and DB_ARCH_LOG flags are mutually exclusive.

kSee the db_archive manual page for more information on databasearchival procedures.

~The DbLog::archive method is the underlying method used by the db_archive utility.ySee the db_archive utility source code for an example of using DbLog::archivein a POSIX 1003.1 environment.

The DbLog::archive>method either returns errno or throws an exception that:encapsulates an errno on failure, and 0 on success.

Bugs

FIn a threaded application (i.e., one where the environment was createdEwith the DB_THREAD flag specified), calling DbLog::archive will fail,Jreturning EINVAL. To work around this problem, re-open the log explicitlyIwithout specifying DB_THREAD. This restriction is expected to be removed#in a future version of Berkeley DB.



Errors

UIf a fatal error occurs in Berkeley DB, the DbLog::archive method may fail and eitherIreturn DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY,Gat which point all subsequent database calls will also fail in the sameFway. Methods marked as returning errno will, by default, throwHan exception that encapsulates the error information. The default error\behavior can be changed, see DbException.

The DbLog::archive&method may fail and throw an exceptionKfor any of the errors specified for the following Berkeley DB and C library functions: close(3), fcntl(3), fflush(3), fprintf(3),free(3), getcwd(3), getenv(3), getpid(3), getuid(3), isdigit(3),>DbLog::compare,6DbLog::get, malloc(3), memcpy(3), memset(3),open(3), qsort(3), realloc(3),sigfillset(3),sigprocmask(3), snprintf(3),stat(3), strchr(3), strcmp(3), strerror(3), strlen(3), unlink(3), vfprintf(3),and vsnprintf(3).

In addition, the DbLog::archive&method may fail and throw an exceptionor return errnofor the following conditions:

B

EINVAL
An invalid flag value or parameter was specified.

The log was corrupted.





Class

2DbLog



See Also

DbLog::archive,:DbLog::close,>DbLog::compare,8DbLog::file,:DbLog::flush,6DbLog::get,8DbLog::open,6DbLog::put,FDbLog::db_register,8DbLog::stat,;DbLog::unlinkandJDbLog::db_unregister.
ÿÿ