|
DbEnv::set_data_dir
|
|
#include <db_cxx.h>
int
DbEnv::set_data_dir(const char *dir);
Description
Set the path of a directory to be used as the location of the access
method database files. Paths specified to the Db::open function
will be searched relative to this path. Paths set using this interface
are additive, and specifying more than one will result in each specified
directory being searched for database files. If any directories are
specified, created database files will always be created in the first path
specified.
If no database directories are specified, database files can exist only
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 DbEnv::set_data_dir interface may be used only to configure Berkeley DB before
the DbEnv::open interface is called.
The DbEnv::set_data_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.
The database environment's data directory may also be set using the environment's
DB_CONFIG file. The syntax of the entry in that file is a
single line with the string "set_data_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.
Errors
The DbEnv::set_data_dir 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.
Called after DbEnv::open was called.
The DbEnv::set_data_dir 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.
If a catastrophic error has occurred, the DbEnv::set_data_dir method may fail and either
return DB_RUNRECOVERY or throw an exception encapsulating
DB_RUNRECOVERY, in which case all subsequent Berkeley DB calls will fail
in the same way.
Class
DbEnv
See Also
DbEnv::close,
DbEnv::err, DbEnv::errx
DbEnv::open,
DbEnv::remove,
DbEnv::set_alloc,
DbEnv::set_cachesize,
DbEnv::set_data_dir,
DbEnv::set_errcall,
DbEnv::set_errfile,
DbEnv::set_error_stream,
DbEnv::set_errpfx,
DbEnv::set_feedback,
DbEnv::set_flags,
DbEnv::set_paniccall,
DbEnv::set_recovery_init,
DbEnv::set_rpc_server,
DbEnv::set_shm_key,
DbEnv::set_tas_spins,
DbEnv::set_tmp_dir,
DbEnv::set_timeout,
DbEnv::set_verbose,
DbEnv::strerror
and
DbEnv::version.
Copyright Sleepycat Software
|