Edit File - File Manager

Edit File: env_close.html

<html>
<head>
<title>Berkeley DB: DbEnv::close</title>
<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit.">
<meta name="keywords" content="embedded,database,programmatic,toolkit,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++">
</head>
<body bgcolor=white>
<table width="100%"><tr valign=top>
<td>
DbEnv::close
</td>
<td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a>
<a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a></td>
</tr></table>
<hr size=1 noshade>
<tt>
<pre>
#include &lt;db_cxx.h&gt;

DbEnv::close(u_int32_t flags);
</pre>
<hr size=1 noshade>
Description: DbEnv::close
The DbEnv::close method closes the Berkeley DB environment, freeing any
allocated resources and closing any underlying subsystems.
The <a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a> handle should not be closed while any other handle
that refers to it is not yet closed; for example, database environment
handles must not be closed while database handles remain open, or
transactions in the environment have not yet been committed or aborted.
Specifically, this includes <a href="../../db4-devel-4.7.25/api_cxx/db_class.html">Db</a>, <a href="../../db4-devel-4.7.25/api_cxx/dbc_class.html">Dbc</a>, <a href="../../db4-devel-4.7.25/api_cxx/txn_class.html">DbTxn</a>,
<a href="../../db4-devel-4.7.25/api_cxx/logc_class.html">DbLogc</a> and <a href="../../db4-devel-4.7.25/api_cxx/mempfile_class.html">DbMpoolFile</a> handles.
Where the environment was initialized with the <a href="../../db4-devel-4.7.25/api_cxx/env_open.html#DB_INIT_LOCK">DB_INIT_LOCK</a>
flag, calling DbEnv::close does not release any locks still held
by the closing process, providing functionality for long-lived locks.
Processes that want to have all their locks released can do so by
issuing the appropriate <a href="../../db4-devel-4.7.25/api_cxx/lock_vec.html">DbEnv::lock_vec</a> call.
Where the environment was initialized with the <a href="../../db4-devel-4.7.25/api_cxx/env_open.html#DB_INIT_MPOOL">DB_INIT_MPOOL</a>
flag, calling DbEnv::close implies calls to <a href="../../db4-devel-4.7.25/api_cxx/memp_fclose.html">DbMpoolFile::close</a> for
any remaining open files in the memory pool that were returned to this
process by calls to <a href="../../db4-devel-4.7.25/api_cxx/memp_fopen.html">DbMpoolFile::open</a>. It does not imply a call to
<a href="../../db4-devel-4.7.25/api_cxx/memp_fsync.html">DbMpoolFile::sync</a> for those files.
Where the environment was initialized with the <a href="../../db4-devel-4.7.25/api_cxx/env_open.html#DB_INIT_TXN">DB_INIT_TXN</a> flag,
calling DbEnv::close aborts any unresolved transactions.
Applications should not depend on this behavior for transactions
involving Berkeley DB databases; all such transactions should be explicitly
resolved. The problem with depending on this semantic is that aborting
an unresolved transaction involving database operations requires a
database handle. Because the database handles should have been closed before
calling DbEnv::close, it will not be possible to abort the
transaction, and recovery will have to be run on the Berkeley DB environment
before further operations are done.
Where log cursors were created using the <a href="../../db4-devel-4.7.25/api_cxx/log_cursor.html">DbEnv::log_cursor</a> method, calling
DbEnv::close does not imply closing those cursors.
In multithreaded applications, only a single thread may call
DbEnv::close.
After DbEnv::close has been called, regardless of its return, the
Berkeley DB environment handle may not be accessed again.
The DbEnv::close 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.

Parameters 
 flags<ul compact><li>The flags parameter is currently unused, and must be set to 0.</ul>
 
<hr size=1 noshade>
 Class
<a href="../../db4-devel-4.7.25/api_cxx/env_class.html">DbEnv</a>
 See Also
<a href="../../db4-devel-4.7.25/api_cxx/env_list.html">Database Environments and Related Methods</a>
</tt>
<table width="100%"><tr><td> </td><td align=right>
<a href="../../db4-devel-4.7.25/api_cxx/api_core.html"><img src="../../db4-devel-4.7.25/images/api.gif" alt="API"></a><a href="../../db4-devel-4.7.25/ref/toc.html"><img src="../../db4-devel-4.7.25/images/ref.gif" alt="Ref"></a>
</td></tr></table>
Copyright (c) 1996,2008 Oracle. All rights reserved.
</body>
</html>

Back to File Manager