diff options
Diffstat (limited to 'db/docs/api_tcl')
32 files changed, 345 insertions, 375 deletions
diff --git a/db/docs/api_tcl/db_close.html b/db/docs/api_tcl/db_close.html index 37218fb33..bffb7b3c3 100644 --- a/db/docs/api_tcl/db_close.html +++ b/db/docs/api_tcl/db_close.html @@ -1,24 +1,23 @@ <!--$Id: db_close.so,v 11.15 2002/08/18 21:17:23 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db close</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>close</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db close @@ -31,8 +30,8 @@ any underlying files. Because key/data pairs are cached in memory, failing to sync the file with the <i>db</i> <b>close</b> or <i>db</i> <b>sync</b> command may result in inconsistent or lost information.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-nosync<dd>Do not flush cached information to disk. +<dl compact> +<dt>-nosync<dd>Do not flush cached information to disk. <p>The -nosync flag is a dangerous option. It should only be set 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 @@ -56,6 +55,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_count.html b/db/docs/api_tcl/db_count.html index 4224c7a49..f90469ef0 100644 --- a/db/docs/api_tcl/db_count.html +++ b/db/docs/api_tcl/db_count.html @@ -1,24 +1,23 @@ <!--$Id: db_count.so,v 11.4 2002/08/18 21:17:24 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db count</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>count</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db count key @@ -34,6 +33,6 @@ Tcl error is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_cursor.html b/db/docs/api_tcl/db_cursor.html index bc96bcd55..d406641e0 100644 --- a/db/docs/api_tcl/db_cursor.html +++ b/db/docs/api_tcl/db_cursor.html @@ -1,24 +1,23 @@ <!--$Id: db_cursor.so,v 11.13 2002/08/18 21:17:25 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db cursor</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>cursor</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db cursor @@ -31,8 +30,8 @@ where X is an integer starting at 0 (for example, db0.c0 and db0.c1). It is through this Tcl command that the script accesses the cursor methods.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-txn txnid<dd>If the operation is to be +<dl compact> +<dt>-txn txnid<dd>If the operation is to be transaction-protected, the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -42,6 +41,6 @@ the <b>txnid</b> parameter is a transaction handle returned from <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_del.html b/db/docs/api_tcl/db_del.html index 3aacca5d3..a89fb935a 100644 --- a/db/docs/api_tcl/db_del.html +++ b/db/docs/api_tcl/db_del.html @@ -1,24 +1,23 @@ <!--$Id: db_del.so,v 11.14 2002/08/18 21:17:25 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db del</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>del</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db del @@ -32,15 +31,15 @@ <p>In the presence of duplicate key values, all records associated with the designated key will be discarded.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. -<p><dt>-glob<dd>The specified key is a wildcard pattern, and all keys matching that +<dt>-glob<dd>The specified key is a wildcard pattern, and all keys matching that pattern are discarded from the database. The pattern is a simple wildcard, any characters after the wildcard character are ignored. This option only works on databases using the Btree access method. -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected (other than by specifying the -auto_commit flag), the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -51,6 +50,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_get.html b/db/docs/api_tcl/db_get.html index 8b5610c76..e10870e93 100644 --- a/db/docs/api_tcl/db_get.html +++ b/db/docs/api_tcl/db_get.html @@ -1,24 +1,23 @@ <!--$Id: db_get.so,v 11.19 2002/11/14 21:07:39 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db get</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>get</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db get @@ -44,23 +43,23 @@ db get duplicate items. Duplicates are sorted by insert order except where this order has been overridden by cursor operations.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. This option may only be specified with the <b>-consume</b> or <b>-consume_wait</b> flags. -<p><dt>-consume<dd>Return the record number and data from the available record closest to +<dt>-consume<dd>Return the record number and data from the available record closest to the head of the queue, and delete the record. The cursor will be positioned on the deleted record. A record is available if it is not deleted and is not currently locked. The underlying database must be of type Queue for <b>-consume</b> to be specified. -<p><dt>-consume_wait<dd>The same as the <b>-consume</b> flag except that if the Queue database +<dt>-consume_wait<dd>The same as the <b>-consume</b> flag except that if the Queue database is empty, the thread of control will wait until there is data in the queue before returning. The underlying database must be of type Queue for <b>-consume_wait</b> to be specified. -<p><dt>-get_both key data<dd>Retrieve the key/data pair only if both the key and data match the +<dt>-get_both key data<dd>Retrieve the key/data pair only if both the key and data match the arguments. -<p><dt>-glob<dd>Return all keys matching the given key, where the key is a simple +<dt>-glob<dd>Return all keys matching the given key, where the key is a simple wildcard pattern. Where it is used, it replaces the use of the key with the given pattern of a set of keys. Any characters after the wildcard character are ignored. For example, in a database of last names, the @@ -69,15 +68,15 @@ database, and the command "db0 get -glob Jo*" will return both "Jones" and "Johnson" from the database. The command "db0 get -glob *" will return all of the key/data pairs in the database. This option only works on databases using the Btree access method. -<p><dt>-partial {doff dlen}<dd>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning +<dt>-partial {doff dlen}<dd>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning of the retrieved data record are returned as if they comprised the entire record. If any or all of the specified bytes do not exist in the record, the command is successful and any existing bytes are returned. -<p><dt>-recno<dd>Retrieve the specified numbered key/data pair from a database. For +<dt>-recno<dd>Retrieve the specified numbered key/data pair from a database. For <b>-recno</b> to be specified, the specified key must be a record number; and the underlying database must be of type Recno or Queue, or of type Btree that was created with the <b>-recnum</b> option. -<p><dt>-rmw<dd>Acquire write locks instead of read locks when doing the retrieval. +<dt>-rmw<dd>Acquire write locks instead of read locks when doing the retrieval. Setting this flag may decrease the likelihood of deadlock during a read-modify-write cycle by immediately acquiring the write lock during the read part of the cycle so that another thread of control acquiring a @@ -87,7 +86,7 @@ result in deadlock. interface calls in nontransactional environments, the <b>-rmw</b> argument to the <i>db</i> <b>get</b> call is only meaningful in the presence of transactions.</p> -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected, the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -103,6 +102,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_get_join.html b/db/docs/api_tcl/db_get_join.html index 3b8c04043..f15024428 100644 --- a/db/docs/api_tcl/db_get_join.html +++ b/db/docs/api_tcl/db_get_join.html @@ -1,24 +1,23 @@ <!--$Id: db_get_join.so,v 11.18 2002/08/18 21:17:25 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db get_join</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>get_join</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db get_join @@ -33,8 +32,8 @@ join the specified keys and returns a list of joined {key data} pairs. See <a href="../ref/am/join.html">Equality join</a> for more information on the underlying requirements for joining.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-txn txnid<dd>If the operation is to be +<dl compact> +<dt>-txn txnid<dd>If the operation is to be transaction-protected, the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -44,6 +43,6 @@ the <b>txnid</b> parameter is a transaction handle returned from <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_get_type.html b/db/docs/api_tcl/db_get_type.html index fa01c3249..25a19ef2b 100644 --- a/db/docs/api_tcl/db_get_type.html +++ b/db/docs/api_tcl/db_get_type.html @@ -1,24 +1,23 @@ <!--$Id: db_get_type.so,v 11.11 2002/08/18 21:17:25 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db get_type</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>get_type</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db get_type @@ -31,6 +30,6 @@ returning one of "btree", "hash", "queue" or "recno".</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_is_byteswapped.html b/db/docs/api_tcl/db_is_byteswapped.html index d73927c51..c884a98b3 100644 --- a/db/docs/api_tcl/db_is_byteswapped.html +++ b/db/docs/api_tcl/db_is_byteswapped.html @@ -1,24 +1,23 @@ <!--$Id: db_is_byteswapped.so,v 11.15 2003/10/13 19:57:26 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db is_byteswapped</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>is_byteswapped</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db is_byteswapped @@ -35,6 +34,6 @@ or not.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_join.html b/db/docs/api_tcl/db_join.html index bd1e7bc6b..686914dcb 100644 --- a/db/docs/api_tcl/db_join.html +++ b/db/docs/api_tcl/db_join.html @@ -1,24 +1,23 @@ <!--$Id: db_join.so,v 11.22 2002/08/18 21:17:26 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db join</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>join</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db join @@ -45,6 +44,6 @@ been created within the same transaction.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_open.html b/db/docs/api_tcl/db_open.html index 3d273ab44..dfd3828b5 100644 --- a/db/docs/api_tcl/db_open.html +++ b/db/docs/api_tcl/db_open.html @@ -1,24 +1,23 @@ <!--$Id: db_open.so,v 11.33 2003/05/09 20:07:57 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: berkdb open</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><b>berkdb open</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>berkdb open @@ -59,22 +58,22 @@ The returned database handle is bound to a Tcl command of the form db1). It is through this Tcl command that the script accesses the database methods.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. -<p><dt>-btree<dd>Open/create a database of type Btree. The Btree format +<dt>-btree<dd>Open/create a database of type Btree. The Btree format is a representation of a sorted, balanced tree structure. -<p><dt>-hash<dd>Open/create a database of type Hash. The Hash format is +<dt>-hash<dd>Open/create a database of type Hash. The Hash format is an extensible, dynamic hashing scheme. -<p><dt>-queue<dd>Open/create a database of type Queue. The Queue format +<dt>-queue<dd>Open/create a database of type Queue. The Queue format supports fast access to fixed-length records accessed by sequentially or logical record number. -<p><dt>-recno<dd>Open/create a database of type Recno. The Recno format +<dt>-recno<dd>Open/create a database of type Recno. The Recno format supports fixed- or variable-length records, accessed sequentially or by logical record number, and optionally retrieved from a flat text file. -<p><dt>-unknown<dd>The database is of an unknown type, and must already exist. -<p><dt>-cachesize {gbytes bytes ncache}<dd>Set the size of the database's shared memory buffer pool (that is, the +<dt>-unknown<dd>The database is of an unknown type, and must already exist. +<dt>-cachesize {gbytes bytes ncache}<dd>Set the size of the database's shared memory buffer pool (that is, the cache), to <b>gbytes</b> gigabytes plus <b>bytes</b>. The cache should be the size of the normal working data set of the application, with some small amount of additional memory for unusual situations. @@ -96,35 +95,35 @@ separate pieces of memory.</p> <p>Because databases opened within Berkeley DB environments use the cache specified to the environment, it is an error to attempt to set a cache in a database created within an environment.</p> -<p><dt>-create<dd>Create any underlying files, as necessary. If the files do not already +<dt>-create<dd>Create any underlying files, as necessary. If the files do not already exist and the <b>-create</b> argument is not specified, the call will fail. -<p><dt>-delim delim<dd>Set the delimiting byte used to mark the end of a record in the backing +<dt>-delim delim<dd>Set the delimiting byte used to mark the end of a record in the backing source file for the Recno access method. <p>This byte is used for variable length records if the <b>-source</b> argument file is specified. If the <b>-source</b> argument file is specified and no delimiting byte was specified, <newline> characters (that is, ASCII 0x0a) are interpreted as end-of-record markers.</p> -<p><dt>-dup<dd>Permit duplicate data items in the tree, that is, insertion when the +<dt>-dup<dd>Permit duplicate data items in the tree, that is, insertion when the key of the key/data pair being inserted already exists in the tree will be successful. The ordering of duplicates in the tree is determined by the order of insertion unless the ordering is otherwise specified by use of a cursor or a duplicate comparison function. <p>error to specify both <b>-dup</b> and <b>-recnum</b>.</p> -<p><dt>-dupsort<dd>Sort duplicates within a set of data items. A default lexical +<dt>-dupsort<dd>Sort duplicates within a set of data items. A default lexical comparison will be used. Specifying that duplicates are to be sorted changes the behavior of the <i>db</i> <b>put</b> operation as well as the <i>dbc</i> <b>put</b> operation when the <b>-keyfirst</b>, <b>-keylast</b> and <b>-current</b> options are specified. -<p><dt>-encrypt<dd>Specify the database in an environment should be encrypted with the +<dt>-encrypt<dd>Specify the database in an environment should be encrypted with the same password that is being used in the environment. -<p><dt>-encryptaes passwd<dd>Specify the database should be encrypted with the given password +<dt>-encryptaes passwd<dd>Specify the database should be encrypted with the given password using the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm. -<p><dt>-encryptany passwd<dd>Specify the already existing database should be opened +<dt>-encryptany passwd<dd>Specify the already existing database should be opened with the given password. This option is used if the database is known to be encrypted, but the specific algorithm used is not known. -<p><dt>-env env<dd>If no <b>-env</b> argument is given, the database is standalone; that +<dt>-env env<dd>If no <b>-env</b> argument is given, the database is standalone; that is, it is not part of any Berkeley DB environment. <p>If a <b>-env</b> argument is given, the database is created within the specified Berkeley DB environment. The database access methods automatically @@ -132,7 +131,7 @@ make calls to the other subsystems in Berkeley DB, based on the enclosing environment. For example, if the environment has been configured to use locking, the access methods will automatically acquire the correct locks when reading and writing pages of the database.</p> -<p><dt>-errfile filename<dd><p>When an error occurs in the Berkeley DB library, a Berkeley DB error or an error +<dt>-errfile filename<dd><p>When an error occurs in the Berkeley DB library, a Berkeley DB error or an error return value is returned by the function. In some cases, however, the errno value may be insufficient to completely describe the cause of the error especially during initial application debugging.</p> @@ -152,17 +151,17 @@ as during application debugging.</p> <p>For database handles opened inside of Berkeley DB environments, specifying the <b>-errfile</b> argument affects the entire environment and is equivalent to specifying the same argument to the <b>berkdb env</b> command.</p> -<p><dt>-excl<dd>Return an error if the database already exists. -<p><dt>-extent size<dd>Set the size of the extents of the Queue database; the size is specified +<dt>-excl<dd>Return an error if the database already exists. +<dt>-extent size<dd>Set the size of the extents of the Queue database; the size is specified as the number of pages in an extent. Each extent is created as a separate physical file. If no extent size is set, the default behavior is to create only a single underlying database file. <p>For information on tuning the extent size, see <a href="../ref/am_conf/extentsize.html">Selecting a extent size</a>.</p> -<p><dt>-ffactor density<dd>Set the desired density within the hash table. +<dt>-ffactor density<dd>Set the desired density within the hash table. <p>The density is an approximation of the number of keys allowed to accumulate in any one bucket -<p><dt>-len len<dd>For the Queue access method, specify that the records are of length +<dt>-len len<dd>For the Queue access method, specify that the records are of length <b>len</b>. <p>For the Recno access method, specify that the records are fixed-length, not byte-delimited, and are of length <b>len</b>.</p> @@ -172,32 +171,32 @@ information).</p> <p>Any attempt to insert records into the database that are greater than <b>len</b> bytes long will cause the call to fail immediately and return an error.</p> -<p><dt>-mode mode<dd><p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by the access methods +<dt>-mode mode<dd><p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by the access methods are created with mode <b>mode</b> (as described in <b>chmod</b>(2)) and modified by the process' umask value at the time of creation (see <b>umask</b>(2)). The group ownership of created files is based on the system and directory defaults, and is not further specified by Berkeley DB. If <b>mode</b> is 0, files are created readable and writable by both owner and group. On Windows systems, the mode argument is ignored.</p> -<p><dt>-nelem size<dd>Set an estimate of the final size of the hash table. +<dt>-nelem size<dd>Set an estimate of the final size of the hash table. <p>If not set or set too low, hash tables will still expand gracefully as keys are entered, although a slight performance degradation may be noticed.</p> -<p><dt>-pad pad<dd>Set the padding character for short, fixed-length records for the Queue +<dt>-pad pad<dd>Set the padding character for short, fixed-length records for the Queue and Recno access methods. <p>If no pad character is specified, <space> characters (that is, ASCII 0x20) are used for padding.</p> -<p><dt>-pagesize pagesize<dd>Set the size of the pages used to hold items in the database, in bytes. +<dt>-pagesize pagesize<dd>Set the size of the pages used to hold items in the database, in bytes. The minimum page size is 512 bytes, and the maximum page size is 64K bytes. If the page size is not explicitly set, one is selected based on the underlying filesystem I/O block size. The automatically selected size has a lower limit of 512 bytes and an upper limit of 16K bytes. <p>For information on tuning the Berkeley DB page size, see <a href="../ref/am_conf/pagesize.html">Selecting a page size</a>.</p> -<p><dt>-rdonly<dd>Open the database for reading only. Any attempt to modify items in the +<dt>-rdonly<dd>Open the database for reading only. Any attempt to modify items in the database will fail, regardless of the actual permissions of any underlying files. -<p><dt>-recnum<dd>Support retrieval from the Btree using record numbers. +<dt>-recnum<dd>Support retrieval from the Btree using record numbers. <p>Logical record numbers in Btree databases are mutable in the face of record insertion or deletion. See the <b>-renumber</b> argument for further discussion.</p> @@ -208,7 +207,7 @@ deletions, effectively single-threading the tree for those operations. Specifying <b>-recnum</b> can result in serious performance degradation for some applications and data sets.</p> <p>It is an error to specify both <b>-dup</b> and <b>-recnum</b>.</p> -<p><dt>-renumber<dd>Specifying the <b>-renumber</b> argument causes the logical record +<dt>-renumber<dd>Specifying the <b>-renumber</b> argument causes the logical record numbers to be mutable, and change as records are added to and deleted from the database. For example, the deletion of record number 4 causes records numbered 5 and greater to be renumbered downward by one. If a cursor was @@ -231,10 +230,10 @@ logical record, continuing to refer to the same record as it did before.</p> <p>For these reasons, concurrent access to a Recno database with the <b>-renumber</b> flag specified may be largely meaningless, although it is supported.</p> -<p><dt>-snapshot<dd>This argument specifies that any specified <b>-source</b> file be read +<dt>-snapshot<dd>This argument specifies that any specified <b>-source</b> file be read in its entirety when the database is opened. If this argument is not specified, the <b>-source</b> file may be read lazily. -<p><dt>-source file<dd>Set the underlying source file for the Recno access method. The purpose +<dt>-source file<dd>Set the underlying source file for the Recno access method. The purpose of the <b>-source</b> file is to provide fast access and modification to databases that are normally stored as flat text files. <p>If the <b>-source</b> argument is give, it specifies an underlying flat @@ -279,20 +278,20 @@ they will be silently discarded.</p> used to specify databases that are read-only for Berkeley DB applications, and that are either generated on the fly by software tools, or modified using a different mechanism such as a text editor.</p> -<p><dt>-truncate<dd>Physically truncate the underlying file, discarding all previous databases +<dt>-truncate<dd>Physically truncate the underlying file, discarding all previous databases it might have held. 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 databases within a file. <p>The <b>-truncate</b> argument cannot be transaction-protected, and it is an error to specify it in a transaction-protected environment.</p> -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected (other than by specifying the -auto_commit flag), the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. -<p><dt>--<dd>Mark the end of the command arguments. -<p><dt>file<dd>The name of a single physical file on disk that will be used to back the +<dt>--<dd>Mark the end of the command arguments. +<dt>file<dd>The name of a single physical file on disk that will be used to back the database. -<p><dt>database<dd>The <b>database</b> argument allows applications to have multiple +<dt>database<dd>The <b>database</b> argument allows applications to have multiple databases inside of a single physical file. This is useful when the databases are both numerous and reasonably small, in order to avoid creating a large number of underlying files. It is an error to attempt @@ -309,6 +308,6 @@ file</a> for more information.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_put.html b/db/docs/api_tcl/db_put.html index 48b5e245b..17cd05c4d 100644 --- a/db/docs/api_tcl/db_put.html +++ b/db/docs/api_tcl/db_put.html @@ -1,24 +1,23 @@ <!--$Id: db_put.so,v 11.13 2002/08/18 21:17:26 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db put</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>put</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db put @@ -38,17 +37,17 @@ db put <p>The <i>db</i> <b>put</b> command stores the specified key/data pair into the database.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. -<p><dt>-append<dd>Append the data item to the end of the database. For the <b>-append</b> +<dt>-append<dd>Append the data item to the end of the database. For the <b>-append</b> option to be specified, the underlying database must be a Queue or Recno database. The record number allocated to the record is returned on success. -<p><dt>-nooverwrite<dd>Enter the new key/data pair only if the key does not already appear in +<dt>-nooverwrite<dd>Enter the new key/data pair only if the key does not already appear in the database. -<p><dt>-partial {doff dlen}<dd><p>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning +<dt>-partial {doff dlen}<dd><p>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning of the specified key's data record are replaced by the data specified by the data and size structure elements. If <b>dlen</b> is smaller than the length of the supplied data, the record will grow; if @@ -57,11 +56,11 @@ will shrink. If the specified bytes do not exist, the record will be extended using nul bytes as necessary, and the <i>db</i> <b>put</b> call will succeed. <p>It is an error to attempt a partial put using the <i>db</i> <b>put</b> command in a database that supports duplicate records. Partial puts in databases supporting -duplicate records must be done using a <i>dbc</i> <b>put</b> command.</p></p> +duplicate records must be done using a <i>dbc</i> <b>put</b> command.</p> <p>It is an error to attempt a partial put with differing <b>dlen</b> and supplied data length values in Queue or Recno databases with fixed-length records.</p> -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected (other than by specifying the -auto_commit flag), the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -77,6 +76,6 @@ types, the key is interpreted by Tcl as a byte array.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_remove.html b/db/docs/api_tcl/db_remove.html index 2282179ec..a7d8a79e5 100644 --- a/db/docs/api_tcl/db_remove.html +++ b/db/docs/api_tcl/db_remove.html @@ -1,24 +1,23 @@ <!--$Id: db_remove.so,v 11.12 2002/09/26 17:34:02 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: berkdb dbremove</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><b>berkdb dbremove</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>berkdb dbremove @@ -38,18 +37,18 @@ removing all databases that it contained.</p> <p>No reference count of database use is maintained by Berkeley DB. Applications should not remove databases that are currently in use.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-encrypt<dd>Specify the database in an environment is encrypted with the +<dl compact> +<dt>-encrypt<dd>Specify the database in an environment is encrypted with the same password that is being used in the environment. -<p><dt>-encryptaes passwd<dd>Specify the database is encrypted with the given password +<dt>-encryptaes passwd<dd>Specify the database is encrypted with the given password using the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm. -<p><dt>-encryptany passwd<dd>Specify the already existing database is encrypted +<dt>-encryptany passwd<dd>Specify the already existing database is encrypted with the given password. This option is used if the database is known to be encrypted, but the specific algorithm used is not known. -<p><dt>-env env<dd>If a <b>-env</b> argument is given, the database in the specified Berkeley DB +<dt>-env env<dd>If a <b>-env</b> argument is given, the database in the specified Berkeley DB environment is removed. -<p><dt>--<dd>Mark the end of the command arguments. +<dt>--<dd>Mark the end of the command arguments. </dl> <p>The <b>berkdb dbremove</b> command returns 0 on success, and in the case of error, a Tcl error is thrown.</p> @@ -57,6 +56,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_rename.html b/db/docs/api_tcl/db_rename.html index f161437a6..13a2aa2a4 100644 --- a/db/docs/api_tcl/db_rename.html +++ b/db/docs/api_tcl/db_rename.html @@ -1,24 +1,23 @@ <!--$Id: db_rename.so,v 11.7 2002/09/26 17:34:02 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: berkdb dbrename</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><b>berkdb dbrename</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>berkdb rename @@ -39,18 +38,18 @@ the physical file represented by <b>file</b> is renamed.</p> <p>No reference count of database use is maintained by Berkeley DB. Applications should not rename databases that are currently in use.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-encrypt<dd>Specify the database in an environment is encrypted with the +<dl compact> +<dt>-encrypt<dd>Specify the database in an environment is encrypted with the same password that is being used in the environment. -<p><dt>-encryptaes passwd<dd>Specify the database is encrypted with the given password +<dt>-encryptaes passwd<dd>Specify the database is encrypted with the given password using the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm. -<p><dt>-encryptany passwd<dd>Specify the already existing database is encrypted +<dt>-encryptany passwd<dd>Specify the already existing database is encrypted with the given password. This option is used if the database is known to be encrypted, but the specific algorithm used is not known. -<p><dt>-env env<dd>If a <b>-env</b> argument is given, the database in the specified Berkeley DB +<dt>-env env<dd>If a <b>-env</b> argument is given, the database in the specified Berkeley DB environment is renamed. -<p><dt>--<dd>Mark the end of the command arguments. +<dt>--<dd>Mark the end of the command arguments. </dl> <p>The <b>berkdb dbrename</b> command returns 0 on success, and in the case of error, a Tcl error is thrown.</p> @@ -58,6 +57,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_stat.html b/db/docs/api_tcl/db_stat.html index e85362a68..e9bc39211 100644 --- a/db/docs/api_tcl/db_stat.html +++ b/db/docs/api_tcl/db_stat.html @@ -1,24 +1,23 @@ <!--$Id: db_stat.so,v 11.12 2002/08/18 21:17:27 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db stat</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>stat</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db stat @@ -28,8 +27,8 @@ <p>The <i>db</i> <b>stat</b> command returns a list of name/value pairs comprising the statistics of the database.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-faststat<dd>Return only that information which does not require a traversal +<dl compact> +<dt>-faststat<dd>Return only that information which does not require a traversal of the database. </dl> <p>In the case of error, a Tcl error is thrown.</p> @@ -37,6 +36,6 @@ of the database. <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_sync.html b/db/docs/api_tcl/db_sync.html index 49cbe142e..77d46b25b 100644 --- a/db/docs/api_tcl/db_sync.html +++ b/db/docs/api_tcl/db_sync.html @@ -1,24 +1,23 @@ <!--$Id: db_sync.so,v 11.11 2002/08/18 21:17:27 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db sync</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>sync</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db sync @@ -33,6 +32,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/db_truncate.html b/db/docs/api_tcl/db_truncate.html index b2fd10bb4..1366e68db 100644 --- a/db/docs/api_tcl/db_truncate.html +++ b/db/docs/api_tcl/db_truncate.html @@ -1,24 +1,23 @@ <!--$Id: db_truncate.so,v 11.5 2002/08/18 21:17:28 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db truncate</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>db</i> <b>truncate</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>db truncate @@ -28,11 +27,11 @@ <h3>Description(db truncate)</h3> <p>Empties the database, discarding all records it contains.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected (other than by specifying the -auto_commit flag), the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -44,6 +43,6 @@ from the database on success.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/dbc_close.html b/db/docs/api_tcl/dbc_close.html index 4591cdfa0..5c78090a5 100644 --- a/db/docs/api_tcl/dbc_close.html +++ b/db/docs/api_tcl/dbc_close.html @@ -1,24 +1,23 @@ <!--$Id: dbc_close.so,v 11.13 2002/08/18 21:17:28 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db close</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>dbc</i> <b>close</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>dbc close @@ -33,6 +32,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/dbc_del.html b/db/docs/api_tcl/dbc_del.html index b2593d20c..c433f816e 100644 --- a/db/docs/api_tcl/dbc_del.html +++ b/db/docs/api_tcl/dbc_del.html @@ -1,24 +1,23 @@ <!--$Id: dbc_del.so,v 11.13 2002/08/18 21:17:28 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db del</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>dbc</i> <b>del</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>dbc del @@ -35,6 +34,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/dbc_dup.html b/db/docs/api_tcl/dbc_dup.html index 2fdfb9b89..20710e4ed 100644 --- a/db/docs/api_tcl/dbc_dup.html +++ b/db/docs/api_tcl/dbc_dup.html @@ -1,24 +1,23 @@ <!--$Id: dbc_dup.so,v 11.8 2002/08/18 21:17:28 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db dup</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>dbc</i> <b>dup</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>dbc dup @@ -30,8 +29,8 @@ that uses the same transaction and locker ID as the original cursor. This is useful when an application is using locking and requires two or more cursors in the same thread of control.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-position<dd>The newly created cursor is initialized to refer to the same position +<dl compact> +<dt>-position<dd>The newly created cursor is initialized to refer to the same position in the database as the original cursor and hold the same locks. If the <b>-position</b> flag is not specified, the created cursor is uninitialized and will behave like a cursor newly created using the @@ -43,6 +42,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/dbc_get.html b/db/docs/api_tcl/dbc_get.html index 083e0e8fc..27e9db054 100644 --- a/db/docs/api_tcl/dbc_get.html +++ b/db/docs/api_tcl/dbc_get.html @@ -1,24 +1,23 @@ <!--$Id: dbc_get.so,v 11.21 2002/08/18 21:17:28 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: db get</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>dbc</i> <b>get</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>dbc get @@ -54,25 +53,25 @@ the case of the <b>-get_recno</b> option, <i>dbc</i> <b>get</b> returns a list of the record number. In the case of the <b>-join_item</b> option, <i>dbc</i> <b>get</b> returns a list containing the joined key.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-current<dd>Return the key/data pair to which the cursor currently refers. +<dl compact> +<dt>-current<dd>Return the key/data pair to which the cursor currently refers. <p>If the cursor key/data pair was deleted, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-first<dd>The cursor is set to refer to the first key/data pair of the database, and +<dt>-first<dd>The cursor is set to refer to the first key/data pair of the database, and that pair is returned. In the presence of duplicate key values, the first data item in the set of duplicates is returned. <p>If the database is a Queue or Recno database, <i>dbc</i> <b>get</b> using the <b>-first</b> option will skip any keys that exist but were never explicitly created by the application, or were created and later deleted.</p> <p>If the database is empty, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-last<dd>The cursor is set to refer to the last key/data pair of the database, and +<dt>-last<dd>The cursor is set to refer to the last key/data pair of the database, and that pair is returned. In the presence of duplicate key values, the last data item in the set of duplicates is returned. <p>If the database is a Queue or Recno database, <i>dbc</i> <b>get</b> using the <b>-last</b> option will skip any keys that exist but were never explicitly created by the application, or were created and later deleted.</p> <p>If the database is empty, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-next<dd>If the cursor is not yet initialized, the <b>-next</b> option is +<dt>-next<dd>If the cursor is not yet initialized, the <b>-next</b> option is identical to <b>-first</b>. <p>Otherwise, the cursor is moved to the next key/data pair of the database, and that pair is returned. In the presence of duplicate key values, the @@ -82,17 +81,17 @@ value of the key may not change. </p> explicitly created by the application, or were created and later deleted.</p> <p>If the cursor is already on the last record in the database, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-nextdup<dd>If the next key/data pair of the database is a duplicate record for the +<dt>-nextdup<dd>If the next key/data pair of the database is a duplicate record for the current key/data pair, the cursor is moved to the next key/data pair of the database, and that pair is returned. Otherwise, <i>dbc</i> <b>get</b> will return an empty list. -<p><dt>-nextnodup<dd>If the cursor is not yet initialized, the <b>-nextnodup</b> option is +<dt>-nextnodup<dd>If the cursor is not yet initialized, the <b>-nextnodup</b> option is identical to <b>-first</b>. <p>Otherwise, the cursor is moved to the next non-duplicate key/data pair of the database, and that pair is returned.</p> <p>If no non-duplicate key/data pairs occur after the cursor position in the database, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-prev<dd>If the cursor is not yet initialized, <b>-prev</b> is identical to +<dt>-prev<dd>If the cursor is not yet initialized, <b>-prev</b> is identical to <b>-last</b>. <p>Otherwise, the cursor is moved to the previous key/data pair of the database, and that pair is returned. In the presence of duplicate key @@ -102,13 +101,13 @@ values, the value of the key may not change.</p> created by the application, or were created and later deleted.</p> <p>If the cursor is already on the first record in the database, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-prevnodup<dd>If the cursor is not yet initialized, the <b>-prevnodup</b> option is +<dt>-prevnodup<dd>If the cursor is not yet initialized, the <b>-prevnodup</b> option is identical to <b>-last</b>. <p>Otherwise, the cursor is moved to the previous non-duplicate key/data pair of the database, and that pair is returned.</p> <p>If no non-duplicate key/data pairs occur before the cursor position in the database, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-set<dd>Move the cursor to the specified key/data pair of the database, and return +<dt>-set<dd>Move the cursor to the specified key/data pair of the database, and return the datum associated with the given key. <p>In the presence of duplicate key values, <i>dbc</i> <b>get</b> will return the first data item for the given key. </p> @@ -116,38 +115,38 @@ first data item for the given key. </p> but was never explicitly created by the application or was later deleted, <i>dbc</i> <b>get</b> will return an empty list.</p> <p>If no matching keys are found, <i>dbc</i> <b>get</b> will return an empty list.</p> -<p><dt>-set_range<dd>The <b>-set_range</b> option is identical to the <b>-set</b> option, +<dt>-set_range<dd>The <b>-set_range</b> option is identical to the <b>-set</b> option, except that the key is returned as well as the data item, and, in the case of the Btree access method, the returned key/data pair is the smallest key greater than or equal to the specified key (as determined by the comparison function), permitting partial key matches and range searches. -<p><dt>-get_both<dd>The <b>-get_both</b> option is identical to the <b>-set</b> option, +<dt>-get_both<dd>The <b>-get_both</b> option is identical to the <b>-set</b> option, except that both the key and the data arguments must be matched by the key and data item in the database. <p>For <b>-get_both</b> to be specified, the underlying database must be of type Btree or Hash.</p> -<p><dt>-set_recno<dd>Move the cursor to the specific numbered record of the database, and +<dt>-set_recno<dd>Move the cursor to the specific numbered record of the database, and return the associated key/data pair. The key must be a record number. <p>For the <b>-set_recno</b> option to be specified, the underlying database must be of type Btree, and it must have been created with the <b>-recnum</b> option.</p> -<p><dt>-get_recno<dd>Return a list of the record number associated with the current cursor +<dt>-get_recno<dd>Return a list of the record number associated with the current cursor position. No key argument should be specified. <p>For <b>-get_recno</b> to be specified, the underlying database must be of type Btree, and it must have been created with the <b>-recnum</b> option.</p> -<p><dt>-join_item<dd>Do not use the data value found in all the cursors as a lookup key for +<dt>-join_item<dd>Do not use the data value found in all the cursors as a lookup key for the primary database, but simply return it in the key parameter instead. The data parameter is left unchanged. <p>For <b>-join_item</b> to be specified, the cursor must have been created by the <i>db</i> <b>join</b> command.</p> -<p><dt>-partial {offset length}<dd>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning +<dt>-partial {offset length}<dd>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning of the retrieved data record are returned as if they comprised the entire record. If any or all of the specified bytes do not exist in the record, the command is successful and any existing bytes are returned. -<p><dt>-rmw<dd>Acquire write locks instead of read locks when doing the retrieval. Setting +<dt>-rmw<dd>Acquire write locks instead of read locks when doing the retrieval. Setting this flag may decrease the likelihood of deadlock during a read-modify-write cycle by immediately acquiring the write lock during the read part of the cycle so that another thread of control acquiring a read lock for the same @@ -164,6 +163,6 @@ exist an empty list is returned.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/dbc_put.html b/db/docs/api_tcl/dbc_put.html index d00b5a12a..91a421aef 100644 --- a/db/docs/api_tcl/dbc_put.html +++ b/db/docs/api_tcl/dbc_put.html @@ -1,24 +1,23 @@ <!--$Id: dbc_put.so,v 11.17 2003/02/21 15:16:45 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: dbc put</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>dbc</i> <b>put</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>dbc put @@ -36,8 +35,8 @@ dbc put <h3>Description(dbc put)</h3> <p>The <i>dbc</i> <b>put</b> command stores the specified key/data pair into the database. One of the following options must be specified:</p> -<p><dl compact> -<p><dt>-after<dd>In the case of the Btree and Hash access methods, insert the data element +<dl compact> +<dt>-after<dd>In the case of the Btree and Hash access methods, insert the data element as a duplicate element of the key to which the cursor refers. The new element appears immediately after the current cursor position. It is an error to specify <b>-after</b> if the underlying Btree or Hash database @@ -55,7 +54,7 @@ the key parameter is ignored. See <b>berkdb open</b> for more information.</p> <p>If the current cursor record has already been deleted, and the underlying access method is Hash, <i>dbc</i> <b>put</b> will throw a Tcl error. If the underlying access method is Btree or Recno, the operation will succeed.</p> -<p><dt>-before<dd>In the case of the Btree and Hash access methods, insert the data element +<dt>-before<dd>In the case of the Btree and Hash access methods, insert the data element as a duplicate element of the key to which the cursor refers. The new element appears immediately before the current cursor position. It is an error to specify <b>-before</b> if the underlying Btree or Hash database @@ -73,7 +72,7 @@ key parameter is ignored. See <b>berkdb open</b> for more information.</p> <p>If the current cursor record has already been deleted and the underlying access method is Hash, <i>dbc</i> <b>put</b> will throw a Tcl error. If the underlying access method is Btree or Recno, the operation will succeed.</p> -<p><dt>-current<dd>Overwrite the data of the key/data pair to which the cursor refers with +<dt>-current<dd>Overwrite the data of the key/data pair to which the cursor refers with the specified data item. No key argument should be specified. <p>If the <b>-dupsort</b> option was specified to <b>berkdb open</b> and the data item of the key/data pair to which the cursor refers does not @@ -83,7 +82,7 @@ error.</p> access method is Hash, <i>dbc</i> <b>put</b> will throw a Tcl error. If the underlying access method is Btree, Queue, or Recno, the operation will succeed.</p> -<p><dt>-keyfirst<dd>In the case of the Btree and Hash access methods, insert the specified +<dt>-keyfirst<dd>In the case of the Btree and Hash access methods, insert the specified key/data pair into the database. <p>If the key already exists in the database, and the <b>-dupsort</b> option was specified to <b>berkdb open</b>, the inserted data item is added in its @@ -92,7 +91,7 @@ sorted location. If the key already exists in the database, and the as the first of the data items for that key.</p> <p>The <b>-keyfirst</b> option may not be specified to the Queue or Recno access methods.</p> -<p><dt>-keylast<dd>In the case of the Btree and Hash access methods, insert the specified +<dt>-keylast<dd>In the case of the Btree and Hash access methods, insert the specified key/data pair into the database. <p>If the key already exists in the database, and the <b>-dupsort</b> option was specified to <b>berkdb open</b>, the inserted data item is added in its @@ -101,16 +100,17 @@ sorted location. If the key already exists in the database, and the as the last of the data items for that key.</p> <p>The <b>-keylast</b> option may not be specified to the Queue or Recno access methods.</p> -<p><dt>-partial {doff dlen}<dd><p>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning +<dt>-partial {doff dlen}<dd><p>The <b>dlen</b> bytes starting <b>doff</b> bytes from the beginning of the specified key's data record are replaced by the data specified by the data and size structure elements. If <b>dlen</b> is smaller than the length of the supplied data, the record will grow; if <b>dlen</b> is larger than the length of the supplied data, the record will shrink. If the specified bytes do not exist, the record will be extended using nul bytes as necessary, and the <i>dbc</i> <b>put</b> call will succeed. +</p> <p>It is an error to attempt a partial put using the <i>dbc</i> <b>put</b> command in a database that supports duplicate records. Partial puts in databases supporting -duplicate records must be done using a <i>dbc</i> <b>put</b> command.</p></p> +duplicate records must be done using a <i>dbc</i> <b>put</b> command.</p> <p>It is an error to attempt a partial put with differing <b>dlen</b> and supplied data length values in Queue or Recno databases with fixed-length records.</p> @@ -129,6 +129,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/env_close.html b/db/docs/api_tcl/env_close.html index 1f381b887..e14d885a4 100644 --- a/db/docs/api_tcl/env_close.html +++ b/db/docs/api_tcl/env_close.html @@ -1,24 +1,23 @@ <!--$Id: env_close.so,v 11.14 2002/08/18 21:17:29 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: env close</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>env</i> <b>close</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>env close @@ -39,6 +38,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/env_dbremove.html b/db/docs/api_tcl/env_dbremove.html index 0679c5747..384f83437 100644 --- a/db/docs/api_tcl/env_dbremove.html +++ b/db/docs/api_tcl/env_dbremove.html @@ -1,24 +1,23 @@ <!--$Id: env_dbremove.so,v 11.3 2002/08/18 21:17:29 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: env dbremove</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>env</i> <b>dbremove</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>env dbremove @@ -30,11 +29,11 @@ <h3>Description(env dbremove)</h3> <p>Remove the Berkeley DB database <b>file</b>.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected (other than by specifying the -auto_commit flag), the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -45,6 +44,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/env_dbrename.html b/db/docs/api_tcl/env_dbrename.html index fc9d8aa12..44de8f61a 100644 --- a/db/docs/api_tcl/env_dbrename.html +++ b/db/docs/api_tcl/env_dbrename.html @@ -1,24 +1,23 @@ <!--$Id: env_dbrename.so,v 11.3 2002/08/18 21:17:29 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: env dbrename</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>env</i> <b>dbrename</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>env dbrename @@ -31,11 +30,11 @@ <h3>Description(env dbrename)</h3> <p>Rename the Berkeley DB database <b>file</b> to <b>newname</b>.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes +<dl compact> +<dt>-auto_commit<dd>Enclose the call within a transaction. If the call succeeds, changes made by the operation will be recoverable. If the call fails, the operation will have made no changes. -<p><dt>-txn txnid<dd>If the operation is to be +<dt>-txn txnid<dd>If the operation is to be transaction-protected (other than by specifying the -auto_commit flag), the <b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. @@ -46,6 +45,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/env_open.html b/db/docs/api_tcl/env_open.html index d73f785c3..6377c1e04 100644 --- a/db/docs/api_tcl/env_open.html +++ b/db/docs/api_tcl/env_open.html @@ -1,24 +1,23 @@ <!--$Id: env_open.so,v 11.29 2002/12/22 21:11:07 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: berkdb env</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><b>berkdb env</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>berkdb env @@ -51,8 +50,8 @@ accesses the environment methods. The command automatically initializes the Shared Memory Buffer Pool subsystem. This subsystem is used whenever the application is using any Berkeley DB access method.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-cachesize {gbytes bytes ncache}<dd>Set the size of the database's shared memory buffer pool (that is, the +<dl compact> +<dt>-cachesize {gbytes bytes ncache}<dd>Set the size of the database's shared memory buffer pool (that is, the cache), to <b>gbytes</b> gigabytes plus <b>bytes</b>. The cache should be the size of the normal working data set of the application, with some small amount of additional memory for unusual situations. @@ -71,16 +70,16 @@ cache will be allocated contiguously in memory. If it is greater than separate pieces of memory.</p> <p>For information on tuning the Berkeley DB cache size, see <a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>.</p> -<p><dt>-create<dd>Cause Berkeley DB subsystems to create any underlying files, as necessary. -<p><dt>-data_dir dirname<dd>Specify the environment's data directory as described in +<dt>-create<dd>Cause Berkeley DB subsystems to create any underlying files, as necessary. +<dt>-data_dir dirname<dd>Specify the environment's data directory as described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-encryptaes passwd<dd>Specify the database should be encrypted with the given password +<dt>-encryptaes passwd<dd>Specify the database should be encrypted with the given password using the Rijndael/AES (also known as the Advanced Encryption Standard and Federal Information Processing Standard (FIPS) 197) algorithm. -<p><dt>-encryptany passwd<dd>Specify the already existing environment should be opened +<dt>-encryptany passwd<dd>Specify the already existing environment should be opened with the given password. This option is used if the environment is known to be encrypted, but the specific algorithm used is not known. -<p><dt>-errfile filename<dd><p>When an error occurs in the Berkeley DB library, a Berkeley DB error or an error +<dt>-errfile filename<dd><p>When an error occurs in the Berkeley DB library, a Berkeley DB error or an error return value is returned by the function. In some cases, however, the errno value may be insufficient to completely describe the cause of the error especially during initial application debugging.</p> @@ -95,18 +94,18 @@ character.</p> <p>This error-logging enhancement does not slow performance or significantly increase application size, and may be run during normal operation as well as during application debugging.</p> -<p><dt>-home directory<dd>The <b>-home</b> argument is described in +<dt>-home directory<dd>The <b>-home</b> argument is described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-log_dir dirname<dd>Specify the environment's logging file directory as described in +<dt>-log_dir dirname<dd>Specify the environment's logging file directory as described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-mode mode<dd><p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by Berkeley DB +<dt>-mode mode<dd><p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by Berkeley DB are created with mode <b>mode</b> (as described in <b>chmod</b>(2)) and modified by the process' umask value at the time of creation (see <b>umask</b>(2)). The group ownership of created files is based on the system and directory defaults, and is not further specified by Berkeley DB. If <b>mode</b> is 0, files are created readable and writable by both owner and group. On Windows systems, the mode argument is ignored.</p> -<p><dt>-private<dd>Specify that the environment will only be accessed by a single process +<dt>-private<dd>Specify that the environment will only be accessed by a single process (although that process may be multithreaded). This flag has two effects on the Berkeley DB environment. First, all underlying data structures are allocated from per-process memory instead of from shared memory that is @@ -117,22 +116,22 @@ accessing the environment, as it is likely to cause database corruption and unpredictable behavior. For example, if both a server application and the Berkeley DB utility <a href="../utility/db_stat.html">db_stat</a> will access the environment, the <b>-private</b> option should not be specified.</p> -<p><dt>-recover<dd>Run normal recovery on this environment before opening it for normal use. +<dt>-recover<dd>Run normal recovery on this environment before opening it for normal use. If this flag is set, the <b>-create</b> option must also be set because the regions will be removed and re-created. -<p><dt>-recover_fatal<dd>Run catastrophic recovery on this environment before opening it for +<dt>-recover_fatal<dd>Run catastrophic recovery on this environment before opening it for normal use. If this flag is set, the <b>-create</b> option must also be set since the regions will be removed and re-created. -<p><dt>-shm_key key<dd>Specify a base segment ID for Berkeley DB environment shared memory regions +<dt>-shm_key key<dd>Specify a base segment ID for Berkeley DB environment shared memory regions created in system memory on systems supporting X/Open-style shared memory interfaces, for example, UNIX systems supporting shmget(2) and related System V IPC interfaces. See <a href="../ref/env/region.html">Shared Memory Regions</a> for more information. -<p><dt>-system_mem<dd>Allocate memory from system shared memory instead of memory backed by the +<dt>-system_mem<dd>Allocate memory from system shared memory instead of memory backed by the filesystem. See <a href="../ref/env/region.html">Shared Memory Regions</a> for more information. -<p><dt>-tmp_dir dirname<dd>Specify the environment's tmp directory, as described in +<dt>-tmp_dir dirname<dd>Specify the environment's tmp directory, as described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-txn [nosync]<dd>Initialize the Transaction subsystem. This subsystem is used when +<dt>-txn [nosync]<dd>Initialize the Transaction subsystem. This subsystem is used when recovery and atomicity of multiple operations and recovery are important. The <b>-txn</b> option implies the initialization of the logging and locking subsystems as well. @@ -146,17 +145,17 @@ redone.</p> <p>The number of transactions that are potentially at risk is governed by how often the log is checkpointed (see <a href="../utility/db_checkpoint.html">db_checkpoint</a> for more information) and how many log updates can fit on a single log page.</p> -<p><dt>-txn_max max<dd>Set the maximum number of simultaneous transactions that are supported +<dt>-txn_max max<dd>Set the maximum number of simultaneous transactions that are supported by the environment, which bounds the size of backing files. When there are more than the specified number of concurrent transactions, calls to <i>env</i> <b>txn</b> will fail (until some active transactions complete). -<p><dt>-use_environ<dd>The Berkeley DB process' environment may be permitted to specify information +<dt>-use_environ<dd>The Berkeley DB process' environment may be permitted to specify information to be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. Because permitting users to specify which files are used can create security problems, environment information will be used in file naming for all users only if the <b>-use_environ</b> flag is set. -<p><dt>-use_environ_root<dd>The Berkeley DB process' environment may be permitted to specify information +<dt>-use_environ_root<dd>The Berkeley DB process' environment may be permitted to specify information to be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. As permitting users to specify which files are used can create security @@ -171,6 +170,6 @@ systems). <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/env_remove.html b/db/docs/api_tcl/env_remove.html index 62c5c77e4..6fa71f2d5 100644 --- a/db/docs/api_tcl/env_remove.html +++ b/db/docs/api_tcl/env_remove.html @@ -1,24 +1,23 @@ <!--$Id: env_remove.so,v 11.17 2002/08/18 21:17:29 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: berkdb envremove</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><b>berkdb envremove</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>berkdb envremove @@ -33,28 +32,28 @@ <h3>Description(berkdb envremove)</h3> <p>Remove a Berkeley DB environment.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-data_dir dirname<dd>Specify the environment's data directory, as described in +<dl compact> +<dt>-data_dir dirname<dd>Specify the environment's data directory, as described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-force<dd>If there are processes that have called <b>berkdb env</b> without calling +<dt>-force<dd>If there are processes that have called <b>berkdb env</b> without calling <i>env</i> <b>close</b> (that is, there are processes currently using the environment), <b>berkdb envremove</b> will fail without further action, unless the <b>-force</b> flag is set, in which case <b>berkdb envremove</b> will attempt to remove the environment regardless of any processes still using it. -<p><dt>-home directory<dd>The <b>-home</b> argument is described in +<dt>-home directory<dd>The <b>-home</b> argument is described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-log_dir dirname<dd>Specify the environment's log directory, as described in +<dt>-log_dir dirname<dd>Specify the environment's log directory, as described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-tmp_dir dirname<dd>Specify the environment's tmp directory, as described in +<dt>-tmp_dir dirname<dd>Specify the environment's tmp directory, as described in <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><dt>-use_environ<dd>The Berkeley DB process' environment may be permitted to specify information +<dt>-use_environ<dd>The Berkeley DB process' environment may be permitted to specify information to be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. Because permitting users to specify which files are used can create security problems, environment information will be used in file naming for all users only if the <b>-use_environ</b> flag is set. -<p><dt>-use_environ_root<dd>The Berkeley DB process' environment may be permitted to specify information +<dt>-use_environ_root<dd>The Berkeley DB process' environment may be permitted to specify information to be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB File Naming</a>. As permitting users to specify which files are used can create security @@ -69,6 +68,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/tcl_index.html b/db/docs/api_tcl/tcl_index.html index 95ad48fa3..7b6968040 100644 --- a/db/docs/api_tcl/tcl_index.html +++ b/db/docs/api_tcl/tcl_index.html @@ -1,16 +1,16 @@ <!--$Id: tcl_index.so,v 11.21 2003/10/18 19:16:23 bostic Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: Tcl API</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> <h3 align=center>Tcl API</h3> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> <table border=1 align=center> <tr><th>Tcl Command</th><th>Description</th></tr> <tr><td><a href="../api_tcl/env_open.html"><b>berkdb env</b></a></td><td>Create an environment handle</td></tr> @@ -49,6 +49,6 @@ <tr><td><br></td><td><br></td></tr> <tr><td><a href="../api_tcl/version.html"><b>berkdb version</b></a></td><td>Return version information</td></tr> </table> -<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/txn.html b/db/docs/api_tcl/txn.html index 448d8fafe..187e3a02a 100644 --- a/db/docs/api_tcl/txn.html +++ b/db/docs/api_tcl/txn.html @@ -1,24 +1,23 @@ <!--$Id: txn.so,v 11.17 2003/10/18 19:16:24 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: env txn</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>env</i> <b>txn</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>env txn @@ -34,21 +33,21 @@ X is an integer starting at 0 (for example, env0.txn0 and env0.txn1). It is through this Tcl command that the script accesses the transaction methods.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-nosync<dd>Do not synchronously flush the log when this transaction commits or +<dl compact> +<dt>-nosync<dd>Do not synchronously flush the log when this transaction commits or prepares. This means the transaction will exhibit the ACI (atomicity, consistency, and isolation) properties, but not D (durability); that is, database integrity will be maintained, but it is possible that this transaction may be undone during recovery instead of being redone. <p>This behavior may be set for an entire Berkeley DB environment as part of the <b>berkdb env</b> call.</p> -<p><dt>-nowait<dd>If a lock is unavailable for any Berkeley DB operation performed in the context +<dt>-nowait<dd>If a lock is unavailable for any Berkeley DB operation performed in the context of this transaction, throw a Tcl error immediately instead of blocking on the lock. -<p><dt>-parent txnid<dd>Create the new transaction as a nested transaction, with the specified +<dt>-parent txnid<dd>Create the new transaction as a nested transaction, with the specified transaction indicated as its parent. Transactions may be nested to any level. -<p><dt>-sync<dd>Synchronously flush the log when this transaction commits or prepares. +<dt>-sync<dd>Synchronously flush the log when this transaction commits or prepares. This means the transaction will exhibit all of the ACID (atomicity, consistency, isolation, and durability) properties. <p>This behavior is the default for Berkeley DB environments unless the @@ -60,6 +59,6 @@ consistency, isolation, and durability) properties. <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/txn_abort.html b/db/docs/api_tcl/txn_abort.html index 21fb840f2..5e69b2fff 100644 --- a/db/docs/api_tcl/txn_abort.html +++ b/db/docs/api_tcl/txn_abort.html @@ -1,24 +1,23 @@ <!--$Id: txn_abort.so,v 11.15 2002/08/18 21:17:30 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: txn abort</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>txn</i> <b>abort</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>txn abort @@ -42,6 +41,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/txn_checkpoint.html b/db/docs/api_tcl/txn_checkpoint.html index 5219b9097..5ef717e3e 100644 --- a/db/docs/api_tcl/txn_checkpoint.html +++ b/db/docs/api_tcl/txn_checkpoint.html @@ -1,24 +1,23 @@ <!--$Id: txn_checkpoint.so,v 11.1 2003/09/02 14:38:51 sue Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: env txn_checkpoint</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>env</i> <b>txn_checkpoint</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>env txn_checkpoint @@ -29,11 +28,11 @@ <h3>Description(env txn_checkpoint)</h3> <p>The <i>env</i> <b>txn_checkpoint</b> command writes a checkpoint.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-force<dd>The checkpoint will occur regardless of activity level. -<p><dt>-kbyte kb<dd>The checkpoint will occur only if at least the specified number +<dl compact> +<dt>-force<dd>The checkpoint will occur regardless of activity level. +<dt>-kbyte kb<dd>The checkpoint will occur only if at least the specified number of kilobytes of log data has been written since the last checkpoint. -<p><dt>-min minutes<dd>The checkpoint will occur only if at least the specified number +<dt>-min minutes<dd>The checkpoint will occur only if at least the specified number of minutes has passed since the last checkpoint. </dl> <p>In the case of error, a Tcl error is thrown.</p> @@ -41,6 +40,6 @@ of minutes has passed since the last checkpoint. <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/txn_commit.html b/db/docs/api_tcl/txn_commit.html index 91c7afdd4..9ca610084 100644 --- a/db/docs/api_tcl/txn_commit.html +++ b/db/docs/api_tcl/txn_commit.html @@ -1,24 +1,23 @@ <!--$Id: txn_commit.so,v 11.19 2003/10/18 19:16:24 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: txn commit</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><i>txn</i> <b>commit</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>txn commit @@ -41,15 +40,15 @@ will be aborted.</p> <p>If the <b>-nosync</b> option is not specified, a commit log record is written and flushed to disk, as are all previously written log records.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-nosync<dd>Do not synchronously flush the log. This means the transaction will +<dl compact> +<dt>-nosync<dd>Do not synchronously flush the log. This means the transaction will exhibit the ACI (atomicity, consistency, and isolation) properties, but not D (durability); that is, database integrity will be maintained, but it is possible that this transaction may be undone during recovery instead of being redone. <p>This behavior may be set for an entire Berkeley DB environment as part of the <b>berkdb env</b> call.</p> -<p><dt>-sync<dd>Synchronously flush the log. This means the transaction will exhibit +<dt>-sync<dd>Synchronously flush the log. This means the transaction will exhibit all of the ACID (atomicity, consistency, isolation and durability) properties. <p>This behavior is the default for Berkeley DB environments unless the @@ -66,6 +65,6 @@ is thrown.</p> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> diff --git a/db/docs/api_tcl/version.html b/db/docs/api_tcl/version.html index a3c989582..ce61504ff 100644 --- a/db/docs/api_tcl/version.html +++ b/db/docs/api_tcl/version.html @@ -1,24 +1,23 @@ <!--$Id: version.so,v 11.12 2002/08/18 21:17:30 bostic Exp $--> -<!--$Id: m4.tcl,v 11.26 2003/09/02 14:38:50 sue Exp $--> -<!--Copyright 1997-2003 by Sleepycat Software, Inc.--> +<!--$Id: m4.tcl,v 11.27 2004/09/07 15:37:41 bostic Exp $--> +<!--Copyright 1997-2004 by Sleepycat Software, Inc.--> <!--All rights reserved.--> <!--See the file LICENSE for redistribution information.--> <html> <head> <title>Berkeley DB: berkdb version</title> <meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,Java,C,C++"> +<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> -<a name="2"><!--meow--></a> <table width="100%"><tr valign=top> <td> <h3><b>berkdb version</b></h3> </td> <td align=right> <a href="../api_tcl/tcl_index.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> +<a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a></td> +</tr></table> <hr size=1 noshade> <tt> <h3><pre>berkdb version @@ -28,14 +27,14 @@ <p>Return a list of the form {major minor patch} for the major, minor and patch levels of the underlying Berkeley DB release.</p> <p>The options are as follows:</p> -<p><dl compact> -<p><dt>-string<dd>Return a string with formatted Berkeley DB version information. +<dl compact> +<dt>-string<dd>Return a string with formatted Berkeley DB version information. </dl> <p>In the case of error, a Tcl error is thrown.</p> </tt> <table width="100%"><tr><td><br></td><td align=right> <a href="../api_tcl/tcl_index.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><a href="../sleepycat/legal.html">Copyright (c) 1996-2003</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> +<p><font size=1><a href="../sleepycat/legal.html">Copyright (c) 1996-2004</a> <a href="http://www.sleepycat.com">Sleepycat Software, Inc.</a> - All rights reserved.</font> </body> </html> |