mirror of
https://github.com/berkeleydb/libdb.git
synced 2024-11-17 01:26:25 +00:00
246 lines
9.8 KiB
HTML
246 lines
9.8 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 3. Db_container</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++ Standard Template Library API Reference" />
|
|||
|
|
<link rel="up" href="index.html" title="Berkeley DB C++ Standard Template Library API Reference" />
|
|||
|
|
<link rel="prev" href="dbstl_containers.html" title="Chapter 2. Dbstl Container Classes" />
|
|||
|
|
<link rel="next" href="stldb_containerget_db_set_flags.html" title="get_db_set_flags" />
|
|||
|
|
</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 3.
|
|||
|
|
Db_container </th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="20%" align="left"><a accesskey="p" href="dbstl_containers.html">Prev</a> </td>
|
|||
|
|
<th width="60%" align="center"> </th>
|
|||
|
|
<td width="20%" align="right"> <a accesskey="n" href="stldb_containerget_db_set_flags.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="db_container"></a>Chapter 3.
|
|||
|
|
Db_container </h2>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>This class is the base class for all db container classes, you don't directly use this class, but all container classes inherit from this class, so you need to know the methods that can be accessed via concrete container classes. </p>
|
|||
|
|
<p>This class is also used to support auto commit transactions. Autocommit is enabled when DB_AUTO_COMMIT is set to the database or database environment handle and the environment is transactional.</p>
|
|||
|
|
<p>Inside dbstl, there are transactions begun and committed/aborted if the backing database and/or environment requires auto commit, and there are cursors opened internally, and you can set the flags used by the transaction and cursor functions via set functions of this class.</p>
|
|||
|
|
<p>All dbstl containers are fully multi-threaded, you should not need any synchronization to use them in the correct way, but this class is not thread safe, access to its members are not proctected by any mutex because the data members of this class are supposed to be set before they are used, and remain read only afterwards. If this is not the case, you must synchronize the access. </p>
|
|||
|
|
<h4><a id="id3514280"></a> Public Members </h4>
|
|||
|
|
<div class="informaltable">
|
|||
|
|
<table border="1" width="80%">
|
|||
|
|
<colgroup>
|
|||
|
|
<col />
|
|||
|
|
<col />
|
|||
|
|
</colgroup>
|
|||
|
|
<thead>
|
|||
|
|
<tr>
|
|||
|
|
<th>Member</th>
|
|||
|
|
<th>Description</th>
|
|||
|
|
</tr>
|
|||
|
|
</thead>
|
|||
|
|
<tbody>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="db_container.html#stldb_containerget_db_open_flags" title="get_db_open_flags">get_db_open_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get the backing database's open flags. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerget_db_set_flags.html" title="get_db_set_flags">get_db_set_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get the backing database's flags that are set via Db::set_flags() function. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerget_db_handle.html" title="get_db_handle">get_db_handle</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get the backing database's handle. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerget_db_env_handle.html" title="get_db_env_handle">get_db_env_handle</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get the backing database environment's handle. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerset_db_handle.html" title="set_db_handle">set_db_handle</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Set the underlying database's handle, and optionally environment handle if the environment has also changed. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerset_all_flags.html" title="set_all_flags">set_all_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Set the flags required by the Berkeley DB functions DbEnv::txn_begin(), DbTxn::commit() and DbEnv::cursor(). </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerset_txn_begin_flags.html" title="set_txn_begin_flags">set_txn_begin_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Set flag of DbEnv::txn_begin() call. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerget_txn_begin_flags.html" title="get_txn_begin_flags">get_txn_begin_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get flag of DbEnv::txn_begin() call. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerset_commit_flags.html" title="set_commit_flags">set_commit_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Set flag of DbTxn::commit() call. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerget_commit_flags.html" title="get_commit_flags">get_commit_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get flag of DbTxn::commit() call. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerget_cursor_open_flags.html" title="get_cursor_open_flags">get_cursor_open_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Get flag of Db::cursor() call. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerset_cursor_open_flags.html" title="set_cursor_open_flags">set_cursor_open_flags</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Set flag of Db::cursor() call. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerdb_container.html" title="db_container">
|
|||
|
|
db_container
|
|||
|
|
</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>Default constructor. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td>
|
|||
|
|
<a class="xref" href="stldb_containerdstr_db_container.html" title="~db_container">~db_container</a>
|
|||
|
|
</td>
|
|||
|
|
<td>
|
|||
|
|
<p>The backing database is not closed in this function. </p> </td>
|
|||
|
|
</tr>
|
|||
|
|
</tbody>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
<h4><a id="id3514333"></a>
|
|||
|
|
Group</h4>
|
|||
|
|
<p>
|
|||
|
|
<a class="xref" href="dbstl_containers.html" title="Chapter 2. Dbstl Container Classes">
|
|||
|
|
Dbstl Container Classes </a>
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
</p>
|
|||
|
|
<div class="sect1" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h2 class="title" style="clear: both"><a id="stldb_containerget_db_open_flags"></a>get_db_open_flags</h2>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="stldb_containerget_db_open_flags_details"></a>Function Details</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<pre class="programlisting">
|
|||
|
|
u_int32_t get_db_open_flags() const
|
|||
|
|
</pre>
|
|||
|
|
<p>Get the backing database's open flags. </p>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3514616"></a>Return Value</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>The backing database's open flags. </p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3514746"></a>Group: Get and set functions for data members.</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>Note that these functions are not thread safe, because all data members of <a class="link" href="db_container.html" title="Chapter 3. Db_container">db_container</a>
|
|||
|
|
are supposed to be set on container construction and initialization, and remain read only afterwards. </p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3514927"></a>Class</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
<a class="link" href="db_container.html" title="Chapter 3. Db_container">db_container</a>
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="navfooter">
|
|||
|
|
<hr />
|
|||
|
|
<table width="100%" summary="Navigation footer">
|
|||
|
|
<tr>
|
|||
|
|
<td width="40%" align="left"><a accesskey="p" href="dbstl_containers.html">Prev</a> </td>
|
|||
|
|
<td width="20%" align="center"> </td>
|
|||
|
|
<td width="40%" align="right"> <a accesskey="n" href="stldb_containerget_db_set_flags.html">Next</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="40%" align="left" valign="top">Chapter 2.
|
|||
|
|
Dbstl Container Classes </td>
|
|||
|
|
<td width="20%" align="center">
|
|||
|
|
<a accesskey="h" href="index.html">Home</a>
|
|||
|
|
</td>
|
|||
|
|
<td width="40%" align="right" valign="top"> get_db_set_flags</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|