diff options
Diffstat (limited to 'bdb/docs/api_tcl')
30 files changed, 0 insertions, 2247 deletions
diff --git a/bdb/docs/api_tcl/db_close.html b/bdb/docs/api_tcl/db_close.html deleted file mode 100644 index eaae3165588..00000000000 --- a/bdb/docs/api_tcl/db_close.html +++ /dev/null @@ -1,59 +0,0 @@ -<!--$Id: db_close.so,v 11.10 1999/12/20 08:52:33 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>close</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db close - [-nosync] -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>close</b> command flushes any cached database information to -disk, closes any open cursors, frees any allocated resources, and closes -any underlying files. Since 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>The options are as follows: -<p><dl compact> -<p><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 -always generated from scratch after any system or application crash. -<p>It is important to understand that flushing cached information to disk -only minimizes the window of opportunity for corrupted data. While -unlikely, it is possible for database corruption to happen if a system or -application crash occurs while writing data to the database. To ensure -that database corruption never occurs, applications must either: use -transactions and logging with automatic recovery, use logging and -application-specific recovery, or edit a copy of the database, and, once -all applications using the database have successfully called -<i>db</i> <b>close</b>, atomically replace the original database with the updated -copy. -</dl> -<p>Once <i>db</i> <b>close</b> has been called, regardless of its return, the DB -handle may not be accessed again. -<p>The <i>db</i> <b>close</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_count.html b/bdb/docs/api_tcl/db_count.html deleted file mode 100644 index 123c030ccff..00000000000 --- a/bdb/docs/api_tcl/db_count.html +++ /dev/null @@ -1,38 +0,0 @@ -<!--$Id: db_count.so,v 11.1 2000/02/02 18:23:19 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>count</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db count key -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>count</b> command returns a count of the number -of duplicate data items for the key given. -If the key does not exist, a value of 0 is returned. -If there are no duplicates, or the database does not support -duplicates, but a key/data pair exists, a value of 1 is returned. -If an error occurs, a Berkeley DB error message is returned or a Tcl error is -thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_cursor.html b/bdb/docs/api_tcl/db_cursor.html deleted file mode 100644 index 79187650dda..00000000000 --- a/bdb/docs/api_tcl/db_cursor.html +++ /dev/null @@ -1,42 +0,0 @@ -<!--$Id: db_cursor.so,v 11.10 1999/12/20 08:52:33 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>cursor</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db cursor - [-txn txnid] -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>cursor</b> command creates a database cursor. The returned -cursor handle is bound to a Tcl command of the form <b>dbN.cX</b>, where -X is an integer starting at 0 (e.g., db0.c0 and db0.c1). It is through -this Tcl command that the script accesses the cursor methods. -<p>The options are as follows: -<p><dl compact> -<p><dt>-txn txnid<dd>If the file is being accessed under transaction protection, the -<b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. -</dl> -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_del.html b/bdb/docs/api_tcl/db_del.html deleted file mode 100644 index b3340312ab2..00000000000 --- a/bdb/docs/api_tcl/db_del.html +++ /dev/null @@ -1,47 +0,0 @@ -<!--$Id: db_del.so,v 11.10 2000/03/15 16:43:04 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>del</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db del - [-glob] - [-txn txnid] - key -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>del</b> command removes key/data pairs from the database. -<p>In the presence of duplicate key values, all records associated with the -designated key will be discarded. -<p>The options are as follows: -<p><dl compact> -<p><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. -<p><dt>-txn txnid<dd>If the file is being accessed under transaction protection, the -<b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. -</dl> -<p>The <i>db</i> <b>del</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_get.html b/bdb/docs/api_tcl/db_get.html deleted file mode 100644 index 391f156529a..00000000000 --- a/bdb/docs/api_tcl/db_get.html +++ /dev/null @@ -1,98 +0,0 @@ -<!--$Id: db_get.so,v 11.13 2000/11/28 20:12:30 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>get</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db get - [-consume] - [-consume_wait] - [-glob] - [-partial {doff dlen}] - [-recno] - [-rmw] - [-txn txnid] - key -db get - -get_both - [-partial {doff dlen}] - [-rmw] - [-txn txnid] - key data -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>get</b> command returns key/data pairs from the database. -<p>In the presence of duplicate key values, <i>db</i> <b>get</b> will return all -duplicate items. Duplicates are sorted by insert order except where this -order has been overridden by cursor operations. -<p>The options are as follows: -<p><dl compact> -<p><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 -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 -arguments. -<p><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 -command "db0 get Jones" will return all of the "Jones" in the 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. -<p><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 the existing bytes or 0 bytes are -returned. -<p><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. -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 item, in its own read-modify-write cycle, will not -result in deadlock. -<p>As the <i>db</i> <b>get</b> command will not hold locks across Berkeley DB interface -calls in non-transactional environments, the <b>-rmw</b> argument to the -<i>db</i> <b>get</b> call is only meaningful in the presence of transactions. -<p><dt>-txn txnid<dd>If the file is being accessed under transaction protection, the -<b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. -</dl> -<p>If the underlying database is a Queue or Recno database, then the given -key will be interpreted by Tcl as an integer. For all other database -types, the key is interpreted by Tcl as a byte array unless indicated -by a given option. -<p>A list of key/data pairs is returned. In the error case that no matching -key exists, an empty list is returned. In all other cases, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_get_join.html b/bdb/docs/api_tcl/db_get_join.html deleted file mode 100644 index e2ede7e47d4..00000000000 --- a/bdb/docs/api_tcl/db_get_join.html +++ /dev/null @@ -1,45 +0,0 @@ -<!--$Id: db_get_join.so,v 11.15 2000/12/04 18:05:39 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>get_join</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db get_join - [-txn txnid] - {<i>db</i> key} - {<i>db</i> key} - ... -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>get_join</b> command performs the cursor operations required to -join the specified keys and returns a list of joined {key data} pairs. -See <a href="../ref/am/join.html">Logical join</a> for more information on -the underlying requirements for joining. -<p>The options are as follows: -<p><dl compact> -<p><dt>-txn txnid<dd>If the file is being accessed under transaction protection, the -<b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. -</dl> -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_get_type.html b/bdb/docs/api_tcl/db_get_type.html deleted file mode 100644 index 75fac1e78ae..00000000000 --- a/bdb/docs/api_tcl/db_get_type.html +++ /dev/null @@ -1,34 +0,0 @@ -<!--$Id: db_get_type.so,v 11.9 1999/12/20 08:52:34 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>get_type</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db get_type -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>get_type</b> command returns the underlying database type, -returning one of "btree", "hash", "queue" or "recno". -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_is_byteswapped.html b/bdb/docs/api_tcl/db_is_byteswapped.html deleted file mode 100644 index 6a196eddf73..00000000000 --- a/bdb/docs/api_tcl/db_is_byteswapped.html +++ /dev/null @@ -1,37 +0,0 @@ -<!--$Id: db_is_byteswapped.so,v 11.10 1999/12/20 08:52:34 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>is_byteswapped</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db is_byteswapped -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>is_byteswapped</b> command returns 0 if the underlying database -files were created on an architecture of the same byte order as the -current one, and 1 if they were not (i.e., big-endian on a little-endian -machine or vice-versa). This value may be used to determine if application -data needs to be adjusted for this architecture or not. -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_join.html b/bdb/docs/api_tcl/db_join.html deleted file mode 100644 index ba3f0a2e5cb..00000000000 --- a/bdb/docs/api_tcl/db_join.html +++ /dev/null @@ -1,48 +0,0 @@ -<!--$Id: db_join.so,v 11.16 2000/12/04 18:05:39 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>join</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db join - <i>db.cX</i> - <i>db.cY</i> - <i>db.cZ</i> - ... -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>join</b> command joins the specified cursors and returns a -cursor handle that can be used to iterate through the joined {key data} -pairs. The returned cursor handle is bound to a Tcl command of the form -<b>dbN.cX</b>, where X is an integer starting at 0 (e.g., db0.c0 and -db0.c1). It is through this Tcl command that the script accesses the -cursor methods. -<p>The returned join cursor has limited cursor functionality and only the -<i>dbc</i> <b>get</b> and <i>dbc</i> <b>close</b> commands will succeed. -<p>See <a href="../ref/am/join.html">Logical join</a> for more information on -the underlying requirements for joining. -<p>In a transaction protected environment, all of the cursors listed must -have been created within the same transaction. -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_open.html b/bdb/docs/api_tcl/db_open.html deleted file mode 100644 index 4f7b651e552..00000000000 --- a/bdb/docs/api_tcl/db_open.html +++ /dev/null @@ -1,300 +0,0 @@ -<!--$Id: db_open.so,v 11.18 2000/11/27 18:14:47 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><b>berkdb open</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>berkdb open - [-btree | -hash | -recno | -queue | -unknown] - [-cachesize {gbytes bytes ncache}] - [-create] - [-delim delim] - [-dup] - [-dupsort] - [-env env] - [-errfile filename] - [-excl] - [-extent size] - [-ffactor density] - [-len len] - [-mode mode] - [-nelem size] - [-pad pad] - [-pagesize pagesize] - [-rdonly] - [-recnum] - [-renumber] - [-snapshot] - [-source file] - [-truncate] - [-upgrade] - [--] - [file [database]] -</pre></h3> -<h1>Description</h1> -<p>The <b>berkdb open</b> command opens, and optionally creates, a database. -The returned database handle is bound to a Tcl command of the form -<b>dbN</b>, where N is an integer starting at 0 (e.g., db0 and db1). -It is through this Tcl command that the script accesses the database -methods. -<p>The options are as follows: -<p><dl compact> -<p><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 -an extensible, dynamic hashing scheme. -<p><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 -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, i.e., 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. (Note, the working -set is not the same as the number of simultaneously referenced pages, and -should be quite a bit larger!) -<p>The default cache size is 256KB, and may not be specified as less than -20KB. Any cache size less than 500MB is automatically increased by 25% -to account for buffer pool overhead, cache sizes larger than 500MB are -used as specified. -<p>It is possible to specify caches to Berkeley DB that are large enough so that -they cannot be allocated contiguously on some architectures, e.g., some -releases of Solaris limit the amount of memory that may be allocated -contiguously by a process. If <b>ncache</b> is 0 or 1, the cache will -be allocated contiguously in memory. If it is greater than 1, the cache -will be broken up into <b>ncache</b> equally sized separate pieces of -memory. -<p>For information on tuning the Berkeley DB cache size, see -<a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>. -<p>As 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><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 -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 (i.e. ASCII 0x0a) are interpreted as end-of-record markers. -<p><dt>-dup<dd>Permit duplicate data items in the tree, i.e. 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>It is an error to specify both <b>-dup</b> and <b>-recnum</b>. -<p><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>-env env<dd>If no <b>-env</b> argument is given, the database is standalone, i.e., -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 -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, then the access methods will automatically acquire the correct -locks when reading and writing pages of the database. -<p><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>The <b>-errfile</b> argument is used to enhance the mechanism for -reporting error messages to the application by specifying a file to be -used for displaying additional Berkeley DB error messages. In some cases, when -an error occurs, Berkeley DB will output an additional error message to the -specified file reference. -<p>The error message will consist of a Tcl command name and a colon (":"), -an error string, and a trailing <newline> character. If the -database was opened in an environment the Tcl command name will be the -environment name (e.g., env0), otherwise it will be the database command -name (e.g., db0). -<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>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><dt>-excl<dd>Return an error if the file already exists. Underlying filesystem -primitives are used to implement this flag. For this reason it is only -applicable to the physical database file and cannot be used to test if a -database in a file already exists. -<p><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><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 -<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>Any records added to the database that are less than <b>len</b> bytes -long are automatically padded (see the <b>-pad</b> argument for more -information). -<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><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 writeable by both -owner and group. On Windows systems, the mode argument is ignored. -<p><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><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 (i.e., -ASCII 0x20) are used for padding. -<p><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><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. -<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>Maintaining record counts within a Btree introduces a serious point of -contention, namely the page locations where the record counts are stored. In -addition, the entire tree must be locked during both insertions and -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>It is an error to specify both <b>-dup</b> and <b>-recnum</b>. -<p><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 1. If a cursor was -positioned to record number 4 before the deletion, it will reference the -new record number 4, if any such record exists, after the deletion. If a -cursor was positioned after record number 4 before the deletion, it will -be shifted downward 1 logical record, continuing to reference the same -record as it did before. -<p>Using the <i>db</i> <b>put</b> or <i>dbc</i> <b>put</b> interfaces to create new records will -cause the creation of multiple records if the record number is more than one -greater than the largest record currently in the database. For example, -creating record 28, when record 25 was previously the last record in the -database, will create records 26 and 27 as well as 28. -<p>If a created record is not at the end of the database, all records following -the new record will be automatically renumbered upward by 1. For example, -the creation of a new record numbered 8 causes records numbered 8 and -greater to be renumbered upward by 1. If a cursor was positioned to record -number 8 or greater before the insertion, it will be shifted upward 1 -logical record, continuing to reference the same record as it did before. -<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><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 -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 -text database file that is read to initialize a transient record number -index. In the case of variable length records, the records are separated -as specified by <b>-delim</b>. For example, standard UNIX byte stream -files can be interpreted as a sequence of variable length records -separated by <newline> characters. -<p>In addition, when cached data would normally be written back to the -underlying database file (e.g., the <i>db</i> <b>close</b> or <i>db</i> <b>sync</b> -commands are called), the in-memory copy of the database will be written -back to the <b>-source</b> file. -<p>By default, the backing source file is read lazily, i.e., records are not -read from the file until they are requested by the application. -<b>If multiple processes (not threads) are accessing a Recno database -concurrently and either inserting or deleting records, the backing source -file must be read in its entirety before more than a single process -accesses the database, and only that process should specify the backing -source argument as part of the <b>berkdb open</b> call. See the <b>-snapshot</b> -argument for more information.</b> -<p><b>Reading and writing the backing source file specified by <b>-source</b> -cannot be transactionally protected because it involves filesystem -operations that are not part of the Berkeley DB transaction methodology.</b> -For this reason, if a temporary database is used to hold the records, -i.e., no <b>file</b> argument was specified to the <b>berkdb open</b> call, -it is possible to lose the contents of the <b>-file</b> file, e.g., if -the system crashes at the right instant. If a file is used to hold the -database, i.e., a file name was specified as the <b>file</b> argument -to <b>berkdb open</b>, normal database recovery on that file can be used to -prevent information loss, although it is still possible that the contents -of <b>-source</b> will be lost if the system crashes. -<p>The <b>-source</b> file must already exist (but may be zero-length) when -<b>berkdb open</b> is called. -<p>It is not an error to specify a read-only <b>-source</b> file when -creating a database, nor is it an error to modify the resulting database. -However, any attempt to write the changes to the backing source file using -either the <i>db</i> <b>close</b> or <i>db</i> <b>sync</b> commands will fail, of course. -Specify the <b>-nosync</b> argument to the <i>db</i> <b>close</b> command will -stop it from attempting to write the changes to the backing file, instead, -they will be silently discarded. -<p>For all of the above reasons, the <b>-source</b> file is generally 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, e.g., a text editor. -<p><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><dt>-upgrade<dd>Upgrade the database represented by <b>file</b>, if necessary. -<p><b>Note: Database upgrades are done in place and are -destructive, e.g., if pages need to be allocated and no disk space is -available, the database may be left corrupted. Backups should be made -before databases are upgraded. See <a href="../ref/am/upgrade.html">Upgrading databases</a> for more information.</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 -database. -<p><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 -to open a second database file that was not initially created using a -<b>database</b> name. -</dl> -<p>The <b>berkdb open</b> command returns a database handle on success. -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_put.html b/bdb/docs/api_tcl/db_put.html deleted file mode 100644 index 2311a3c97ac..00000000000 --- a/bdb/docs/api_tcl/db_put.html +++ /dev/null @@ -1,74 +0,0 @@ -<!--$Id: db_put.so,v 11.10 2000/06/12 17:50:01 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>put</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db put - -append - [-partial {doff dlen}] - [-txn txnid] - data -db put - [-nooverwrite] - [-partial {doff dlen}] - [-txn txnid] - key data -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>put</b> command stores the specified key/data pair into the -database. -<p>The options are as follows: -<p><dl compact> -<p><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 -the database. -<p><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, and 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>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>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><dt>-txn txnid<dd>If the file is being accessed under transaction protection, the -<b>txnid</b> parameter is a transaction handle returned from <i>env</i> <b>txn</b>. -</dl> -<p>The <i>db</i> <b>put</b> command returns either 0 or a record number for success -(the record number is returned if the <b>-append</b> option was specified). -If an error occurs, a Berkeley DB error message is returned or a Tcl error is -thrown. -<p>If the underlying database is a Queue or Recno database, then the given -key will be interpreted by Tcl as an integer. For all other database -types, the key is interpreted by Tcl as a byte array. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_remove.html b/bdb/docs/api_tcl/db_remove.html deleted file mode 100644 index e45f3bc4970..00000000000 --- a/bdb/docs/api_tcl/db_remove.html +++ /dev/null @@ -1,49 +0,0 @@ -<!--$Id: db_remove.so,v 11.6 2000/03/22 21:56:10 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><b>berkdb dbremove</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>berkdb dbremove - [-env env] - [--] - file - [database] -</pre></h3> -<h1>Description</h1> -<p>Remove the Berkeley DB database specified by the database name <b>file</b> and -[database] name arguments. If no <b>database</b> is specified, -the physical file represented by <b>file</b> is removed, incidentally -removing all databases that it contained. -<p>No reference count of database use is maintained by Berkeley DB. Applications -should not remove databases that are currently in use. -<p>The options are as follows: -<p><dl compact> -<p><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. -</dl> -<p>The <b>berkdb dbremove</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_rename.html b/bdb/docs/api_tcl/db_rename.html deleted file mode 100644 index 75707d92a25..00000000000 --- a/bdb/docs/api_tcl/db_rename.html +++ /dev/null @@ -1,50 +0,0 @@ -<!--$Id: db_rename.so,v 11.1 2000/04/24 17:31:12 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><b>berkdb dbrename</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>berkdb rename - [-env env] - [--] - file - [database - newname] -</pre></h3> -<h1>Description</h1> -<p>Renames the Berkeley DB database specified by the database name <b>file</b> and -[database] name arguments to the new name given. -If no <b>database</b> is specified, -the physical file represented by <b>file</b> is renamed. -<p>No reference count of database use is maintained by Berkeley DB. Applications -should not rename databases that are currently in use. -<p>The options are as follows: -<p><dl compact> -<p><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. -</dl> -<p>The <b>berkdb dbrename</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_stat.html b/bdb/docs/api_tcl/db_stat.html deleted file mode 100644 index 494226dfd31..00000000000 --- a/bdb/docs/api_tcl/db_stat.html +++ /dev/null @@ -1,41 +0,0 @@ -<!--$Id: db_stat.so,v 11.9 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>stat</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db stat - [-recordcount] -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>stat</b> command returns a list of name/value pairs comprising -the statistics of the database. -<p>The options are as follows: -<p><dl compact> -<p><dt>-recordcount<dd>Return the number of records in the database. The <b>-recordcount</b> -option may only be specified for Recno databases, or Btree databases where -the underlying database was created with the <b>-recnum</b> option. -</dl> -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/db_sync.html b/bdb/docs/api_tcl/db_sync.html deleted file mode 100644 index f0e61b45a4d..00000000000 --- a/bdb/docs/api_tcl/db_sync.html +++ /dev/null @@ -1,36 +0,0 @@ -<!--$Id: db_sync.so,v 11.9 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>db</i> <b>sync</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>db sync -</pre></h3> -<h1>Description</h1> -<p>The <i>db</i> <b>sync</b> command function flushes any database cached -information to disk. -<p>See <i>db</i> <b>close</b> for a discussion of Berkeley DB and cached data. -<p>The <i>db</i> <b>sync</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/dbc_close.html b/bdb/docs/api_tcl/dbc_close.html deleted file mode 100644 index f3a63b4c559..00000000000 --- a/bdb/docs/api_tcl/dbc_close.html +++ /dev/null @@ -1,36 +0,0 @@ -<!--$Id: dbc_close.so,v 11.10 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>dbc</i> <b>close</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>dbc close -</pre></h3> -<h1>Description</h1> -<p>The <i>dbc</i> <b>close</b> command discards the cursor. -<p>Once <i>dbc</i> <b>close</b> has been called, regardless of its return, the -cursor handle may not be used again. -<p>The <i>dbc</i> <b>close</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/dbc_del.html b/bdb/docs/api_tcl/dbc_del.html deleted file mode 100644 index 11264eeea09..00000000000 --- a/bdb/docs/api_tcl/dbc_del.html +++ /dev/null @@ -1,38 +0,0 @@ -<!--$Id: dbc_del.so,v 11.10 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>dbc</i> <b>del</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>dbc del -</pre></h3> -<h1>Description</h1> -<p>The <i>dbc</i> <b>del</b> command deletes the key/data pair currently referenced -by the cursor. -<p>The cursor position is unchanged after a delete, and subsequent calls to -cursor commands expecting the cursor to reference an existing key will -fail. -<p>The <i>dbc</i> <b>del</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/dbc_dup.html b/bdb/docs/api_tcl/dbc_dup.html deleted file mode 100644 index 85b2bfb086e..00000000000 --- a/bdb/docs/api_tcl/dbc_dup.html +++ /dev/null @@ -1,46 +0,0 @@ -<!--$Id: dbc_dup.so,v 11.4 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>dbc</i> <b>dup</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>dbc dup - [-position] -</pre></h3> -<h1>Description</h1> -<p>The <i>dbc</i> <b>dup</b> command duplicates the cursor, creates a new cursor -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>The options are as follows: -<p><dl compact> -<p><dt>-position<dd>The newly created cursor is initialized to reference the same position in -the database as the original cursor and hold the same locks. If the -<b>-position</b> flag is not specified, then the created cursor is -uninitialized and will behave like a cursor newly created using the -<i>db</i> <b>cursor</b> command. -</dl> -<p>The <i>dbc</i> <b>dup</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/dbc_get.html b/bdb/docs/api_tcl/dbc_get.html deleted file mode 100644 index d16e51bdf9f..00000000000 --- a/bdb/docs/api_tcl/dbc_get.html +++ /dev/null @@ -1,168 +0,0 @@ -<!--$Id: dbc_get.so,v 11.16 2000/11/28 20:12:30 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>dbc</i> <b>get</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>dbc get - [-current] - [-first] - [-get_recno] - [-join_item] - [-last] - [-next] - [-nextdup] - [-nextnodup] - [-partial {offset length}] - [-prev] - [-prevnodup] - [-rmw] -dbc get - [-partial {offset length}] - [-rmw] - [-set] - [-set_range] - [-set_recno] - key -dbc get - -get_both - [-partial {offset length}] - [-rmw] - key data -</pre></h3> -<h1>Description</h1> -<p>The <i>dbc</i> <b>get</b> command returns a list of {key value} pairs, except in -the case of the <b>-get_recno</b> and <b>-join_item</b> options. In -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>The options are as follows: -<p><dl compact> -<p><dt>-current<dd>Return the key/data pair currently referenced by the cursor. -<p>If the cursor key/data pair was deleted, <i>dbc</i> <b>get</b> will return an -empty list. -<p><dt>-first<dd>The cursor is set to reference 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>If the database is empty, <i>dbc</i> <b>get</b> will return an empty list. -<p><dt>-last<dd>The cursor is set to reference 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>If the database is empty, <i>dbc</i> <b>get</b> will return an empty list. -<p><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 -value of the key may not change. -<p>If the database is a Queue or Recno database, <i>dbc</i> <b>get</b> using the -<b>-next</b> option will skip any keys that exist but were never -explicitly created by the application or were created and later deleted. -<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><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 -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>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><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 -values, the value of the key may not change. -<p>If the database is a Queue or Recno database, <i>dbc</i> <b>get</b> using the -<b>-prev</b> flag will skip any keys that exist but were never explicitly -created by the application or were created and later deleted. -<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><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>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><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>If the database is a Queue or Recno database and the requested key exists, -but was never explicitly created by the application or was later deleted, -<i>dbc</i> <b>get</b> will return an empty list. -<p>If no matching keys are found, <i>dbc</i> <b>get</b> will return an empty list. -<p><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, -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><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><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><dt>-join_item<dd>Do not use the data value found in all of 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><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 the existing bytes or 0 bytes are -returned. -<p><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 -item, in its own read-modify-write cycle, will not result in deadlock. -</dl> -<p>If a key is specified, and -if the underlying database is a Queue or Recno database, then the given -key will be interpreted by Tcl as an integer. For all other database -types, the key is interpreted by Tcl as a byte array unless indicated -by a given option. -<p>In the normal error case of attempting to retrieve a key that does not -exist an empty list is returned. -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/dbc_put.html b/bdb/docs/api_tcl/dbc_put.html deleted file mode 100644 index bd791ab94d2..00000000000 --- a/bdb/docs/api_tcl/dbc_put.html +++ /dev/null @@ -1,133 +0,0 @@ -<!--$Id: dbc_put.so,v 11.12 2000/06/12 17:50:01 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>dbc</i> <b>put</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>dbc put - [-after] - [-before] - [-current] - [-partial {doff dlen}] - data -dbc put - [-keyfirst] - [-keylast] - [-partial {doff dlen}] - key data -</pre></h3> -<h1>Description</h1> -<p>The <i>dbc</i> <b>put</b> command stores the specified key/data pair into the -database. -<p>The options are as follows: -<p><dl compact> -<p><dt>-after<dd>In the case of the Btree and Hash access methods, insert the data element -as a duplicate element of the key referenced by the cursor. 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 -was not created with the <b>-dup</b> option. No key argument should be -specified. -<p>In the case of the Recno access method, it is an error to specify -<b>-after</b> option if the underlying Recno database was not created -with the <b>-renumber</b> option. If the <b>-renumber</b> option was -specified, a new key is created, all records after the inserted item are -automatically renumbered, and the key of the new record is returned in -the structure referenced by the parameter key. The initial value of the -key parameter is ignored. See <b>berkdb open</b> for more information. -<p>In the case of the Queue access method, it is always an error to specify -<b>-after</b>. -<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><dt>-before<dd>In the case of the Btree and Hash access methods, insert the data element -as a duplicate element of the key referenced by the cursor. 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 -was not created with the <b>-dup</b> option. No key argument should be -specified. -<p>In the case of the Recno access method, it is an error to specify -<b>-before</b> if the underlying Recno database was not created with the -<b>-before</b> option. If the <b>-before</b> option was specified, a -new key is created, the current record and all records after it are -automatically renumbered, and the key of the new record is returned in -the structure referenced by the parameter key. The initial value of the -key parameter is ignored. See <b>berkdb open</b> for more information. -<p>In the case of the Queue access method, it is always an error to specify -<b>-before</b>. -<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><dt>-current<dd>Overwrite the data of the key/data pair referenced by the cursor 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 current referenced key/data pair does not compare -equally to the data parameter, <i>dbc</i> <b>put</b> will throw a Tcl error. -<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, Queue or Recno, the operation will -succeed. -<p><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 -sorted location. If the key already exists in the database, and the -<b>-dupsort</b> option was not specified, the inserted data item is added -as the first of the data items for that key. -<p>The <b>-keyfirst</b> option may not be specified to the Queue or Recno -access methods. -<p><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 -sorted location. If the key already exists in the database, and the -<b>-dupsort</b> option was not specified, the inserted data item is added -as the last of the data items for that key. -<p>The <b>-keylast</b> option may not be specified to the Queue or Recno -access methods. -<p><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, and 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>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>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. -</dl> -<p>If a key is specified, and -if the underlying database is a Queue or Recno database, then the given -key will be interpreted by Tcl as an integer. For all other database -types, the key is interpreted by Tcl as a byte array. -<p>If <i>dbc</i> <b>put</b> fails for any reason, the state of the cursor will be -unchanged. If <i>dbc</i> <b>put</b> succeeds and an item is inserted into the -database, the cursor is always positioned to reference the newly inserted -item. -<p>The <i>dbc</i> <b>put</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/env_close.html b/bdb/docs/api_tcl/env_close.html deleted file mode 100644 index 719ad2160ad..00000000000 --- a/bdb/docs/api_tcl/env_close.html +++ /dev/null @@ -1,42 +0,0 @@ -<!--$Id: env_close.so,v 11.10 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>env</i> <b>close</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>env close -</pre></h3> -<h1>Description</h1> -<p>Close the Berkeley DB environment, freeing any allocated resources and closing -any underlying subsystems. -<p>This does not imply closing any databases that were opened in the -environment. -<p>Where the environment was initialized with the <b>-lock</b> option, -calling <i>env</i> <b>close</b> does not release any locks still held by the -closing process, providing functionality for long-lived locks. -<p>Once <i>env</i> <b>close</b> has been called the <b>env</b> handle may not be -accessed again. -<p>The <i>env</i> <b>close</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/env_open.html b/bdb/docs/api_tcl/env_open.html deleted file mode 100644 index 1c5bafee4b9..00000000000 --- a/bdb/docs/api_tcl/env_open.html +++ /dev/null @@ -1,168 +0,0 @@ -<!--$Id: env_open.so,v 11.21 2000/06/05 15:17:24 sue Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><b>berkdb env</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>berkdb env - [-cachesize {gbytes bytes ncache}] - [-create] - [-data_dir dirname] - [-errfile filename] - [-home directory] - [-log_dir dirname] - [-mode mode] - [-private] - [-recover] - [-recover_fatal] - [-shm_key shmid] - [-system_mem] - [-tmp_dir dirname] - [-txn [nosync]] - [-txn_max max] - [-use_environ] - [-use_environ_root] -</pre></h3> -<h1>Description</h1> -<p>The <b>berkdb env</b> command opens, and optionally creates, a database -environment. The returned environment handle is bound to a Tcl command -of the form <b>envN</b>, where N is an integer starting at 0 (e.g., env0 -and env1). It is through this Tcl command that the script 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>The options are as follows: -<p><dl compact> -<p><dt>-cachesize {gbytes bytes ncache}<dd>Set the size of the database's shared memory buffer pool, i.e., 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. (Note, the working -set is not the same as the number of simultaneously referenced pages, and -should be quite a bit larger!) -<p>The default cache size is 256KB, and may not be specified as less than -20KB. Any cache size less than 500MB is automatically increased by 25% -to account for buffer pool overhead, cache sizes larger than 500MB are -used as specified. -<p>It is possible to specify caches to Berkeley DB that are large enough so that -they cannot be allocated contiguously on some architectures, e.g., some -releases of Solaris limit the amount of memory that may be allocated -contiguously by a process. If <b>ncache</b> is 0 or 1, the cache will -be allocated contiguously in memory. If it is greater than 1, the cache -will be broken up into <b>ncache</b> equally sized separate pieces of -memory. -<p>For information on tuning the Berkeley DB cache size, see -<a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>. -<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 -<a href="../ref/env/naming.html">Berkeley DB File Naming</a>. -<p><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>The <b>-errfile</b> argument is used to enhance the mechanism for -reporting error messages to the application by specifying a file to be -used for displaying additional Berkeley DB error messages. In some cases, when -an error occurs, Berkeley DB will output an additional error message to the -specified file reference. -<p>The error message will consist of the environment command name (e.g., env0) -and a colon (":"), an error string, and a trailing <newline> -character. -<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><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 -<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 -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 writeable by both -owner and group. On Windows systems, the mode argument is ignored. -<p><dt>-private<dd>Specify that the environment will only be accessed by a single process -(although that process may be multi-threaded). 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 -potentially accessible to more than a single process. Second, mutexes -are only configured to work between threads. -<p>This flag should not be specified if more than a single process is -accessing the environment, as it is likely to cause database corruption -and unpredictable behavior, e.g., 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><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 since -the regions will be removed and recreated. -<p><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 recreated. -<p><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, e.g., 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 -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 -<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 -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. -<p>If the optional <b>nosync</b> argument is specified, the log will not be -synchronously flushed on transaction commit or prepare. This means that -transactions exhibit the ACI (atomicity, consistency and isolation) -properties, but not D (durability), i.e., database integrity will be -maintained but it is possible that some number of the most recently -committed transactions may be undone during recovery instead of being -redone. -<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><dt>-txn_max max<dd>Set the maximum number of simultaneous transactions that are supported -by the environment. This 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 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 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 -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 problems, if the <b>-use_environ_root</b> flag is set, -environment information will be used for file naming only for users with -appropriate permissions (e.g., on IEEE/ANSI Std 1003.1 (POSIX) systems, users with a -user-ID of 0). -</dl> -<p>The <b>berkdb env</b> command returns an environment handle on success. -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/env_remove.html b/bdb/docs/api_tcl/env_remove.html deleted file mode 100644 index ca90595f83a..00000000000 --- a/bdb/docs/api_tcl/env_remove.html +++ /dev/null @@ -1,70 +0,0 @@ -<!--$Id: env_remove.so,v 11.13 2000/02/19 20:57:57 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><b>berkdb envremove</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>berkdb envremove - [-data_dir directory] - [-force] - [-home directory] - [-log_dir directory] - [-tmp_dir directory] - [-use_environ] - [-use_environ_root] -</pre></h3> -<h1>Description</h1> -<p>Remove a Berkeley DB environment. -<p>The options are as follows: -<p><dl compact> -<p><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 -<i>env</i> <b>close</b> (i.e., 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 -<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 -<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 -<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 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 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 -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 problems, if the <b>-use_environ_root</b> flag is set, -environment information will be used for file naming only for users with -appropriate permissions (e.g., on IEEE/ANSI Std 1003.1 (POSIX) systems, users with a -user-ID of 0). -</dl> -<p>The <b>berkdb envremove</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/pindex.src b/bdb/docs/api_tcl/pindex.src deleted file mode 100644 index 668f53d25f8..00000000000 --- a/bdb/docs/api_tcl/pindex.src +++ /dev/null @@ -1,27 +0,0 @@ -__APIREL__/api_tcl/db_close.html#2 @db close -__APIREL__/api_tcl/db_count.html#2 @db count -__APIREL__/api_tcl/db_cursor.html#2 @db cursor -__APIREL__/api_tcl/db_del.html#2 @db del -__APIREL__/api_tcl/db_get.html#2 @db get -__APIREL__/api_tcl/db_get_join.html#2 @db get_join -__APIREL__/api_tcl/db_get_type.html#2 @db get_type -__APIREL__/api_tcl/db_is_byteswapped.html#2 @db is_byteswapped -__APIREL__/api_tcl/db_join.html#2 @db join -__APIREL__/api_tcl/db_open.html#2 @berkdb open -__APIREL__/api_tcl/db_put.html#2 @db put -__APIREL__/api_tcl/db_rename.html#2 @berkdb dbrename -__APIREL__/api_tcl/db_remove.html#2 @berkdb dbremove -__APIREL__/api_tcl/db_stat.html#2 @db stat -__APIREL__/api_tcl/db_sync.html#2 @db sync -__APIREL__/api_tcl/dbc_close.html#2 @db close -__APIREL__/api_tcl/dbc_del.html#2 @db del -__APIREL__/api_tcl/dbc_dup.html#2 @db dup -__APIREL__/api_tcl/dbc_get.html#2 @db get -__APIREL__/api_tcl/dbc_put.html#2 @dbc put -__APIREL__/api_tcl/env_close.html#2 @env close -__APIREL__/api_tcl/env_open.html#2 @berkdb env -__APIREL__/api_tcl/env_remove.html#2 @berkdb envremove -__APIREL__/api_tcl/txn.html#2 @env txn -__APIREL__/api_tcl/txn_abort.html#2 @txn abort -__APIREL__/api_tcl/txn_commit.html#2 @txn commit -__APIREL__/api_tcl/version.html#2 @berkdb version diff --git a/bdb/docs/api_tcl/tcl_index.html b/bdb/docs/api_tcl/tcl_index.html deleted file mode 100644 index a31c6fc82a1..00000000000 --- a/bdb/docs/api_tcl/tcl_index.html +++ /dev/null @@ -1,49 +0,0 @@ -<!--$Id: tcl_index.so,v 11.13 2000/04/24 17:31:12 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: Tcl Interface</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++"> -</head> -<body bgcolor=white> -<h1 align=center>Tcl Interface</h1> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<p><table border=1 align=center> -<tr><th>Tcl Command</th><th>Description</th></tr> -<tr><td><a href="../api_tcl/db_remove.html"><b>berkdb dbremove</b></a></td><td>Remove a database</td></tr> -<tr><td><a href="../api_tcl/db_rename.html"><b>berkdb dbrename</b></a></td><td>Rename a database</td></tr> -<tr><td><a href="../api_tcl/env_open.html"><b>berkdb env</b></a></td><td>Create an environment handle</td></tr> -<tr><td><a href="../api_tcl/env_remove.html"><b>berkdb envremove</b></a></td><td>Remove an environment</td></tr> -<tr><td><a href="../api_tcl/db_open.html"><b>berkdb open</b></a></td><td>Create a database handle</td></tr> -<tr><td><a href="../api_tcl/version.html"><b>berkdb version</b></a></td><td>Return version information</td></tr> -<tr><td><br></td><td><br></td></tr> -<tr><td><a href="../api_tcl/env_close.html"><i>env</i> <b>close</b></a></td><td>Close an environment</td></tr> -<tr><td><a href="../api_tcl/txn.html"><i>env</i> <b>txn</b></a></td><td>Begin a transaction</td></tr> -<tr><td><br></td><td><br></td></tr> -<tr><td><a href="../api_tcl/db_close.html"><i>db</i> <b>close</b></a></td><td>Close a database</td></tr> -<tr><td><a href="../api_tcl/db_count.html"><i>db</i> <b>count</b></a></td><td>Return a count of a key's data items</td></tr> -<tr><td><a href="../api_tcl/db_cursor.html"><i>db</i> <b>cursor</b></a></td><td>Open a cursor into a database</td></tr> -<tr><td><a href="../api_tcl/db_del.html"><i>db</i> <b>del</b></a></td><td>Delete items from a database</td></tr> -<tr><td><a href="../api_tcl/db_get.html"><i>db</i> <b>get</b></a></td><td>Get items from a database</td></tr> -<tr><td><a href="../api_tcl/db_get_join.html"><i>db</i> <b>get_join</b></a></td><td>Get items from a database join</td></tr> -<tr><td><a href="../api_tcl/db_get_type.html"><i>db</i> <b>get_type</b></a></td><td>Return the database type</td></tr> -<tr><td><a href="../api_tcl/db_is_byteswapped.html"><i>db</i> <b>is_byteswapped</b></a></td><td>Return if the underlying database is in host order</td></tr> -<tr><td><a href="../api_tcl/db_join.html"><i>db</i> <b>join</b></a></td><td>Perform a database join on cursors</td></tr> -<tr><td><a href="../api_tcl/db_put.html"><i>db</i> <b>put</b></a></td><td>Store items into a database</td></tr> -<tr><td><a href="../api_tcl/db_stat.html"><i>db</i> <b>stat</b></a></td><td>Return database statistics</td></tr> -<tr><td><a href="../api_tcl/db_sync.html"><i>db</i> <b>sync</b></a></td><td>Flush a database to stable storage</td></tr> -<tr><td><br></td><td><br></td></tr> -<tr><td><a href="../api_tcl/dbc_close.html"><i>dbc</i> <b>close</b></a></td><td>Close a cursor</td></tr> -<tr><td><a href="../api_tcl/dbc_del.html"><i>dbc</i> <b>del</b></a></td><td>Delete by cursor</td></tr> -<tr><td><a href="../api_tcl/dbc_dup.html"><i>dbc</i> <b>dup</b></a></td><td>Duplicate a cursor</td></tr> -<tr><td><a href="../api_tcl/dbc_get.html"><i>dbc</i> <b>get</b></a></td><td>Retrieve by cursor</td></tr> -<tr><td><a href="../api_tcl/dbc_put.html"><i>dbc</i> <b>put</b></a></td><td>Store by cursor</td></tr> -<tr><td><br></td><td><br></td></tr> -<tr><td><a href="../api_tcl/txn_abort.html"><i>txn</i> <b>abort</b></a></td><td>Abort a transaction</td></tr> -<tr><td><a href="../api_tcl/txn_commit.html"><i>txn</i> <b>commit</b></a></td><td>Commit a transaction</td></tr> -</table> -<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/tcl_pindex.html b/bdb/docs/api_tcl/tcl_pindex.html deleted file mode 100644 index c82153bad43..00000000000 --- a/bdb/docs/api_tcl/tcl_pindex.html +++ /dev/null @@ -1,258 +0,0 @@ -<html> -<head> -<title>Berkeley DB: Tcl Interface Index</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++"> -</head> -<body bgcolor=white> -<h1 align=center>Tcl Interface Index</h1> -<center> -<table cellspacing=0 cellpadding=0> -<tr><td align=right> configuring Berkeley DB </td><td><a href="../ref/build_unix/conf.html#5">1.85</a> API compatibility</td></tr> -<tr><td align=right> building a utility to dump Berkeley DB </td><td><a href="../ref/build_unix/conf.html#7">1.85</a> databases</td></tr> -<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.2.0/intro.html#2">2.0</a></td></tr> -<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.3.0/intro.html#2">3.0</a></td></tr> -<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.3.1/intro.html#2">3.1</a></td></tr> -<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.3.2/intro.html#2">3.2</a></td></tr> -<tr><td align=right> selecting an </td><td><a href="../ref/am_conf/select.html#2">access</a> method</td></tr> -<tr><td align=right> </td><td><a href="../ref/am_conf/intro.html#2">access</a> methods</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/aix.html#2">AIX</a></td></tr> -<tr><td align=right> programmatic </td><td><a href="../ref/arch/apis.html#2">APIs</a></td></tr> -<tr><td align=right> utility to </td><td><a href="../utility/db_archive.html#3">archive</a> log files</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_remove.html#2">berkdb</a> dbremove</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_rename.html#2">berkdb</a> dbrename</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/env_open.html#2">berkdb</a> env</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/env_remove.html#2">berkdb</a> envremove</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_open.html#2">berkdb</a> open</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/version.html#2">berkdb</a> version</td></tr> -<tr><td align=right> </td><td><a href="../utility/berkeley_db_svc.html#2">berkeley_db_svc</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/intro.html#2">building</a> for UNIX</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/notes.html#2">building</a> for UNIX FAQ</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_vxworks/intro.html#2">building</a> for VxWorks</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_vxworks/faq.html#2">building</a> for VxWorks FAQ</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_win/intro.html#2">building</a> for Win32</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_win/faq.html#2">building</a> for Windows FAQ</td></tr> -<tr><td align=right> selecting a </td><td><a href="../ref/am_conf/byteorder.html#2">byte</a> order</td></tr> -<tr><td align=right> </td><td><a href="../ref/program/byteorder.html#2">byte</a> ordering</td></tr> -<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#6">C++</a> API</td></tr> -<tr><td align=right> flushing the database </td><td><a href="../ref/am/sync.html#2">cache</a></td></tr> -<tr><td align=right> selecting a </td><td><a href="../ref/am_conf/cachesize.html#2">cache</a> size</td></tr> -<tr><td align=right> </td><td><a href="../ref/transapp/archival.html#3">catastrophic</a> recovery</td></tr> -<tr><td align=right>Patches, Updates and </td><td><a href="http://www.sleepycat.com/update/index.html">Change</a> logs</td></tr> -<tr><td align=right> utility to take </td><td><a href="../utility/db_checkpoint.html#3">checkpoints</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/am/curclose.html#2">closing</a> a cursor</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/close.html#2">closing</a> a database</td></tr> -<tr><td align=right> specifying a Btree </td><td><a href="../ref/am_conf/bt_compare.html#2">comparison</a> function</td></tr> -<tr><td align=right> changing </td><td><a href="../ref/build_unix/flags.html#2">compile</a> or load options</td></tr> -<tr><td align=right> </td><td><a href="../ref/cam/intro.html#2">Concurrent</a> Data Store</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/conf.html#2">configuring</a> Berkeley DB for UNIX systems</td></tr> -<tr><td align=right> recovering </td><td><a href="../ref/am/verify.html#4">corrupted</a> databases</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/count.html#2">counting</a> data items for a key</td></tr> -<tr><td align=right> closing a </td><td><a href="../ref/am/curclose.html#3">cursor</a></td></tr> -<tr><td align=right> deleting records with a </td><td><a href="../ref/am/curdel.html#3">cursor</a></td></tr> -<tr><td align=right> duplicating a </td><td><a href="../ref/am/curdup.html#3">cursor</a></td></tr> -<tr><td align=right> retrieving records with a </td><td><a href="../ref/am/curget.html#3">cursor</a></td></tr> -<tr><td align=right> storing records with a </td><td><a href="../ref/am/curput.html#3">cursor</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/am/stability.html#2">cursor</a> stability</td></tr> -<tr><td align=right> database </td><td><a href="../ref/am/cursor.html#2">cursors</a></td></tr> -<tr><td align=right> utility to upgrade </td><td><a href="../utility/db_upgrade.html#3">database</a> files</td></tr> -<tr><td align=right> utility to verify </td><td><a href="../utility/db_verify.html#3">database</a> files</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_close.html#2">db</a> close</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/dbc_close.html#2">db</a> close</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_count.html#2">db</a> count</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_cursor.html#2">db</a> cursor</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_del.html#2">db</a> del</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/dbc_del.html#2">db</a> del</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/dbc_dup.html#2">db</a> dup</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_get.html#2">db</a> get</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/dbc_get.html#2">db</a> get</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_get_join.html#2">db</a> get_join</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_get_type.html#2">db</a> get_type</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_is_byteswapped.html#2">db</a> is_byteswapped</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_join.html#2">db</a> join</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_put.html#2">db</a> put</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_stat.html#2">db</a> stat</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/db_sync.html#2">db</a> sync</td></tr> -<tr><td align=right> </td><td><a href="../utility/db_archive.html#2">db_archive</a></td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/dbc_put.html#2">dbc</a> put</td></tr> -<tr><td align=right> </td><td><a href="../utility/db_checkpoint.html#2">db_checkpoint</a></td></tr> -<tr><td align=right>File naming</td><td><a href="../ref/env/naming.html#DB_CONFIG">DB_CONFIG</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_deadlock.html#2">db_deadlock</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_dump.html#2">db_dump</a></td></tr> -<tr><td align=right>File naming</td><td><a href="../ref/env/naming.html#DB_HOME">DB_HOME</a></td></tr> -<tr><td align=right>File naming</td><td><a href="../ref/env/naming.html#db_home">db_home</a></td></tr> -<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_load.html#2">db_load</a></td></tr> -<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a></td></tr> -<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a></td></tr> -<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_printlog.html#2">db_printlog</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_recover.html#2">db_recover</a></td></tr> -<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_stat.html#2">db_stat</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_upgrade.html#2">db_upgrade</a></td></tr> -<tr><td align=right> </td><td><a href="../utility/db_verify.html#2">db_verify</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/dead.html#2">deadlocks</a></td></tr> -<tr><td align=right> utility to detect </td><td><a href="../utility/db_deadlock.html#3">deadlocks</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/debug/common.html#2">debugging</a> applications</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/delete.html#2">deleting</a> records</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/curdel.html#2">deleting</a> records with a cursor</td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--disable-bigfile">--disable-bigfile</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/program/diskspace.html#2">disk</a> space requirements</td></tr> -<tr><td align=right> utility to </td><td><a href="../utility/db_dump.html#3">dump</a> databases as text files</td></tr> -<tr><td align=right> </td><td><a href="../ref/am_conf/dup.html#2">duplicate</a> data items</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/curdup.html#2">duplicating</a> a cursor</td></tr> -<tr><td align=right> configuring </td><td><a href="../ref/build_unix/conf.html#9">dynamic</a> shared libraries</td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-compat185">--enable-compat185</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-cxx">--enable-cxx</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-debug">--enable-debug</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-debug_rop">--enable-debug_rop</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-debug_wop">--enable-debug_wop</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-diagnostic">--enable-diagnostic</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-dump185">--enable-dump185</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-dynamic">--enable-dynamic</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-java">--enable-java</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-posixmutexes">--enable-posixmutexes</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-rpc">--enable-rpc</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-shared">--enable-shared</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-tcl">--enable-tcl</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-test">--enable-test</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-uimutexes">--enable-uimutexes</a></td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-umrw">--enable-umrw</a></td></tr> -<tr><td align=right> byte </td><td><a href="../ref/program/byteorder.html#3">endian</a></td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/env_close.html#2">env</a> close</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/txn.html#2">env</a> txn</td></tr> -<tr><td align=right> database </td><td><a href="../ref/env/create.html#2">environment</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/program/environ.html#2">environment</a> variables</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/error.html#2">error</a> handling</td></tr> -<tr><td align=right> </td><td><a href="../ref/program/errorret.html#3">error</a> name space</td></tr> -<tr><td align=right> </td><td><a href="../ref/program/errorret.html#2">error</a> returns</td></tr> -<tr><td align=right> </td><td><a href="../ref/install/file.html#2">/etc/magic</a></td></tr> -<tr><td align=right> selecting a Queue </td><td><a href="../ref/am_conf/extentsize.html#2">extent</a> size</td></tr> -<tr><td align=right> Java </td><td><a href="../ref/java/faq.html#2">FAQ</a></td></tr> -<tr><td align=right> Tcl </td><td><a href="../ref/tcl/faq.html#2">FAQ</a></td></tr> -<tr><td align=right> configuring without large </td><td><a href="../ref/build_unix/conf.html#4">file</a> support</td></tr> -<tr><td align=right> </td><td><a href="../ref/install/file.html#3">file</a> utility</td></tr> -<tr><td align=right> recovery and </td><td><a href="../ref/transapp/filesys.html#2">filesystem</a> operations</td></tr> -<tr><td align=right> remote </td><td><a href="../ref/env/remote.html#2">filesystems</a></td></tr> -<tr><td align=right> page </td><td><a href="../ref/am_conf/h_ffactor.html#2">fill</a> factor</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/freebsd.html#2">FreeBSD</a></td></tr> -<tr><td align=right> Berkeley DB </td><td><a href="../ref/program/scope.html#3">free-threaded</a> handles</td></tr> -<tr><td align=right> specifying a database </td><td><a href="../ref/am_conf/h_hash.html#2">hash</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/am_conf/h_nelem.html#2">hash</a> table size</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/hpux.html#2">HP-UX</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/install.html#2">installing</a> Berkeley DB for UNIX systems</td></tr> -<tr><td align=right> </td><td><a href="../ref/program/compatible.html#2">interface</a> compatibility</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/irix.html#2">IRIX</a></td></tr> -<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#10">Java</a> API</td></tr> -<tr><td align=right> </td><td><a href="../ref/java/compat.html#2">Java</a> compatibility</td></tr> -<tr><td align=right> </td><td><a href="../ref/java/conf.html#2">Java</a> configuration</td></tr> -<tr><td align=right> </td><td><a href="../ref/java/faq.html#3">Java</a> FAQ</td></tr> -<tr><td align=right> logical </td><td><a href="../ref/am/join.html#2">join</a></td></tr> -<tr><td align=right> database </td><td><a href="../ref/program/dbsizes.html#2">limits</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/linux.html#2">Linux</a></td></tr> -<tr><td align=right> changing compile or </td><td><a href="../ref/build_unix/flags.html#3">load</a> options</td></tr> -<tr><td align=right> utility to </td><td><a href="../utility/db_load.html#3">load</a> text files into databases</td></tr> -<tr><td align=right> standard </td><td><a href="../ref/lock/stdmode.html#2">lock</a> modes</td></tr> -<tr><td align=right> page-level </td><td><a href="../ref/lock/page.html#2">locking</a></td></tr> -<tr><td align=right> two-phase </td><td><a href="../ref/lock/twopl.html#2">locking</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/nondb.html#2">locking</a> and non-Berkeley DB applications</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/config.html#2">locking</a> configuration</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/am_conv.html#2">locking</a> conventions</td></tr> -<tr><td align=right> Berkeley DB Concurrent Data Store </td><td><a href="../ref/lock/cam_conv.html#2">locking</a> conventions</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/intro.html#2">locking</a> introduction</td></tr> -<tr><td align=right> sizing the </td><td><a href="../ref/lock/max.html#2">locking</a> subsystem</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/notxn.html#2">locking</a> without transactions</td></tr> -<tr><td align=right> </td><td><a href="../ref/log/limits.html#2">log</a> file limits</td></tr> -<tr><td align=right> </td><td><a href="../ref/transapp/logfile.html#2">log</a> file removal</td></tr> -<tr><td align=right> utility to display </td><td><a href="../utility/db_printlog.html#3">log</a> files as text</td></tr> -<tr><td align=right> </td><td><a href="../ref/log/config.html#2">logging</a> configuration</td></tr> -<tr><td align=right> </td><td><a href="../ref/log/intro.html#2">logging</a> introduction</td></tr> -<tr><td align=right> </td><td><a href="../ref/mp/config.html#2">memory</a> pool configuration</td></tr> -<tr><td align=right> Berkeley DB library </td><td><a href="../ref/program/namespace.html#2">name</a> spaces</td></tr> -<tr><td align=right> file </td><td><a href="../ref/env/naming.html#2">naming</a></td></tr> -<tr><td align=right> retrieving Btree records by </td><td><a href="../ref/am_conf/bt_recnum.html#2">number</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/am/open.html#2">opening</a> a database</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/osf1.html#2">OSF/1</a></td></tr> -<tr><td align=right> selecting a </td><td><a href="../ref/am_conf/pagesize.html#2">page</a> size</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/partial.html#2">partial</a> record storage and retrieval</td></tr> -<tr><td align=right></td><td><a href="http://www.sleepycat.com/update/index.html">Patches,</a> Updates and Change logs</td></tr> -<tr><td align=right> </td><td><a href="../ref/perl/intro.html#2">Perl</a></td></tr> -<tr><td align=right> Sleepycat Software's Berkeley DB </td><td><a href="../ref/intro/products.html#2">products</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/qnx.html#2">QNX</a></td></tr> -<tr><td align=right> logical </td><td><a href="../ref/am_conf/logrec.html#2">record</a> numbers</td></tr> -<tr><td align=right> managing </td><td><a href="../ref/am_conf/recno.html#2">record-based</a> databases</td></tr> -<tr><td align=right> logically renumbering </td><td><a href="../ref/am_conf/renumber.html#2">records</a></td></tr> -<tr><td align=right> utility to </td><td><a href="../utility/db_recover.html#3">recover</a> database environments</td></tr> -<tr><td align=right> Berkeley DB </td><td><a href="../ref/transapp/reclimit.html#2">recoverability</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/am/get.html#2">retrieving</a> records</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/curget.html#2">retrieving</a> records with a cursor</td></tr> -<tr><td align=right> </td><td><a href="../ref/rpc/client.html#2">RPC</a> client</td></tr> -<tr><td align=right> configuring a </td><td><a href="../ref/build_unix/conf.html#11">RPC</a> client/server</td></tr> -<tr><td align=right> utility to support </td><td><a href="../utility/berkeley_db_svc.html#3">RPC</a> client/server</td></tr> -<tr><td align=right> </td><td><a href="../ref/rpc/server.html#2">RPC</a> server</td></tr> -<tr><td align=right> database </td><td><a href="../ref/am/verify.html#3">salvage</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/sco.html#2">SCO</a></td></tr> -<tr><td align=right> Berkeley DB handle </td><td><a href="../ref/program/scope.html#2">scope</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/env/security.html#2">security</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/sendmail/intro.html#2">Sendmail</a></td></tr> -<tr><td align=right> configuring </td><td><a href="../ref/build_unix/conf.html#8">shared</a> libraries</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/shlib.html#2">shared</a> libraries</td></tr> -<tr><td align=right> application </td><td><a href="../ref/program/appsignals.html#2">signal</a> handling</td></tr> -<tr><td align=right></td><td><a href="http://www.sleepycat.com/">Sleepycat</a> Software</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/solaris.html#2">Solaris</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/distrib/layout.html#2">source</a> code layout</td></tr> -<tr><td align=right> cursor </td><td><a href="../ref/am/stability.html#3">stability</a></td></tr> -<tr><td align=right> database </td><td><a href="../ref/am/stat.html#2">statistics</a></td></tr> -<tr><td align=right> utility to display database and environment </td><td><a href="../utility/db_stat.html#3">statistics</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/am/put.html#2">storing</a> records</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/curput.html#2">storing</a> records with a cursor</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/sunos.html#2">SunOS</a></td></tr> -<tr><td align=right> loading Berkeley DB with </td><td><a href="../ref/tcl/intro.html#2">Tcl</a></td></tr> -<tr><td align=right> using Berkeley DB with </td><td><a href="../ref/tcl/using.html#2">Tcl</a></td></tr> -<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#12">Tcl</a> API</td></tr> -<tr><td align=right> </td><td><a href="../ref/tcl/program.html#2">Tcl</a> API programming notes</td></tr> -<tr><td align=right> </td><td><a href="../ref/tcl/faq.html#3">Tcl</a> FAQ</td></tr> -<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#13">test</a> suite</td></tr> -<tr><td align=right> running the </td><td><a href="../ref/test/run.html#2">test</a> suite</td></tr> -<tr><td align=right> running the </td><td><a href="../ref/build_unix/test.html#2">test</a> suite under UNIX</td></tr> -<tr><td align=right> running the </td><td><a href="../ref/build_win/test.html#2">test</a> suite under Windows</td></tr> -<tr><td align=right> </td><td><a href="../ref/am_conf/re_source.html#2">text</a> backing files</td></tr> -<tr><td align=right> loading </td><td><a href="../ref/dumpload/text.html#2">text</a> into databases</td></tr> -<tr><td align=right> dumping/loading </td><td><a href="../ref/dumpload/utility.html#2">text</a> to/from databases</td></tr> -<tr><td align=right> building </td><td><a href="../ref/program/mt.html#2">threaded</a> applications</td></tr> -<tr><td align=right> </td><td><a href="../ref/txn/config.html#2">transaction</a> configuration</td></tr> -<tr><td align=right> </td><td><a href="../ref/txn/limits.html#2">transaction</a> limits</td></tr> -<tr><td align=right> administering </td><td><a href="../ref/transapp/admin.html#2">transaction</a> protected applications</td></tr> -<tr><td align=right> archival in </td><td><a href="../ref/transapp/archival.html#2">transaction</a> protected applications</td></tr> -<tr><td align=right> checkpoints in </td><td><a href="../ref/transapp/checkpoint.html#2">transaction</a> protected applications</td></tr> -<tr><td align=right> deadlock detection in </td><td><a href="../ref/transapp/deadlock.html#2">transaction</a> protected applications</td></tr> -<tr><td align=right> recovery in </td><td><a href="../ref/transapp/recovery.html#2">transaction</a> protected applications</td></tr> -<tr><td align=right> </td><td><a href="../ref/transapp/throughput.html#2">transaction</a> throughput</td></tr> -<tr><td align=right> </td><td><a href="../ref/transapp/intro.html#2">Transactional</a> Data Store</td></tr> -<tr><td align=right> Berkeley DB and </td><td><a href="../ref/txn/intro.html#2">transactions</a></td></tr> -<tr><td align=right> nested </td><td><a href="../ref/txn/nested.html#2">transactions</a></td></tr> -<tr><td align=right> configuring Berkeley DB with the </td><td><a href="../ref/xa/config.html#2">Tuxedo</a> System</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/txn_abort.html#2">txn</a> abort</td></tr> -<tr><td align=right> </td><td><a href="../api_tcl/txn_commit.html#2">txn</a> commit</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_unix/ultrix.html#2">Ultrix</a></td></tr> -<tr><td align=right> building for </td><td><a href="../ref/build_unix/notes.html#3">UNIX</a> FAQ</td></tr> -<tr><td align=right> configuring Berkeley DB for </td><td><a href="../ref/build_unix/conf.html#3">UNIX</a> systems</td></tr> -<tr><td align=right>Patches, </td><td><a href="http://www.sleepycat.com/update/index.html">Updates</a> and Change logs</td></tr> -<tr><td align=right> utility to </td><td><a href="../utility/db_upgrade.html#4">upgrade</a> database files</td></tr> -<tr><td align=right> </td><td><a href="../ref/am/upgrade.html#2">upgrading</a> databases</td></tr> -<tr><td align=right> </td><td><a href="../ref/arch/utilities.html#2">utilities</a></td></tr> -<tr><td align=right> database </td><td><a href="../ref/am/verify.html#2">verification</a></td></tr> -<tr><td align=right> utility to </td><td><a href="../utility/db_verify.html#4">verify</a> database files</td></tr> -<tr><td align=right> building for </td><td><a href="../ref/build_vxworks/faq.html#3">VxWorks</a> FAQ</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_vxworks/notes.html#2">VxWorks</a> notes</td></tr> -<tr><td align=right> running the test suite under </td><td><a href="../ref/build_win/test.html#3">Windows</a></td></tr> -<tr><td align=right> building for </td><td><a href="../ref/build_win/faq.html#3">Windows</a> FAQ</td></tr> -<tr><td align=right> </td><td><a href="../ref/build_win/notes.html#2">Windows</a> notes</td></tr> -<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--with-tcl=DIR">--with-tcl=DIR</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/xa/intro.html#2">XA</a> Resource Manager</td></tr> -</table> -</center> -<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/txn.html b/bdb/docs/api_tcl/txn.html deleted file mode 100644 index 4e66a96a6ae..00000000000 --- a/bdb/docs/api_tcl/txn.html +++ /dev/null @@ -1,62 +0,0 @@ -<!--$Id: txn.so,v 11.12 2000/02/19 20:57:57 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>env</i> <b>txn</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>env txn - [-nosync] - [-nowait] - [-parent txnid] - [-sync] -</pre></h3> -<h1>Description</h1> -<p>The <i>env</i> <b>txn</b> command begins a transaction. The returned transaction -handle is bound to a Tcl command of the form <b>env.txnX</b>, where X -is an integer starting at 0 (e.g., env0.txn0 and env0.txn1). It is -through this Tcl command that the script accesses the transaction methods. -<p>The options are as follows: -<p><dl compact> -<p><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), i.e., -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> interface. -<p><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 -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. This -means the transaction will exhibit all of the ACID (atomicity, consistency -and isolation and durability) properties. -<p>This behavior is the default for Berkeley DB environments unless the -<b>-nosync</b> option was specified to the <b>berkdb env</b> interface. -</dl> -<p>The <i>env</i> <b>txn</b> command returns a transaction handle on success. -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/txn_abort.html b/bdb/docs/api_tcl/txn_abort.html deleted file mode 100644 index 8b147883f6d..00000000000 --- a/bdb/docs/api_tcl/txn_abort.html +++ /dev/null @@ -1,45 +0,0 @@ -<!--$Id: txn_abort.so,v 11.12 2000/06/28 14:30:15 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>txn</i> <b>abort</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>txn abort -</pre></h3> -<h1>Description</h1> -<p>The <i>txn</i> <b>abort</b> command causes an abnormal termination of the -transaction. -<p>The log is played backwards and any necessary recovery operations are -performed. After recovery is completed, all locks held by the -transaction are acquired by the parent transaction in the case of a -nested transaction or released in the case of a non-nested transaction. -As is the case for <i>txn</i> <b>commit</b>, applications that require strict -two-phase locking should not explicitly release any locks. -<p>In the case of nested transactions, aborting the parent transaction -causes all children of that transaction to be aborted. -<p>Once <i>txn</i> <b>abort</b> has been called, regardless of its return, the -<b>txn</b> handle may not be accessed again. -<p>The <i>txn</i> <b>abort</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/txn_commit.html b/bdb/docs/api_tcl/txn_commit.html deleted file mode 100644 index acd1f2d1b29..00000000000 --- a/bdb/docs/api_tcl/txn_commit.html +++ /dev/null @@ -1,68 +0,0 @@ -<!--$Id: txn_commit.so,v 11.14 2000/06/28 14:30:15 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><i>txn</i> <b>commit</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>txn commit - [-nosync] - [-sync] -</pre></h3> -<h1>Description</h1> -<p>The <i>txn</i> <b>commit</b> command ends the transaction. -<p>In the case of nested transactions, if the transaction is a parent -transaction with unresolved (neither committed or aborted) child -transactions, the child transactions are aborted and the commit of the -parent will succeed. -<p>In the case of nested transactions, if the transaction is a child -transaction, its locks are not released, but are acquired by its parent. -While the commit of the child transaction will succeed, the actual -resolution of the child transaction is postponed until the parent -transaction is committed or aborted, i.e., if its parent transaction -commits, it will be committed, and if its parent transaction aborts, it -will be aborted. -<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>The options are as follows: -<p><dl compact> -<p><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), i.e., 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> interface. -<p><dt>-sync<dd>Synchronously flush the log. This means the transaction will exhibit all of -the ACID (atomicity, consistency and isolation and durability) properties. -<p>This behavior is the default for Berkeley DB environments unless the -<b>-nosync</b> option was specified to the <b>berkdb env</b> or -<i>env</i> <b>txn</b> interfaces. -</dl> -<p>Once <i>txn</i> <b>commit</b> has been called, regardless of its return, the -<b>txn</b> handle may not be accessed again. If <i>txn</i> <b>commit</b> -encounters an error, then this transaction and all child transactions -of this transaction are aborted. -<p>The <i>txn</i> <b>commit</b> command returns 0 on success, and in the case of error, a Tcl error -is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> diff --git a/bdb/docs/api_tcl/version.html b/bdb/docs/api_tcl/version.html deleted file mode 100644 index ab4b901f1e9..00000000000 --- a/bdb/docs/api_tcl/version.html +++ /dev/null @@ -1,39 +0,0 @@ -<!--$Id: version.so,v 11.10 1999/12/20 08:52:35 bostic Exp $--> -<!--$Id: m4.tcl,v 11.17 2000/04/24 17:31:11 sue Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<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++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1><b>berkdb version</b></h1> -</td> -<td width="1%"> -<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> -<hr size=1 noshade> -<tt> -<h3><pre>berkdb version - [-string] -</pre></h3> -<h1>Description</h1> -<p>Return a list of the form {major minor patch} for the major, minor and -patch levels of the underlying Berkeley DB release. -<p>The options are as follows: -<p><dl compact> -<p><dt>-string<dd>Return a string with formatted Berkeley DB version information. -</dl> -<p>In the case of error, a Tcl error is thrown. -</tt> -<table><tr><td><br></td><td width="1%"> -<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="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> -</body> -</html> |