diff options
| author | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
|---|---|---|
| committer | Lorry <lorry@roadtrain.codethink.co.uk> | 2012-07-20 20:00:05 +0100 |
| commit | 3ef782d3745ea8f25a3151561a3cfb882190210e (patch) | |
| tree | 86b9c2f5fde051dd0bced99b3fc9f5a3ba08db69 /docs/api_reference/C/set_flags_parameter.html | |
| download | berkeleydb-3ef782d3745ea8f25a3151561a3cfb882190210e.tar.gz | |
Tarball conversion
Diffstat (limited to 'docs/api_reference/C/set_flags_parameter.html')
| -rw-r--r-- | docs/api_reference/C/set_flags_parameter.html | 143 |
1 files changed, 143 insertions, 0 deletions
diff --git a/docs/api_reference/C/set_flags_parameter.html b/docs/api_reference/C/set_flags_parameter.html new file mode 100644 index 00000000..2db23204 --- /dev/null +++ b/docs/api_reference/C/set_flags_parameter.html @@ -0,0 +1,143 @@ +<?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>set_flags</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="configuration_reference.html" title="Appendix D. DB_CONFIG Parameter Reference" /> + <link rel="prev" href="set_create_dir_parameter.html" title="set_create_dir" /> + <link rel="next" href="set_intermediate_dir_mode_parameter.html" title="set_intermediate_dir_mode" /> + </head> + <body> + <div xmlns="" class="navheader"> + <div class="libver"> + <p>Library Version 11.2.5.3</p> + </div> + <table width="100%" summary="Navigation header"> + <tr> + <th colspan="3" align="center">set_flags</th> + </tr> + <tr> + <td width="20%" align="left"><a accesskey="p" href="set_create_dir_parameter.html">Prev</a> </td> + <th width="60%" align="center">Appendix D. DB_CONFIG Parameter Reference</th> + <td width="20%" align="right"> <a accesskey="n" href="set_intermediate_dir_mode_parameter.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="set_flags_parameter"></a>set_flags</h2> + </div> + </div> + </div> + <p> + Configures a database environment. + </p> + <p> + The syntax of the entry in the <a href="../../programmer_reference/env_db_config.html#env_db_config.DB_CONFIG" class="olink">DB_CONFIG</a> file is a single + line with the string <code class="literal">set_flags</code>, one or + more whitespace characters, the method flag parameter as a + string, optionally one or more whitespace characters, and + the string <code class="literal">on</code> or <code class="literal">off</code>. + If the optional string is omitted, the default is + <code class="literal">on</code>; for example, + <code class="literal">set_flags DB_TXN_NOSYNC</code> or + <code class="literal">set_flags DB_TXN_NOSYNC on</code>. Because the + DB_CONFIG file is read when the database environment is + opened, it will silently overrule configuration done before + that time. + </p> + <p> + The method flag parameters are as follows: + </p> + <div class="itemizedlist"> + <ul type="disc"> + <li> + DB_AUTO_COMMIT + <p> + Enables/disables to automatically enclose those DB handle operations for which no explicit transaction handle was specified, and + which modify databases in the database environment, within a transaction. + </p></li> + <li> + DB_CDB_ALLDB + <p>Enables/disables Berkeley DB Concurrent Data Store applications to perform locking on an + environment-wide basis rather than on a per-database basis.</p></li> + <li> + DB_DIRECT_DB + <p>Enables/disables turning off system buffering of Berkeley DB database files to avoid double caching.</p></li> + <li> + DB_DSYNC_DB + <p>Enables/disables configuring Berkeley DB to flush database writes to the backing disk before returning + from the write system call, rather than flushing database writes explicitly in a separate + system call, as necessary.</p></li> + <li> + DB_MULTIVERSION + <p>Enables/disables all databases in the environment from being opened as if DB_MULTIVERSION is passed to + the DB->open method. This flag will be ignored for queue databases for which + DB_MULTIVERSION is not supported.</p></li> + <li> + DB_NOMMAP + <p>Enables/disables Berkeley DB from copying read-only database files into the local cache instead of + potentially mapping them into process memory.</p></li> + <li> + DB_REGION_INIT + <p>Enables/disables Berkeley DB to page-fault shared regions into memory when initially creating or joining a Berkeley DB + environment. In addition, Berkeley DB will write the shared regions when creating an + environment, forcing the underlying virtual memory and filesystems to instantiate both + the necessary memory and the necessary disk space.</p></li> + <li> + DB_TIME_NOTGRANTED + <p>Enables/disables those database calls timing out based on lock or transaction timeout values to return + DB_LOCK_NOTGRANTED instead of DB_LOCK_DEADLOCK. This allows applications to + distinguish between operations which have deadlocked and operations which have exceeded + their time limits.</p></li> + <li> + DB_TXN_NOSYNC + <p>Enables/disables Berkeley DB to not write or synchronously flush the log on transaction commit.</p></li> + <li> + DB_TXN_NOWAIT + <p>Enables/disables the operation to return DB_LOCK_DEADLOCK if a lock is unavailable for any Berkeley DB operation performed in the context of a + transaction.</p></li> + <li> + DB_TXN_SNAPSHOT + <p>Enables/disables all transactions in the environment to be started as if DB_TXN_SNAPSHOT were + passed to the DB_ENV->txn_begin method, and all non-transactional cursors + to be opened as if DB_TXN_SNAPSHOT were passed to the DB->cursor method.</p></li> + <li> + DB_TXN_WRITE_NOSYNC + <p>Enables/disables Berkeley DB to write, but not synchronously flush, the log on transaction + commit.</p></li> + <li> + DB_YIELDCPU + <p>Enables/disables Berkeley DB to yield the processor immediately after each page or mutex acquisition.</p></li> + </ul> + </div> + <p> For more information, see <a class="xref" href="envset_flags.html" title="DB_ENV->set_flags()">DB_ENV->set_flags()</a>.</p> + </div> + <div class="navfooter"> + <hr /> + <table width="100%" summary="Navigation footer"> + <tr> + <td width="40%" align="left"><a accesskey="p" href="set_create_dir_parameter.html">Prev</a> </td> + <td width="20%" align="center"> + <a accesskey="u" href="configuration_reference.html">Up</a> + </td> + <td width="40%" align="right"> <a accesskey="n" href="set_intermediate_dir_mode_parameter.html">Next</a></td> + </tr> + <tr> + <td width="40%" align="left" valign="top">set_create_dir </td> + <td width="20%" align="center"> + <a accesskey="h" href="index.html">Home</a> + </td> + <td width="40%" align="right" valign="top"> set_intermediate_dir_mode</td> + </tr> + </table> + </div> + </body> +</html> |