.I)Berkeley DB: DbLog.archive[P

DbLog.archive





import com.sleepycat.db.*;

"public String[] archive(int flags) throws DbException;





Description



The DbLog.archive method/returns an array of log or database file names.

CBy 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.

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

J

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

Db.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.DB_ARCH_LOG
Return all the log file names regardless of whether or not they are inuse.


9The Db.DB_ARCH_DATA and Db.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.xSee the db_archive utility source code for an example of using DbLog.archivein a POSIX 1003.1 environment.

The DbLog.archiveHmethod throws an exception that encapsulates an errno on failure.

Bugs

FIn a threaded application (i.e., one where the environment was createdDwith 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 throw a}DbRunRecoveryException, at which point all subsequent database%calls will also fail in the same way.

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 exceptionencapsulating errnofor the following conditions:

B

EINVAL
An invalid flag value or parameter was specified.

The log was corrupted.





Class

3DbLog



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.
ÿÿ