The DbEnv object is the handle for a Berkeley DB environment
— a collection including support for some or all of caching, locking, logging and
transaction subsystems, as well as databases and log files. Methods of the
DbEnv handle are used to configure the environment as well as
to operate on subsystems and databases in the environment.
DbEnv handles
are opened using the
DbEnv::open()
method.
When you are done using your environment, close it using the DbEnv::close() method. Before closing your environment, make sure all open database handles are closed first. See the Db::close() method for more information.
| Database Environment Operations | Description |
|---|---|
| DbEnv::backup() | Hot back up an entire environment |
| DbEnv::close() | Close an environment |
| DbEnv | Create an environment handle |
| DbEnv::dbbackup() | Hot back up a single environment file |
| DbEnv::dbremove() | Remove a database |
| DbEnv::dbrename() | Rename a database |
| DbEnv::err() | Error message |
| DbEnv::failchk() | Check for thread failure |
| DbEnv::fileid_reset() | Reset database file IDs |
| DbEnv::full_version() | Return full version information |
| Db::get_env() | Return the Db's underlying DbEnv handle |
| DbEnv::get_home() | Return environment's home directory |
| DbEnv::get_open_flags() | Return flags with which the environment was opened |
| DbEnv::get_slices() | Returns an array of slice environments |
| DbEnv::log_verify() | Verify log files of an environment |
| DbEnv::lsn_reset() | Reset database file LSNs |
| DbEnv::msg() | Informational message |
| DbEnv::open() | Open an environment |
| DbEnv::remove() | Remove an environment |
| DbEnv::stat_print() | Environment statistics |
| DbEnv::strerror() | Error strings |
| DbEnv::version() | Return version information |
| Environment Configuration | |
| DbEnv::add_data_dir() | Add an environment data directory |
| DbEnv::get_slice_count() | Returns the number of slices configured for the environment |
| DbEnv::set_alloc() | Set local space allocation functions |
| DbEnv::set_app_dispatch() | Configure application recovery callback |
| DbEnv::set_backup_callbacks() , DbEnv::get_backup_callbacks() | Set/get callbacks used for environment hot backups |
| DbEnv::set_backup_config() , DbEnv::get_backup_config() | Set/get environment hot backup configuration options |
| DbEnv::set_data_dir() , DbEnv::get_data_dirs() | Set/get the environment data directory |
| DbEnv::set_create_dir() , DbEnv::get_create_dir() | Add an environment data directory |
| DbEnv::set_encrypt() , DbEnv::get_encrypt_flags() | Set/get the environment cryptographic key |
| DbEnv::set_event_notify() | Set event notification callback |
| DbEnv::set_errcall() | Set error message callbacks |
| DbEnv::set_errfile() , DbEnv::get_errfile() | Set/get error message FILE |
| DbEnv::set_error_stream() | Set C++ ostream used for error messages |
| DbEnv::set_errpfx() , DbEnv::get_errpfx() | Set/get error message prefix |
| DbEnv::set_feedback() | Set feedback callback |
| DbEnv::set_flags() , DbEnv::get_flags() | Environment configuration |
| DbEnv::set_intermediate_dir_mode() , DbEnv::get_intermediate_dir_mode() | Set/get intermediate directory creation mode |
| DbEnv::set_isalive() | Set thread is-alive callback |
| DbEnv::set_memory_init() , DbEnv::get_memory_init() | Set/get initial memory allocation |
| DbEnv::set_memory_max() , DbEnv::get_memory_max() | Set/get maximum memory allocation |
| DbEnv::set_metadata_dir() , DbEnv::get_metadata_dir() | Set/get the directory containing environment metadata |
| DbEnv::set_message_stream() | Set C++ ostream used for informational messages |
| DbEnv::set_msgcall() | Set informational message callback |
| DbEnv::set_msgfile() , DbEnv::get_msgfile() | Set/get informational message FILE |
| DbEnv::set_msgpfx() , DbEnv::get_msgpfx() | Set/get informational message prefix |
| DbEnv::set_shm_key() , DbEnv::get_shm_key() | Set/get system memory shared segment ID |
| DbEnv::set_thread_count() , DbEnv::get_thread_count() | Set/get approximate thread count |
| DbEnv::set_thread_id() | Set thread of control ID function |
| DbEnv::set_thread_id_string() | Set thread of control ID format function |
| DbEnv::set_timeout() , DbEnv::get_timeout() | Set/get lock and transaction timeout |
| DbEnv::set_tmp_dir() , DbEnv::get_tmp_dir() | Set/get the environment temporary file directory |
| DbEnv::set_verbose() , DbEnv::get_verbose() | Set/get verbose messages |
| DbEnv::set_cachesize() , DbEnv::get_cachesize() | Set/get the environment cache size |