DbEnv::set_lg_dir API Ref

#include <db_cxx.h>

int DbEnv::set_lg_dir(const char *dir);

int DbEnv::get_lg_dir(const char **dirp);


Description: DbEnv::set_lg_dir

The path of a directory to be used as the location of logging files. Log files created by the Log Manager subsystem will be created in this directory.

If no logging directory is specified, log files are created in the environment home directory. See Berkeley DB File Naming for more information.

For the greatest degree of recoverability from system or application failure, database files and log files should be located on separate physical devices.

The database environment's logging directory may also be configured using the environment's DB_CONFIG file. The syntax of the entry in that file is a single line with the string "set_lg_dir", one or more whitespace characters, and the directory name. Because the DB_CONFIG file is read when the database environment is opened, it will silently overrule configuration done before that time.

The DbEnv::set_lg_dir method configures operations performed using the specified DbEnv handle, not all operations performed on the underlying database environment.

The DbEnv::set_lg_dir method may not be called after the DbEnv::open method is called. If the database environment already exists when DbEnv::open is called, the information specified to DbEnv::set_lg_dir must be consistent with the existing environment or corruption can occur.

The DbEnv::set_lg_dir 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.

Parameters
dir

When using a Unicode build on Windows (the default), the dir argument will be interpreted as a UTF-8 string, which is equivalent to ASCII for Latin characters.



Errors

The DbEnv::set_lg_dir method may fail and throw DbException, encapsulating one of the following non-zero errors, or return one of the following non-zero errors:


EINVAL

Description: DbEnv::get_lg_dir

The DbEnv::get_lg_dir method returns the log directory.

The DbEnv::get_lg_dir method may be called at any time during the life of the application.

The DbEnv::get_lg_dir 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.

Parameters
dirp


Class DbEnv, DbLogc, DbLsn
See Also Logging Subsystem and Related Methods

APIRef

Copyright (c) 1996,2008 Oracle. All rights reserved.