Berkeley DB: DB_ENV->set_tmp_dir
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++

# DB_ENV->set_tmp_dir |

`

###

    #include <db.h>

    int
    DB_ENV->set_tmp_dir(DB_ENV *dbenv, 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.

1. The value of the environment variable TMPDIR.
2. The value of the environment variable TEMP.
3. The value of the environment variable TMP.
4. The value of the environment variable TempFolder.
5. The value returned by the GetTempPath interface.
6. The directory /var/tmp.
7. The directory /usr/tmp.
8. The directory /temp.
9. The directory /tmp.
10. The directory C:/temp.
11. 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 DB_ENV->set_tmp_dir interface may be used only to configure Berkeley DB before the DB_ENV->open interface is called.

The DB_ENV->set_tmp_dir function returns a non-zero error value on failure and 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 DB_ENV->set_tmp_dir function may fail and return a non-zero error for the following conditions:

EINVAL
  An invalid flag value or parameter was specified.

  Called after DB_ENV->open was called.

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

# See Also

db_env_create, DB_ENV->close, DB_ENV->err, DB_ENV->errx DB_ENV->open, DB_ENV->remove, DB_ENV->set_alloc, DB_ENV->set_cachesize, DB_ENV->set_data_dir, DB_ENV->set_errcall, DB_ENV->set_errfile, DB_ENV->set_errpfx, DB_ENV->set_feedback, DB_ENV->set_flags, DB_ENV->set_paniccall, DB_ENV->set_recovery_init, DB_ENV->set_rpc_server, DB_ENV->set_shm_key, DB_ENV->set_tas_spins, DB_ENV->set_tmp_dir, DB_ENV->set_timeout, DB_ENV->set_verbose, db_strerror and db_version.`

Copyright Sleepycat Software