Import BSDDB 4.7.25 (as of svn r89086)
This commit is contained in:
92
docs/api_c/env_set_lk_max_locks.html
Normal file
92
docs/api_c/env_set_lk_max_locks.html
Normal file
@@ -0,0 +1,92 @@
|
||||
<!--$Id: env_set_lk_max_locks.html 63573 2008-05-23 21:43:21Z trent.nelson $-->
|
||||
<!--Copyright (c) 1997,2008 Oracle. All rights reserved.-->
|
||||
<!--See the file LICENSE for redistribution information.-->
|
||||
<html>
|
||||
<head>
|
||||
<title>Berkeley DB: DB_ENV->set_lk_max_locks</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>
|
||||
<b>DB_ENV->set_lk_max_locks</b>
|
||||
</td>
|
||||
<td align=right>
|
||||
<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a>
|
||||
<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td>
|
||||
</tr></table>
|
||||
<hr size=1 noshade>
|
||||
<tt>
|
||||
<b><pre>
|
||||
#include <db.h>
|
||||
<p>
|
||||
int
|
||||
DB_ENV->set_lk_max_locks(DB_ENV *dbenv, u_int32_t max);
|
||||
<p>
|
||||
int
|
||||
DB_ENV->get_lk_max_locks(DB_ENV *dbenv, u_int32_t *lk_maxp);
|
||||
</pre></b>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DB_ENV->set_lk_max_locks</b>
|
||||
<p>Set the maximum number of locks supported by the Berkeley DB environment.
|
||||
This value is used by <a href="../api_c/env_open.html">DB_ENV->open</a> to estimate how much space to
|
||||
allocate for various lock-table data structures. The default value is
|
||||
1000 locks. For specific information on configuring the size of the lock
|
||||
subsystem, see <a href="../ref/lock/max.html">Configuring locking:
|
||||
sizing the system</a>.</p>
|
||||
<p>The database environment's maximum number of locks may also be configured using the
|
||||
environment's <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file. The syntax of the entry in that
|
||||
file is a single line with the string "set_lk_max_locks", one or more whitespace
|
||||
characters, and the number of locks.
|
||||
Because the <a href="../ref/env/db_config.html#DB_CONFIG">DB_CONFIG</a> file is read when the database environment
|
||||
is opened, it will silently overrule configuration done before that
|
||||
time.</p>
|
||||
<p>The DB_ENV->set_lk_max_locks method configures a database environment, not only operations
|
||||
performed using the specified <a href="../api_c/env_class.html">DB_ENV</a> handle.</p>
|
||||
<p>The DB_ENV->set_lk_max_locks method may not be called after the <a href="../api_c/env_open.html">DB_ENV->open</a> method is
|
||||
called.
|
||||
If the database environment already exists when
|
||||
<a href="../api_c/env_open.html">DB_ENV->open</a> is called, the information specified to DB_ENV->set_lk_max_locks
|
||||
will be ignored.
|
||||
</p>
|
||||
<p>The DB_ENV->set_lk_max_locks method
|
||||
returns a non-zero error value on failure
|
||||
and 0 on success.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>max</b><ul compact><li>The <b>max</b> parameter is the maximum number of locks supported by
|
||||
the Berkeley DB environment.</ul>
|
||||
<br>
|
||||
<br><b>Errors</b>
|
||||
<p>The DB_ENV->set_lk_max_locks method
|
||||
may fail and return one of the following non-zero errors:</p>
|
||||
<br>
|
||||
<b>EINVAL</b><ul compact><li>If the method was called after <a href="../api_c/env_open.html">DB_ENV->open</a> was called; or if an
|
||||
invalid flag value or parameter was specified.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<b>Description: DB_ENV->get_lk_max_locks</b>
|
||||
<p>The DB_ENV->get_lk_max_locks method returns the maximum number of locks.</p>
|
||||
<p>The DB_ENV->get_lk_max_locks method may be called at any time during the life of the
|
||||
application.</p>
|
||||
<p>The DB_ENV->get_lk_max_locks method
|
||||
returns a non-zero error value on failure
|
||||
and 0 on success.
|
||||
</p>
|
||||
<b>Parameters</b> <br>
|
||||
<b>lk_maxp</b><ul compact><li>The DB_ENV->get_lk_max_locks method returns the
|
||||
maximum number of locks in <b>lk_maxp</b>.</ul>
|
||||
<br>
|
||||
<hr size=1 noshade>
|
||||
<br><b>Class</b>
|
||||
<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/lock_class.html">DB_LOCK</a>
|
||||
<br><b>See Also</b>
|
||||
<a href="../api_c/lock_list.html">Locking Subsystem and Related Methods</a>
|
||||
</tt>
|
||||
<table width="100%"><tr><td><br></td><td align=right>
|
||||
<a href="../api_c/api_core.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a>
|
||||
</td></tr></table>
|
||||
<p><font size=1>Copyright (c) 1996,2008 Oracle. All rights reserved.</font>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user