mirror of
https://github.com/berkeleydb/libdb.git
synced 2024-11-17 01:26:25 +00:00
345 lines
17 KiB
HTML
345 lines
17 KiB
HTML
|
<?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 DB_ENV 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="DB_MULTIPLE_RECNO_RESERVE_NEXT.html" title="DB_MULTIPLE_RECNO_RESERVE_NEXT" />
|
|||
|
|
<link rel="next" href="dbgetenv.html" title="DB->get_env()" />
|
|||
|
|
</head>
|
|||
|
|
<body>
|
|||
|
|
<div xmlns="" class="navheader">
|
|||
|
|
<div class="libver">
|
|||
|
|
<p>Library Version 11.2.5.2</p>
|
|||
|
|
</div>
|
|||
|
|
<table width="100%" summary="Navigation header">
|
|||
|
|
<tr>
|
|||
|
|
<th colspan="3" align="center">Chapter 5.
|
|||
|
|
The DB_ENV Handle
|
|||
|
|
</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="20%" align="left"><a accesskey="p" href="DB_MULTIPLE_RECNO_RESERVE_NEXT.html">Prev</a> </td>
|
|||
|
|
<th width="60%" align="center"> </th>
|
|||
|
|
<td width="20%" align="right"> <a accesskey="n" href="dbgetenv.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 DB_ENV Handle
|
|||
|
|
</h2>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The <code class="classname">DB_ENV</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">DB_ENV</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">DB_ENV</code> handles
|
|||
|
|
<span>
|
|||
|
|
are created using the <a class="xref" href="envcreate.html" title="db_env_create">db_env_create</a>
|
|||
|
|
method, and
|
|||
|
|
</span>
|
|||
|
|
are opened using the <a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->open()</a>
|
|||
|
|
method.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
When you are done using your environment, close it using the
|
|||
|
|
<a class="xref" href="envclose.html" title="DB_ENV->close()">DB_ENV->close()</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()">DB->close()</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="dbgetenv.html" title="DB->get_env()">DB->get_env()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Return the DB's underlying DB_ENV handle </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envclose.html" title="DB_ENV->close()">DB_ENV->close()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Close an environment</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envcreate.html" title="db_env_create">db_env_create</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Create an environment handle</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envdbremove.html" title="DB_ENV->dbremove()">DB_ENV->dbremove()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Remove a database</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envdbrename.html" title="DB_ENV->dbrename()">DB_ENV->dbrename()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Rename a database</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="enverr.html" title="DB_ENV->err()">DB_ENV->err()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Error message</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envfailchk.html" title="DB_ENV->failchk()">DB_ENV->failchk()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Check for thread failure</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envfileid_reset.html" title="DB_ENV->fileid_reset()">DB_ENV->fileid_reset()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Reset database file IDs</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envfullversion.html" title="db_full_version">db_full_version</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Return full version information</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envget_home.html" title="DB_ENV->get_home()">DB_ENV->get_home()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Return environment's home directory</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envget_open_flags.html" title="DB_ENV->get_open_flags()">DB_ENV->get_open_flags()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Return flags with which the environment was opened</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envlog_verify.html" title="DB_ENV->log_verify()">DB_ENV->log_verify()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Verify log files of an environment.</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envlsn_reset.html" title="DB_ENV->lsn_reset()">DB_ENV->lsn_reset()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Reset database file LSNs</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envopen.html" title="DB_ENV->open()">DB_ENV->open()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Open an environment</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envremove.html" title="DB_ENV->remove()">DB_ENV->remove()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Remove an environment</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envstat.html" title="DB_ENV->stat_print()">DB_ENV->stat_print()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Environment statistics</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envstrerror.html" title="db_strerror">db_strerror</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Error strings</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envversion.html" title="db_version">db_version</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="DB_ENV->add_data_dir()">DB_ENV->add_data_dir()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>add an environment data directory</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_alloc.html" title="DB_ENV->set_alloc()">DB_ENV->set_alloc()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set local space allocation functions</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_app_dispatch.html" title="DB_ENV->set_app_dispatch()">DB_ENV->set_app_dispatch()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Configure application recovery callback</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_data_dir.html" title="DB_ENV->set_data_dir()">DB_ENV->set_data_dir()</a>, <a class="xref" href="envget_data_dirs.html" title="DB_ENV->get_data_dirs()">DB_ENV->get_data_dirs()</a></td>
|
|||
|
|
<td>Set/get the environment data directory</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_create_dir.html" title="DB_ENV->set_create_dir()">DB_ENV->set_create_dir()</a>, <a class="xref" href="envget_create_dir.html" title="DB_ENV->get_create_dir()">DB_ENV->get_create_dir()</a></td>
|
|||
|
|
<td>add an environment data directory</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_encrypt.html" title="DB_ENV->set_encrypt()">DB_ENV->set_encrypt()</a>, <a class="xref" href="envget_encrypt_flags.html" title="DB_ENV->get_encrypt_flags()">DB_ENV->get_encrypt_flags()</a></td>
|
|||
|
|
<td>Set/get the environment cryptographic key</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envevent_notify.html" title="DB_ENV->set_event_notify()">DB_ENV->set_event_notify()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set event notification callback</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_errcall.html" title="DB_ENV->set_errcall()">DB_ENV->set_errcall()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set error message callbacks</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_errfile.html" title="DB_ENV->set_errfile()">DB_ENV->set_errfile()</a>, <a class="xref" href="envget_errfile.html" title="DB_ENV->get_errfile()">DB_ENV->get_errfile()</a></td>
|
|||
|
|
<td>Set/get error message FILE</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_errpfx.html" title="DB_ENV->set_errpfx()">DB_ENV->set_errpfx()</a>, <a class="xref" href="envget_errpfx.html" title="DB_ENV->get_errpfx()">DB_ENV->get_errpfx()</a></td>
|
|||
|
|
<td>Set/get error message prefix</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_feedback.html" title="DB_ENV->set_feedback()">DB_ENV->set_feedback()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set feedback callback</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_flags.html" title="DB_ENV->set_flags()">DB_ENV->set_flags()</a>, <a class="xref" href="envget_flags.html" title="DB_ENV->get_flags()">DB_ENV->get_flags()</a></td>
|
|||
|
|
<td>Environment configuration</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_intermediate_dir_mode.html" title="DB_ENV->set_intermediate_dir_mode()">DB_ENV->set_intermediate_dir_mode()</a>, <a class="xref" href="envget_intermediate_dir_mode.html" title="DB_ENV->get_intermediate_dir_mode()">DB_ENV->get_intermediate_dir_mode()</a></td>
|
|||
|
|
<td>Set/get intermediate directory creation mode</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_isalive.html" title="DB_ENV->set_isalive()">DB_ENV->set_isalive()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set thread is-alive callback</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_memory_init.html" title="DB_ENV->set_memory_init()">DB_ENV->set_memory_init()</a>, <a class="xref" href="envget_memory_init.html" title="DB_ENV->get_memory_init()">DB_ENV->get_memory_init()</a></td>
|
|||
|
|
<td>Set/get initial memory allocation</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_memory_max.html" title="DB_ENV->set_memory_max()">DB_ENV->set_memory_max()</a>, <a class="xref" href="envget_memory_max.html" title="DB_ENV->get_memory_max()">DB_ENV->get_memory_max()</a></td>
|
|||
|
|
<td>Set/get maximum memory allocation</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_msgcall.html" title="DB_ENV->set_msgcall()">DB_ENV->set_msgcall()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set informational message callback</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_msgfile.html" title="DB_ENV->set_msgfile()">DB_ENV->set_msgfile()</a>, <a class="xref" href="envget_msgfile.html" title="DB_ENV->get_msgfile()">DB_ENV->get_msgfile()</a></td>
|
|||
|
|
<td>Set/get informational message FILE</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_shm_key.html" title="DB_ENV->set_shm_key()">DB_ENV->set_shm_key()</a>, <a class="xref" href="envget_shm_key.html" title="DB_ENV->get_shm_key()">DB_ENV->get_shm_key()</a></td>
|
|||
|
|
<td>Set/get system memory shared segment ID</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_thread_count.html" title="DB_ENV->set_thread_count()">DB_ENV->set_thread_count()</a>, <a class="xref" href="envget_thread_count.html" title="DB_ENV->get_thread_count()">DB_ENV->get_thread_count()</a></td>
|
|||
|
|
<td>Set/get approximate thread count</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_thread_id.html" title="DB_ENV->set_thread_id()">DB_ENV->set_thread_id()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set thread of control ID function</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="envset_thread_id_string.html" title="DB_ENV->set_thread_id_string()">DB_ENV->set_thread_id_string()</a>
|
|||
|
|
</td>
|
|||
|
|
<td>Set thread of control ID format function</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_timeout.html" title="DB_ENV->set_timeout()">DB_ENV->set_timeout()</a>, <a class="xref" href="envget_timeout.html" title="DB_ENV->get_timeout()">DB_ENV->get_timeout()</a></td>
|
|||
|
|
<td>Set/get lock and transaction timeout</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_tmp_dir.html" title="DB_ENV->set_tmp_dir()">DB_ENV->set_tmp_dir()</a>, <a class="xref" href="envget_tmp_dir.html" title="DB_ENV->get_tmp_dir()">DB_ENV->get_tmp_dir()</a></td>
|
|||
|
|
<td>Set/get the environment temporary file directory</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_verbose.html" title="DB_ENV->set_verbose()">DB_ENV->set_verbose()</a>, <a class="xref" href="envget_verbose.html" title="DB_ENV->get_verbose()">DB_ENV->get_verbose()</a></td>
|
|||
|
|
<td>Set/get verbose messages</td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td><a class="xref" href="envset_cachesize.html" title="DB_ENV->set_cachesize()">DB_ENV->set_cachesize()</a>, <a class="xref" href="envget_cachesize.html" title="DB_ENV->get_cachesize()">DB_ENV->get_cachesize()</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="DB_MULTIPLE_RECNO_RESERVE_NEXT.html">Prev</a> </td>
|
|||
|
|
<td width="20%" align="center"> </td>
|
|||
|
|
<td width="40%" align="right"> <a accesskey="n" href="dbgetenv.html">Next</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="40%" align="left" valign="top">DB_MULTIPLE_RECNO_RESERVE_NEXT </td>
|
|||
|
|
<td width="20%" align="center">
|
|||
|
|
<a accesskey="h" href="index.html">Home</a>
|
|||
|
|
</td>
|
|||
|
|
<td width="40%" align="right" valign="top"> DB->get_env()</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|