diff options
| author | Lorry Tar Creator <lorry-tar-importer@baserock.org> | 2015-02-17 17:25:57 +0000 |
|---|---|---|
| committer | <> | 2015-03-17 16:26:24 +0000 |
| commit | 780b92ada9afcf1d58085a83a0b9e6bc982203d1 (patch) | |
| tree | 598f8b9fa431b228d29897e798de4ac0c1d3d970 /docs/programmer_reference/am.html | |
| parent | 7a2660ba9cc2dc03a69ddfcfd95369395cc87444 (diff) | |
| download | berkeleydb-master.tar.gz | |
Diffstat (limited to 'docs/programmer_reference/am.html')
| -rw-r--r-- | docs/programmer_reference/am.html | 129 |
1 files changed, 74 insertions, 55 deletions
diff --git a/docs/programmer_reference/am.html b/docs/programmer_reference/am.html index e866ee8c..394f61a8 100644 --- a/docs/programmer_reference/am.html +++ b/docs/programmer_reference/am.html @@ -14,13 +14,11 @@ <body> <div xmlns="" class="navheader"> <div class="libver"> - <p>Library Version 11.2.5.3</p> + <p>Library Version 12.1.6.1</p> </div> <table width="100%" summary="Navigation header"> <tr> - <th colspan="3" align="center">Chapter 3. - Access Method Operations - </th> + <th colspan="3" align="center">Chapter 3. Access Method Operations </th> </tr> <tr> <td width="20%" align="left"><a accesskey="p" href="rq_conf.html">Prev</a> </td> @@ -34,9 +32,7 @@ <div class="titlepage"> <div> <div> - <h2 class="title"><a id="am"></a>Chapter 3. - Access Method Operations - </h2> + <h2 class="title"><a id="am"></a>Chapter 3. Access Method Operations </h2> </div> </div> </div> @@ -52,24 +48,25 @@ </dt> <dt> <span class="sect1"> - <a href="am_opensub.html">Opening multiple databases in a single file</a> + <a href="am_opensub.html">Opening multiple databases in a + single file</a> </span> </dt> <dd> <dl> <dt> <span class="sect2"> - <a href="am_opensub.html#idp724392">Configuring databases sharing a file</a> + <a href="am_opensub.html#idm1925008">Configuring databases sharing a file</a> </span> </dt> <dt> <span class="sect2"> - <a href="am_opensub.html#idp768720">Caching databases sharing a file</a> + <a href="am_opensub.html#idm148416">Caching databases sharing a file</a> </span> </dt> <dt> <span class="sect2"> - <a href="am_opensub.html#idp769416">Locking in databases based on sharing a file</a> + <a href="am_opensub.html#idm548184">Locking in databases based on sharing a file</a> </span> </dt> </dl> @@ -83,17 +80,20 @@ <dl> <dt> <span class="sect2"> - <a href="am_partition.html#am_partition_keys">Specifying partition keys</a> + <a href="am_partition.html#am_partition_keys">Specifying partition + keys</a> </span> </dt> <dt> <span class="sect2"> - <a href="am_partition.html#am_partition_function">Partitioning callback</a> + <a href="am_partition.html#am_partition_function">Partitioning + callback</a> </span> </dt> <dt> <span class="sect2"> - <a href="am_partition.html#partition_file_placement">Placing partition files</a> + <a href="am_partition.html#partition_file_placement">Placing partition + files</a> </span> </dt> </dl> @@ -130,7 +130,8 @@ </dt> <dt> <span class="sect1"> - <a href="am_verify.html">Database verification and salvage</a> + <a href="am_verify.html">Database verification and + salvage</a> </span> </dt> <dt> @@ -152,7 +153,7 @@ <dl> <dt> <span class="sect2"> - <a href="am_second.html#idp863384">Error Handling With Secondary Indexes</a> + <a href="am_second.html#idp382496">Error Handling With Secondary Indexes</a> </span> </dt> </dl> @@ -171,7 +172,8 @@ <dl> <dt> <span class="sect2"> - <a href="am_cursor.html#am_curget">Retrieving records with a cursor</a> + <a href="am_cursor.html#am_curget">Retrieving records with a + cursor</a> </span> </dt> <dt> @@ -208,21 +210,33 @@ </dd> </dl> </div> - <p>Once a database handle has been created using <a href="../api_reference/C/dbcreate.html" class="olink">db_create()</a>, there -are several standard access method operations. Each of these operations -is performed using a method referred to by the returned handle. -Generally, the database will be opened using <a href="../api_reference/C/dbopen.html" class="olink">DB->open()</a>. If the -database is from an old release of Berkeley DB, it may need to be upgraded to -the current release before it is opened using <a href="../api_reference/C/dbupgrade.html" class="olink">DB->upgrade()</a>.</p> - <p>Once a database has been opened, records may be retrieved (<a href="../api_reference/C/dbget.html" class="olink">DB->get()</a>), -stored (<a href="../api_reference/C/dbput.html" class="olink">DB->put()</a>), and deleted (<a href="../api_reference/C/dbdel.html" class="olink">DB->del()</a>).</p> - <p>Additional operations supported by the database handle include -statistics (<a href="../api_reference/C/dbstat.html" class="olink">DB->stat()</a>), truncation (<a href="../api_reference/C/dbtruncate.html" class="olink">DB->truncate()</a>), -version upgrade (<a href="../api_reference/C/dbupgrade.html" class="olink">DB->upgrade()</a>), verification and salvage -(<a href="../api_reference/C/dbverify.html" class="olink">DB->verify()</a>), flushing to a backing file (<a href="../api_reference/C/dbsync.html" class="olink">DB->sync()</a>), -and association of secondary indices (<a href="../api_reference/C/dbassociate.html" class="olink">DB->associate()</a>). Database -handles are eventually closed using <a href="../api_reference/C/dbclose.html" class="olink">DB->close()</a>.</p> - <p>For more information on the access method operations supported by the database handle, see the <a href="../api_reference/C/db.html#dblist" class="olink">Database and Related Methods</a> section in the <em class="citetitle">Berkeley DB C API Reference Guide.</em> </p> + <p> + Once a database handle has been created using <a href="../api_reference/C/dbcreate.html" class="olink">db_create()</a>, + there are several standard access method operations. Each of + these operations is performed using a method referred to by + the returned handle. Generally, the database will be opened + using <a href="../api_reference/C/dbopen.html" class="olink">DB->open()</a>. If the database is from an old release of + Berkeley DB, it may need to be upgraded to the current release + before it is opened using <a href="../api_reference/C/dbupgrade.html" class="olink">DB->upgrade()</a>. + </p> + <p> + Once a database has been opened, records may be retrieved + (<a href="../api_reference/C/dbget.html" class="olink">DB->get()</a>), stored (<a href="../api_reference/C/dbput.html" class="olink">DB->put()</a>), and deleted (<a href="../api_reference/C/dbdel.html" class="olink">DB->del()</a>). + </p> + <p> + Additional operations supported by the database handle + include statistics (<a href="../api_reference/C/dbstat.html" class="olink">DB->stat()</a>), truncation (<a href="../api_reference/C/dbtruncate.html" class="olink">DB->truncate()</a>), + version upgrade (<a href="../api_reference/C/dbupgrade.html" class="olink">DB->upgrade()</a>), verification and salvage + (<a href="../api_reference/C/dbverify.html" class="olink">DB->verify()</a>), flushing to a backing file (<a href="../api_reference/C/dbsync.html" class="olink">DB->sync()</a>), and + association of secondary indices (<a href="../api_reference/C/dbassociate.html" class="olink">DB->associate()</a>). Database + handles are eventually closed using <a href="../api_reference/C/dbclose.html" class="olink">DB->close()</a>. + </p> + <p> + For more information on the access method operations + supported by the database handle, see the <a href="../api_reference/C/db.html#dblist" class="olink">Database and Related + Methods</a> section in the + <em class="citetitle">Berkeley DB C API Reference Guide.</em> + </p> <div class="sect1" lang="en" xml:lang="en"> <div class="titlepage"> <div> @@ -232,7 +246,8 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl </div> </div> <p> - The <a href="../api_reference/C/dbopen.html" class="olink">DB->open()</a> method opens a database, and takes five arguments: + The <a href="../api_reference/C/dbopen.html" class="olink">DB->open()</a> method opens a database, and takes five + arguments: </p> <div class="variablelist"> <dl> @@ -240,7 +255,7 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl <span class="term">file</span> </dt> <dd> - The name of the file to be opened. + The name of the file to be opened. </dd> <dt> <span class="term">database</span> @@ -251,23 +266,24 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl <dt> <span class="term">type</span> </dt> - <dd> - The type of database to open. This value will be one of - the five access methods Berkeley DB supports: DB_BTREE, - DB_HASH, DB_HEAP, DB_QUEUE or DB_RECNO, or the special - value DB_UNKNOWN, which allows you to open an existing file - without knowing its type. + <dd> + The type of database to open. This value will + be one of the five access methods Berkeley DB + supports: DB_BTREE, DB_HASH, DB_HEAP, DB_QUEUE or + DB_RECNO, or the special value DB_UNKNOWN, which + allows you to open an existing file without knowing + its type. </dd> <dt> <span class="term">mode</span> </dt> - <dd> + <dd> The permissions to give to any created file. </dd> </dl> </div> - <p> - There are a few flags that you can set to customize open: + <p> + There are a few flags that you can set to customize open: </p> <div class="variablelist"> <dl> @@ -276,8 +292,9 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl <a href="../api_reference/C/dbopen.html#open_DB_CREATE" class="olink">DB_CREATE</a> </span> </dt> - <dd> - Create the underlying database and any necessary physical files. + <dd> + Create the underlying database and any + necessary physical files. </dd> <dt> <span class="term"> @@ -301,8 +318,9 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl </span> </dt> <dd> - The returned handle is free-threaded, that is, it can be - used simultaneously by multiple threads within the process. + The returned handle is free-threaded, that is, + it can be used simultaneously by multiple threads + within the process. </dd> <dt> <span class="term"> @@ -310,19 +328,19 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl </span> </dt> <dd> - Physically truncate the underlying database file, - discarding all databases it contained. Underlying - filesystem primitives are used to implement this flag. For - this reason it is only applicable to the physical file and - cannot be used to discard individual databases from within - physical files. + Physically truncate the underlying database + file, discarding all databases it contained. + Underlying filesystem primitives are used to implement + this flag. For this reason it is only applicable to + the physical file and cannot be used to discard + individual databases from within physical files. </dd> <dt> <span class="term"> <a href="../api_reference/C/dbset_feedback.html#set_feedback_DB_UPGRADE" class="olink">DB_UPGRADE</a> </span> </dt> - <dd> + <dd> Upgrade the database format as necessary. </dd> </dl> @@ -342,7 +360,8 @@ handles are eventually closed using <a href="../api_reference/C/dbclose.html" cl <td width="20%" align="center"> <a accesskey="h" href="index.html">Home</a> </td> - <td width="40%" align="right" valign="top"> Opening multiple databases in a single file</td> + <td width="40%" align="right" valign="top"> Opening multiple databases in a + single file</td> </tr> </table> </div> |