DbEnv::log_register

APIRef

#include <db_cxx.h>

int DbEnv::log_register(Db *dbp, const char *name, int32_t *fidp);

Description

The DbEnv::log_register method registers a file name with the log manager and copies a file identification number into the memory location referenced by fidp.

This file identification number should be used in all subsequent log messages that refer to operations on the file. The log manager records all file name to file identification number mappings at each checkpoint so that a recovery process can identify the file to which a record in the log refers.

The dbp parameter should be a reference to a Db object.

The DbEnv::log_register method either returns a non-zero error value or throws an exception that encapsulates a non-zero error value on failure, and returns 0 on success.

Errors

If a fatal error occurs in Berkeley DB, the DbEnv::log_register method will fail and either return DB_RUNRECOVERY or throw an exception encapsulating DB_RUNRECOVERY, at which point all subsequent database calls will fail in the same way.

In addition, the DbEnv::log_register method may fail and throw an exception or return a non-zero error for the following conditions:

EINVAL
An invalid flag value or parameter was specified.

In addition, the DbEnv::log_register method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods.

Class

DbEnv

See Also

DbEnv::set_lg_bsize, DbEnv::set_lg_max, DbEnv::log_archive, DbEnv::log_compare, DbEnv::log_file, DbEnv::log_flush, DbEnv::log_get, DbEnv::log_put, DbEnv::log_register, DbEnv::log_stat and DbEnv::log_unregister.

APIRef

Copyright Sleepycat Software