admin/yasuhirokimura-db18
1
0
Fork 0
mirror of https://github.com/yasuhirokimura/db18 synced 2026-06-08 18:29:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
master
yasuhirokimura-db18/docs/api_reference/CXX/env.html
T
Yasuhiro KIMURA 9678929700 Update to 18.1.40
2020-07-24 01:10:28 +09:00

631 lines
22 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<title>Chapter 5.  The DbEnv Handle</title>
<link rel="stylesheet" href="apiReference.css" type="text/css" />
<meta name="generator" content="DocBook XSL Stylesheets V1.73.2" />
<link rel="start" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="up" href="index.html" title="Berkeley DB C++ API Reference" />
<link rel="prev" href="dbmultiplerecnodatabuilder.html" title="DbMultipleRecnoDataBuilder" />
<link rel="next" href="envadd_data_dir.html" title="DbEnv::add_data_dir()" />
</head>
<body>
<div xmlns="" class="navheader">
<div class="libver">
<p>Library Version 18.1.40</p>
</div>
<table width="100%" summary="Navigation header">
<tr>
<th colspan="3" align="center">Chapter 5. 
The DbEnv Handle
</th>
</tr>
<tr>
<td width="20%" align="left"><a accesskey="p" href="dbmultiplerecnodatabuilder.html">Prev</a> </td>
<th width="60%" align="center"> </th>
<td width="20%" align="right"> <a accesskey="n" href="envadd_data_dir.html">Next</a></td>
</tr>
</table>
<hr />
</div>
<div class="chapter" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title"><a id="env"></a>Chapter 5. 
The DbEnv Handle
</h2>
</div>
</div>
</div>
<p>
The <code class="classname">DbEnv</code> 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
<code class="classname">DbEnv</code> handle are used to configure the environment as well as
to operate on subsystems and databases in the environment.
</p>
<p>
<code class="classname">DbEnv</code> handles
are opened using the <a class="xref" href="envopen.html" title="DbEnv::open()">
<span>DbEnv::open()</span>
</a>
method.
</p>
<p>
When you are done using your environment, close it using the
<a class="xref" href="envclose.html" title="DbEnv::close()">
<span>DbEnv::close()</span>
</a> method. Before closing your
environment, make sure all open database handles are closed first. See the
<a class="xref" href="dbclose.html" title="Db::close()">
<span>Db::close()</span>
</a> method for more information.
</p>
<div class="sect1" lang="en" xml:lang="en">
<div class="titlepage">
<div>
<div>
<h2 class="title" style="clear: both"><a id="envlist"></a>Database Environments and Related Methods</h2>
</div>
</div>
</div>
<div class="navtable">
<table border="1" width="80%">
<thead>
<tr>
<th>Database Environment Operations</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a class="xref" href="envbackup.html" title="DbEnv::backup()">
<span>DbEnv::backup()</span>
</a>
</td>
<td>Hot back up an entire environment</td>
</tr>
<tr>
<td>
<a class="xref" href="envclose.html" title="DbEnv::close()">
<span>DbEnv::close()</span>
</a>
</td>
<td>Close an environment</td>
</tr>
<tr>
<td>
<a class="xref" href="envcreate.html" title="DbEnv">
<span>DbEnv</span>
</a>
</td>
<td>Create an environment handle</td>
</tr>
<tr>
<td>
<a class="xref" href="envdbbackup.html" title="DbEnv::dbbackup()">
<span>DbEnv::dbbackup()</span>
</a>
</td>
<td>Hot back up a single environment file</td>
</tr>
<tr>
<td>
<a class="xref" href="envdbremove.html" title="DbEnv::dbremove()">
<span>DbEnv::dbremove()</span>
</a>
</td>
<td>Remove a database</td>
</tr>
<tr>
<td>
<a class="xref" href="envdbrename.html" title="DbEnv::dbrename()">
<span>DbEnv::dbrename()</span>
</a>
</td>
<td>Rename a database</td>
</tr>
<tr>
<td>
<a class="xref" href="enverr.html" title="DbEnv::err()">
<span>DbEnv::err()</span>
</a>
</td>
<td>Error message</td>
</tr>
<tr>
<td>
<a class="xref" href="envfailchk.html" title="DbEnv::failchk()">
<span>DbEnv::failchk()</span>
</a>
</td>
<td>Check for thread failure</td>
</tr>
<tr>
<td>
<a class="xref" href="envfileid_reset.html" title="DbEnv::fileid_reset()">
<span>DbEnv::fileid_reset()</span>
</a>
</td>
<td>Reset database file IDs</td>
</tr>
<tr>
<td>
<a class="xref" href="envfullversion.html" title="DbEnv::full_version()">
<span>DbEnv::full_version()</span>
</a>
</td>
<td>Return full version information</td>
</tr>
<tr>
<td>
<a class="xref" href="dbgetenv.html" title="Db::get_env()">
<span>Db::get_env()</span>
</a>
</td>
<td>Return the Db's underlying DbEnv handle </td>
</tr>
<tr>
<td>
<a class="xref" href="envget_home.html" title="DbEnv::get_home()">
<span>DbEnv::get_home()</span>
</a>
</td>
<td>Return environment's home directory</td>
</tr>
<tr>
<td>
<a class="xref" href="envget_open_flags.html" title="DbEnv::get_open_flags()">
<span>DbEnv::get_open_flags()</span>
</a>
</td>
<td>Return flags with which the environment was opened</td>
</tr>
<tr>
<td>
<a class="xref" href="envget_slices.html" title="DbEnv::get_slices()">
<span>DbEnv::get_slices()</span>
</a>
</td>
<td>Returns an array of slice environments</td>
</tr>
<tr>
<td>
<a class="xref" href="envlog_verify.html" title="DbEnv::log_verify()">
<span>DbEnv::log_verify()</span>
</a>
</td>
<td>Verify log files of an environment</td>
</tr>
<tr>
<td>
<a class="xref" href="envlsn_reset.html" title="DbEnv::lsn_reset()">
<span>DbEnv::lsn_reset()</span>
</a>
</td>
<td>Reset database file LSNs</td>
</tr>
<tr>
<td>
<a class="xref" href="envmsg.html" title="DbEnv::msg()">
<span>DbEnv::msg()</span>
</a>
</td>
<td>Informational message</td>
</tr>
<tr>
<td>
<a class="xref" href="envopen.html" title="DbEnv::open()">
<span>DbEnv::open()</span>
</a>
</td>
<td>Open an environment</td>
</tr>
<tr>
<td>
<a class="xref" href="envremove.html" title="DbEnv::remove()">
<span>DbEnv::remove()</span>
</a>
</td>
<td>Remove an environment</td>
</tr>
<tr>
<td>
<a class="xref" href="envstat.html" title="DbEnv::stat_print()">
<span>DbEnv::stat_print()</span>
</a>
</td>
<td>Environment statistics</td>
</tr>
<tr>
<td>
<a class="xref" href="envstrerror.html" title="DbEnv::strerror()">
<span>DbEnv::strerror()</span>
</a>
</td>
<td>Error strings</td>
</tr>
<tr>
<td>
<a class="xref" href="envversion.html" title="DbEnv::version()">
<span>DbEnv::version()</span>
</a>
</td>
<td>Return version information</td>
</tr>
<tr>
<td colspan="2">
<span class="bold">
<strong>Environment Configuration</strong>
</span>
</td>
</tr>
<tr>
<td>
<a class="xref" href="envadd_data_dir.html" title="DbEnv::add_data_dir()">
<span>DbEnv::add_data_dir()</span>
</a>
</td>
<td>Add an environment data directory</td>
</tr>
<tr>
<td>
<a class="xref" href="envget_slice_count.html" title="DbEnv::get_slice_count()">
<span>DbEnv::get_slice_count()</span>
</a>
</td>
<td>Returns the number of slices configured for the environment</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_alloc.html" title="DbEnv::set_alloc()">
<span>DbEnv::set_alloc()</span>
</a>
</td>
<td>Set local space allocation functions</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_app_dispatch.html" title="DbEnv::set_app_dispatch()">
<span>DbEnv::set_app_dispatch()</span>
</a>
</td>
<td>Configure application recovery callback</td>
</tr>
<tr>
<td><a class="xref" href="envset_backup_callbacks.html" title="DbEnv::set_backup_callbacks()">
<span>DbEnv::set_backup_callbacks()</span>
</a>, <a class="xref" href="envget_backup_callbacks.html" title="DbEnv::get_backup_callbacks()">
<span>DbEnv::get_backup_callbacks()</span>
</a></td>
<td>Set/get callbacks used for environment hot backups</td>
</tr>
<tr>
<td><a class="xref" href="envset_backup_config.html" title="DbEnv::set_backup_config()">
<span>DbEnv::set_backup_config()</span>
</a>, <a class="xref" href="envget_backup_config.html" title="DbEnv::get_backup_config()">
<span>DbEnv::get_backup_config()</span>
</a></td>
<td>Set/get environment hot backup configuration options</td>
</tr>
<tr>
<td><a class="xref" href="envset_data_dir.html" title="DbEnv::set_data_dir()">
<span>DbEnv::set_data_dir()</span>
</a>, <a class="xref" href="envget_data_dirs.html" title="DbEnv::get_data_dirs()">
<span>DbEnv::get_data_dirs()</span>
</a></td>
<td>Set/get the environment data directory</td>
</tr>
<tr>
<td><a class="xref" href="envset_create_dir.html" title="DbEnv::set_create_dir()">
<span>DbEnv::set_create_dir()</span>
</a>, <a class="xref" href="envget_create_dir.html" title="DbEnv::get_create_dir()">
<span>DbEnv::get_create_dir()</span>
</a></td>
<td>Add an environment data directory</td>
</tr>
<tr>
<td><a class="xref" href="envset_encrypt.html" title="DbEnv::set_encrypt()">
<span>DbEnv::set_encrypt()</span>
</a>, <a class="xref" href="envget_encrypt_flags.html" title="DbEnv::get_encrypt_flags()">
<span>DbEnv::get_encrypt_flags()</span>
</a></td>
<td>Set/get the environment cryptographic key</td>
</tr>
<tr>
<td>
<a class="xref" href="envevent_notify.html" title="DbEnv::set_event_notify()">
<span>DbEnv::set_event_notify()</span>
</a>
</td>
<td>Set event notification callback</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_errcall.html" title="DbEnv::set_errcall()">
<span>DbEnv::set_errcall()</span>
</a>
</td>
<td>Set error message callbacks</td>
</tr>
<tr>
<td><a class="xref" href="envset_errfile.html" title="DbEnv::set_errfile()">
<span>DbEnv::set_errfile()</span>
</a>, <a class="xref" href="envget_errfile.html" title="DbEnv::get_errfile()">
<span>DbEnv::get_errfile()</span>
</a></td>
<td>Set/get error message FILE</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_error_stream.html" title="DbEnv::set_error_stream()">DbEnv::set_error_stream()</a>
</td>
<td>Set C++ ostream used for error messages</td>
</tr>
<tr>
<td><a class="xref" href="envset_errpfx.html" title="DbEnv::set_errpfx()">
<span>DbEnv::set_errpfx()</span>
</a>, <a class="xref" href="envget_errpfx.html" title="DbEnv::get_errpfx()">
<span>DbEnv::get_errpfx()</span>
</a></td>
<td>Set/get error message prefix</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_feedback.html" title="DbEnv::set_feedback()">
<span>DbEnv::set_feedback()</span>
</a>
</td>
<td>Set feedback callback</td>
</tr>
<tr>
<td><a class="xref" href="envset_flags.html" title="DbEnv::set_flags()">
<span>DbEnv::set_flags()</span>
</a>, <a class="xref" href="envget_flags.html" title="DbEnv::get_flags()">
<span>DbEnv::get_flags()</span>
</a></td>
<td>Environment configuration</td>
</tr>
<tr>
<td><a class="xref" href="envset_intermediate_dir_mode.html" title="DbEnv::set_intermediate_dir_mode()">
<span>DbEnv::set_intermediate_dir_mode()</span>
</a>, <a class="xref" href="envget_intermediate_dir_mode.html" title="DbEnv::get_intermediate_dir_mode()">
<span>DbEnv::get_intermediate_dir_mode()</span>
</a></td>
<td>Set/get intermediate directory creation mode</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_isalive.html" title="DbEnv::set_isalive()">
<span>DbEnv::set_isalive()</span>
</a>
</td>
<td>Set thread is-alive callback</td>
</tr>
<tr>
<td><a class="xref" href="envset_memory_init.html" title="DbEnv::set_memory_init()">
<span>DbEnv::set_memory_init()</span>
</a>, <a class="xref" href="envget_memory_init.html" title="DbEnv::get_memory_init()">
<span>DbEnv::get_memory_init()</span>
</a></td>
<td>Set/get initial memory allocation</td>
</tr>
<tr>
<td><a class="xref" href="envset_memory_max.html" title="DbEnv::set_memory_max()">
<span>DbEnv::set_memory_max()</span>
</a>, <a class="xref" href="envget_memory_max.html" title="DbEnv::get_memory_max()">
<span>DbEnv::get_memory_max()</span>
</a></td>
<td>Set/get maximum memory allocation</td>
</tr>
<tr>
<td><a class="xref" href="envset_metadata_dir.html" title="DbEnv::set_metadata_dir()">
<span>DbEnv::set_metadata_dir()</span>
</a>, <a class="xref" href="envget_metadata_dir.html" title="DbEnv::get_metadata_dir()">
<span>DbEnv::get_metadata_dir()</span>
</a></td>
<td>Set/get the directory containing environment metadata </td>
</tr>
<tr>
<td>
<a class="xref" href="envset_message_stream.html" title="DbEnv::set_message_stream()">DbEnv::set_message_stream()</a>
</td>
<td>Set C++ ostream used for informational messages</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_msgcall.html" title="DbEnv::set_msgcall()">
<span>DbEnv::set_msgcall()</span>
</a>
</td>
<td>Set informational message callback</td>
</tr>
<tr>
<td><a class="xref" href="envset_msgfile.html" title="DbEnv::set_msgfile()">
<span>DbEnv::set_msgfile()</span>
</a>, <a class="xref" href="envget_msgfile.html" title="DbEnv::get_msgfile()">
<span>DbEnv::get_msgfile()</span>
</a></td>
<td>Set/get informational message FILE</td>
</tr>
<tr>
<td><a class="xref" href="envset_msgpfx.html" title="DbEnv::set_msgpfx()">
<span>DbEnv::set_msgpfx()</span>
</a>, <a class="xref" href="envget_msgpfx.html" title="DbEnv::get_msgpfx()">
<span>DbEnv::get_msgpfx()</span>
</a></td>
<td>Set/get informational message prefix</td>
</tr>
<tr>
<td><a class="xref" href="envset_shm_key.html" title="DbEnv::set_shm_key()">
<span>DbEnv::set_shm_key()</span>
</a>, <a class="xref" href="envget_shm_key.html" title="DbEnv::get_shm_key()">
<span>DbEnv::get_shm_key()</span>
</a></td>
<td>Set/get system memory shared segment ID</td>
</tr>
<tr>
<td><a class="xref" href="envset_thread_count.html" title="DbEnv::set_thread_count()">
<span>DbEnv::set_thread_count()</span>
</a>, <a class="xref" href="envget_thread_count.html" title="DbEnv::get_thread_count()">
<span>DbEnv::get_thread_count()</span>
</a></td>
<td>Set/get approximate thread count</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_thread_id.html" title="DbEnv::set_thread_id()">
<span>DbEnv::set_thread_id()</span>
</a>
</td>
<td>Set thread of control ID function</td>
</tr>
<tr>
<td>
<a class="xref" href="envset_thread_id_string.html" title="DbEnv::set_thread_id_string()">
<span>DbEnv::set_thread_id_string()</span>
</a>
</td>
<td>Set thread of control ID format function</td>
</tr>
<tr>
<td><a class="xref" href="envset_timeout.html" title="DbEnv::set_timeout()">
<span>DbEnv::set_timeout()</span>
</a>, <a class="xref" href="envget_timeout.html" title="DbEnv::get_timeout()">
<span>DbEnv::get_timeout()</span>
</a></td>
<td>Set/get lock and transaction timeout</td>
</tr>
<tr>
<td><a class="xref" href="envset_tmp_dir.html" title="DbEnv::set_tmp_dir()">
<span>DbEnv::set_tmp_dir()</span>
</a>, <a class="xref" href="envget_tmp_dir.html" title="DbEnv::get_tmp_dir()">
<span>DbEnv::get_tmp_dir()</span>
</a></td>
<td>Set/get the environment temporary file directory</td>
</tr>
<tr>
<td><a class="xref" href="envset_verbose.html" title="DbEnv::set_verbose()">
<span>DbEnv::set_verbose()</span>
</a>, <a class="xref" href="envget_verbose.html" title="DbEnv::get_verbose()">
<span>DbEnv::get_verbose()</span>
</a></td>
<td>Set/get verbose messages</td>
</tr>
<tr>
<td><a class="xref" href="envset_cachesize.html" title="DbEnv::set_cachesize()">
<span>DbEnv::set_cachesize()</span>
</a>, <a class="xref" href="envget_cachesize.html" title="DbEnv::get_cachesize()">
<span>DbEnv::get_cachesize()</span>
</a></td>
<td>Set/get the environment cache size</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="navfooter">
<hr />
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left"><a accesskey="p" href="dbmultiplerecnodatabuilder.html">Prev</a> </td>
<td width="20%" align="center"> </td>
<td width="40%" align="right"> <a accesskey="n" href="envadd_data_dir.html">Next</a></td>
</tr>
<tr>
<td width="40%" align="left" valign="top">DbMultipleRecnoDataBuilder </td>
<td width="20%" align="center">
<a accesskey="h" href="index.html">Home</a>
</td>
<td width="40%" align="right" valign="top"> 
<span>DbEnv::add_data_dir()</span>
</td>
</tr>
</table>
</div>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink