Berkeley DB: log_file
Description: Berkeley DB: An embedded database programmatic toolkit.
Keywords: embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++

# log_file |

`

###

    #include <db.h>

    int
    log_file(DB_ENV *env,
        const DB_LSN *lsn, char *namep, size_t len);

# Description

The log_file function maps DB_LSN structures to file names, copying the name of the file containing the record named by lsn into the memory location referenced by namep.

The len argument is the length of the namep buffer in bytes. If namep is too short to hold the file name, log_file will return ENOMEM. (Log file names are normally quite short, on the order of 10 characters.)

This mapping of DB_LSN structures to files is needed for database administration. For example, a transaction manager typically records the earliest DB_LSN needed for restart, and the database administrator may want to archive log files to tape when they contain only DB_LSN entries before the earliest one needed for restart.

The log_file function returns a non-zero error value on failure and 0 on success.

# Errors

The log_file function may fail and return a non-zero error for the following conditions:

ENOMEM
  The supplied buffer was too small to hold the log file name.

The log_file function 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 log_file function may fail and return DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail in the same way.

# See Also

DBENV->set_lg_bsize, DBENV->set_lg_max, log_archive, log_compare, log_file, log_flush, log_get, log_put, log_register, log_stat and log_unregister.`

Copyright Sleepycat Software