|
DbEnv::set_tmp_dir
|
|
#include <db_cxx.h>
int
DbEnv::set_tmp_dir(const char *dir);
Description
The path of a directory to be used as the location of temporary files.
The files created to back in-memory access method databases will be
created relative to this path. These temporary files can be quite large,
depending on the size of the database.
If no directories are specified, the following alternatives are checked
in the specified order. The first existing directory path is used for
all temporary files.
- The value of the environment variable TMPDIR.
- The value of the environment variable TEMP.
- The value of the environment variable TMP.
- The value of the environment variable TempFolder.
- The value returned by the GetTempPath interface.
- The directory /var/tmp.
- The directory /usr/tmp.
- The directory /temp.
- The directory /tmp.
- The directory C:/temp.
- The directory C:/tmp.
Note: environment variables are only checked if one of the
DB_USE_ENVIRON or DB_USE_ENVIRON_ROOT flags were
specified.
Note: the GetTempPath interface is only checked on Win/32 platforms.
The DbEnv::set_tmp_dir interface may be used only to configure Berkeley DB before
the DbEnv::open interface is called.
The DbEnv::set_tmp_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 temporary file 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_tmp_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_tmp_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_tmp_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_tmp_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
|