mirror of
https://github.com/berkeleydb/libdb.git
synced 2024-11-17 01:26:25 +00:00
333 lines
14 KiB
HTML
333 lines
14 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>Db::close()</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="db.html" title="Chapter 2. The Db Handle" />
|
|||
|
|
<link rel="prev" href="dbassociate_foreign.html" title="Db::associate_foreign()" />
|
|||
|
|
<link rel="next" href="dbcompact.html" title="Db::compact()" />
|
|||
|
|
</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">Db::close()</th>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="20%" align="left"><a accesskey="p" href="dbassociate_foreign.html">Prev</a> </td>
|
|||
|
|
<th width="60%" align="center">Chapter 2.
|
|||
|
|
The Db Handle
|
|||
|
|
</th>
|
|||
|
|
<td width="20%" align="right"> <a accesskey="n" href="dbcompact.html">Next</a></td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
<hr />
|
|||
|
|
</div>
|
|||
|
|
<div class="sect1" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h2 class="title" style="clear: both"><a id="dbclose"></a>Db::close()</h2>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<pre class="programlisting">#include <db_cxx.h>
|
|||
|
|
|
|||
|
|
int
|
|||
|
|
Db::close(u_int32_t flags);</pre>
|
|||
|
|
<p>
|
|||
|
|
The <code class="methodname">Db::close()</code> method flushes cached database information to
|
|||
|
|
disk, closes any open cursors, frees allocated resources, and
|
|||
|
|
closes underlying files. When the close operation for a cursor fails,
|
|||
|
|
the method returns a non-zero error value for the first instance of such an error,
|
|||
|
|
and continues to close the rest of the cursors and database handles.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
Although closing a database handle will close any open cursors, it
|
|||
|
|
is recommended that applications explicitly close all their
|
|||
|
|
<a class="link" href="dbc.html" title="Chapter 3. The Dbc Handle">Dbc</a> handles
|
|||
|
|
before closing the database. The reason why is that when
|
|||
|
|
the cursor is explicitly closed, the memory allocated for it is
|
|||
|
|
reclaimed; however, this will <span class="emphasis"><em>not</em></span> happen if
|
|||
|
|
you close a database while cursors are still opened.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
The same rule, for the same reasons, hold true for
|
|||
|
|
<a class="link" href="txn.html" title="Chapter 13. The DbTxn Handle">DbTxn</a>
|
|||
|
|
handles. Simply make sure you close all your transaction handles
|
|||
|
|
before closing your database handle.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
Because key/data pairs are cached in memory, applications should
|
|||
|
|
make a point to always either close database handles or sync their
|
|||
|
|
data to disk (using the <a class="xref" href="dbsync.html" title="Db::sync()">Db::sync()</a>
|
|||
|
|
method) before exiting, to ensure that any data cached in main memory are
|
|||
|
|
reflected in the underlying file system.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
When called on a database that is the primary database for a secondary
|
|||
|
|
index, the primary database should be closed only after all secondary
|
|||
|
|
indices referencing it have been closed.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
When multiple threads are using the <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
|
|||
|
|
concurrently, only a single thread may call the <code class="methodname">Db::close()</code> method.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
The <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle may not be
|
|||
|
|
accessed again after <code class="methodname">Db::close()</code> is called, regardless of its return.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
If you do not close the <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle explicitly, it will be closed when
|
|||
|
|
the environment handle that owns the <a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a> handle is closed.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
The <code class="methodname">Db::close()</code> <span>
|
|||
|
|
|
|||
|
|
<span>
|
|||
|
|
method either returns a non-zero error value or throws an
|
|||
|
|
exception that encapsulates a non-zero error value on
|
|||
|
|
failure, and returns 0 on success.
|
|||
|
|
</span>
|
|||
|
|
</span>
|
|||
|
|
The error values that <code class="methodname">Db::close()</code> method returns include the error values of <code class="methodname">Dbc::close()</code> and the following:
|
|||
|
|
</p>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3578824"></a><span>DbDeadlockException or </span>DB_LOCK_DEADLOCK</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
A transactional database environment operation was selected to resolve
|
|||
|
|
a deadlock.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
|
|||
|
|
your Berkeley DB API is configured to throw exceptions.
|
|||
|
|
Otherwise, <code class="literal">DB_LOCK_DEADLOCK</code> is returned.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3578837"></a><span>DbLockNotGrantedException or </span>DB_LOCK_NOTGRANTED</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
A Berkeley DB Concurrent Data Store database environment configured
|
|||
|
|
for lock timeouts was unable to grant a lock in the allowed time.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
<a class="xref" href="dblocknotgranted.html" title="DbLockNotGrantedException">DbLockNotGrantedException</a> is thrown if
|
|||
|
|
your Berkeley DB API is configured to throw exceptions.
|
|||
|
|
Otherwise, <code class="literal">DB_LOCK_NOTGRANTED</code> is returned.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3578885"></a>EINVAL</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
If the cursor is already closed; or if an invalid flag value or parameter was specified.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3578864"></a>Parameters</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3579253"></a>flags</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The <span class="bold"><strong>flags</strong></span> parameter must be set to 0
|
|||
|
|
or be set to the following value:
|
|||
|
|
</p>
|
|||
|
|
<div class="itemizedlist">
|
|||
|
|
<ul type="disc">
|
|||
|
|
<li>
|
|||
|
|
<p><a id="dbclose_DB_NOSYNC"></a>
|
|||
|
|
<code class="literal">DB_NOSYNC</code>
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
Do not flush cached information to disk. This flag is a
|
|||
|
|
dangerous option. It should be set only if the application is doing
|
|||
|
|
logging (with transactions) so that the database is recoverable after
|
|||
|
|
a system or application crash, or if the database is always generated
|
|||
|
|
from scratch after any system or application crash.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
<span class="bold"><strong>It is important to understand that flushing
|
|||
|
|
cached information to disk only minimizes the window of opportunity
|
|||
|
|
for corrupted data.</strong></span> Although unlikely, it is possible for
|
|||
|
|
database corruption to happen if a system or application crash occurs
|
|||
|
|
while writing data to the database. To ensure that database
|
|||
|
|
corruption never occurs, applications must either: use transactions
|
|||
|
|
and logging with automatic recovery; use logging and
|
|||
|
|
application-specific recovery; or edit a copy of the database, and
|
|||
|
|
once all applications using the database have successfully called
|
|||
|
|
<code class="methodname">Db::close()</code>, atomically replace the original database with the
|
|||
|
|
updated copy.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
Note that this flag only works when the database
|
|||
|
|
has been opened using an environment.
|
|||
|
|
</p>
|
|||
|
|
</li>
|
|||
|
|
</ul>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3577684"></a>Errors</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The <code class="methodname">Db::close()</code> <span>
|
|||
|
|
|
|||
|
|
<span>
|
|||
|
|
method may fail and throw a <a class="link" href="dbexception.html" title="Chapter 6. The DbException Class">DbException</a>
|
|||
|
|
exception, encapsulating one of the following non-zero errors, or return one
|
|||
|
|
of the following non-zero errors:
|
|||
|
|
</span>
|
|||
|
|
</span>
|
|||
|
|
</p>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3579494"></a>EINVAL</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
An invalid flag value or parameter was specified.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
The error messages returned for the first error encountered when <code class="methodname">Db::close()</code> method closes any open cursors include:
|
|||
|
|
</p>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3579415"></a><span>DbDeadlockException or </span>DB_LOCK_DEADLOCK</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
A transactional database environment operation was selected to resolve
|
|||
|
|
a deadlock.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
<a class="xref" href="dbdeadlock.html" title="DbDeadlockException">DbDeadlockException</a> is thrown if
|
|||
|
|
your Berkeley DB API is configured to throw exceptions.
|
|||
|
|
Otherwise, <code class="literal">DB_LOCK_DEADLOCK</code> is returned.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3579516"></a><span>DbLockNotGrantedException or </span>DB_LOCK_NOTGRANTED</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
A Berkeley DB Concurrent Data Store database environment configured
|
|||
|
|
for lock timeouts was unable to grant a lock in the allowed time.
|
|||
|
|
</p>
|
|||
|
|
<p>
|
|||
|
|
<a class="xref" href="dblocknotgranted.html" title="DbLockNotGrantedException">DbLockNotGrantedException</a> is thrown if
|
|||
|
|
your Berkeley DB API is configured to throw exceptions.
|
|||
|
|
Otherwise, <code class="literal">DB_LOCK_NOTGRANTED</code> is returned.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect3" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h4 class="title"><a id="id3578897"></a>EINVAL</h4>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
If the cursor is already closed; or if an invalid flag value or parameter was specified.
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3579378"></a>Class</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
<a class="link" href="db.html" title="Chapter 2. The Db Handle">Db</a>
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
<div class="sect2" lang="en" xml:lang="en">
|
|||
|
|
<div class="titlepage">
|
|||
|
|
<div>
|
|||
|
|
<div>
|
|||
|
|
<h3 class="title"><a id="id3579545"></a>See Also</h3>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<p>
|
|||
|
|
<a class="xref" href="db.html#dblist" title="Database and Related Methods">Database and Related Methods</a>
|
|||
|
|
</p>
|
|||
|
|
</div>
|
|||
|
|
</div>
|
|||
|
|
<div class="navfooter">
|
|||
|
|
<hr />
|
|||
|
|
<table width="100%" summary="Navigation footer">
|
|||
|
|
<tr>
|
|||
|
|
<td width="40%" align="left"><a accesskey="p" href="dbassociate_foreign.html">Prev</a> </td>
|
|||
|
|
<td width="20%" align="center">
|
|||
|
|
<a accesskey="u" href="db.html">Up</a>
|
|||
|
|
</td>
|
|||
|
|
<td width="40%" align="right"> <a accesskey="n" href="dbcompact.html">Next</a></td>
|
|||
|
|
</tr>
|
|||
|
|
<tr>
|
|||
|
|
<td width="40%" align="left" valign="top">Db::associate_foreign() </td>
|
|||
|
|
<td width="20%" align="center">
|
|||
|
|
<a accesskey="h" href="index.html">Home</a>
|
|||
|
|
</td>
|
|||
|
|
<td width="40%" align="right" valign="top"> Db::compact()</td>
|
|||
|
|
</tr>
|
|||
|
|
</table>
|
|||
|
|
</div>
|
|||
|
|
</body>
|
|||
|
|
</html>
|