diff options
| author | jbj <devnull@localhost> | 2002-09-19 20:33:51 +0000 |
|---|---|---|
| committer | jbj <devnull@localhost> | 2002-09-19 20:33:51 +0000 |
| commit | 4a15060bcbf38c550f7dcc86ceff277854f9eecf (patch) | |
| tree | aa3e3172c87f3f74ea72d72f342f68c4be652c73 /db | |
| parent | 0fd303f38a72c9a465081a7b1b9a77f7d181fd84 (diff) | |
| download | rpm-4a15060bcbf38c550f7dcc86ceff277854f9eecf.tar.gz rpm-4a15060bcbf38c550f7dcc86ceff277854f9eecf.tar.bz2 rpm-4a15060bcbf38c550f7dcc86ceff277854f9eecf.zip | |
Initial revision
CVS patchset: 5721
CVS date: 2002/09/19 20:33:51
Diffstat (limited to 'db')
51 files changed, 2392 insertions, 0 deletions
diff --git a/db/dist/s_javah b/db/dist/s_javah new file mode 100755 index 000000000..fadbb1c58 --- /dev/null +++ b/db/dist/s_javah @@ -0,0 +1,55 @@ +#!/bin/sh - +# Id: s_javah,v 1.1 2002/08/14 17:14:24 dda Exp +# +# Use javah to build the libdb_java/com_*.h header files. +# +# To run this, you will need a javac and javah in your PATH. +# If possible, install tools with a recent vintage, JDK 1.3 or higher is good. +# Using Sun's JDK rather than some other installation ensures +# that the header files will not be constantly changed. + +. RELEASE + +JAVAC=javac +JAVAH=javah +export CLASSPATH +CLASSPATH= + +# CLASSES are only those classes for which we have native methods. +D=com.sleepycat.db +CLASSES="$D.Dbc $D.DbEnv $D.Db $D.DbLock $D.DbLogc $D.DbLsn $D.Dbt $D.DbTxn $D.xa.DbXAResource" + +d=/tmp/__javah +c=$d/classes +trap 'rm -rf $d; exit 0' 0 1 2 3 13 15 + +rm -rf $d +mkdir $d || exit 1 +mkdir $c || exit 1 + +# Make skeleton versions of XA classes and interfaces +# We only need to compile them, not run them. +pkg="package javax.transaction.xa" +echo "$pkg; public interface XAResource {}" > $d/XAResource.java +echo "$pkg; public interface Xid {}" > $d/Xid.java +echo "$pkg; public class XAException extends Exception {}" \ + > $d/XAException.java + + +# Create the .class files and use them with javah to create the .h files +${JAVAC} -d $c $d/*.java \ + ../java/src/com/sleepycat/db/*.java \ + ../java/src/com/sleepycat/db/xa/*.java || exit 1 +${JAVAH} -classpath $c -d $d ${CLASSES} || exit 1 + +for cl in ${CLASSES}; do + h=`echo $cl | sed -e 's/\./_/g'`.h + t=$d/$h + f=../libdb_java/$h + if [ ! -f $t ]; then + echo "ERROR: $t does not exist" + exit 1 + fi + cmp $t $f > /dev/null 2>&1 || + (echo "Building $f" && rm -f $f && cp $t $f && chmod 444 $f) +done diff --git a/db/docs/api_c/db_class.html b/db/docs/api_c/db_class.html new file mode 100644 index 000000000..aced4a8c3 --- /dev/null +++ b/db/docs/api_c/db_class.html @@ -0,0 +1,50 @@ +<!--Id: db_class.so,v 10.36 2002/08/29 03:24:30 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB</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 width="100%"><tr valign=top> +<td> +<h1>DB</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db DB; +</pre></h3> +<h1>Description</h1> +<p>The DB handle is the handle for a Berkeley DB database, which may or +may not be part of a database environment. DB handles are +free-threaded if the <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag is specified to the +<a href="../api_c/db_open.html">DB->open</a> method when the database is opened or if the database +environment in which the database is opened is free-threaded. The +handle should not be closed while any other handle that refers to the +database is in use; for example, database handles must not be closed +while cursor handles into the database remain open, or transactions that +include operations on the database have not yet been committed or +aborted. Once the <a href="../api_c/db_close.html">DB->close</a>, <a href="../api_c/db_remove.html">DB->remove</a>, or +<a href="../api_c/db_rename.html">DB->rename</a> methods are called, the handle may not be accessed again, +regardless of the function's return. +<h1>Class</h1> +DB +<h1>See Also</h1> +<a href="../api_c/db_list.html">Databases and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/db_list.html b/db/docs/api_c/db_list.html new file mode 100644 index 000000000..07782f8b7 --- /dev/null +++ b/db/docs/api_c/db_list.html @@ -0,0 +1,67 @@ +<!--Id: db_list.so,v 1.1 2002/08/30 20:00:48 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Databases and Related Methods</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>Berkeley DB: Databases and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:48 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Databases and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/db_create.html">db_create</a></td><td>Create a database handle</td></tr> +<tr><td><a href="../api_c/db_associate.html">DB->associate</a></td><td>Associate a secondary index</td></tr> +<tr><td><a href="../api_c/db_close.html">DB->close</a></td><td>Close a database</td></tr> +<tr><td><a href="../api_c/db_cursor.html">DB->cursor</a></td><td>Create a cursor handle</td></tr> +<tr><td><a href="../api_c/db_del.html">DB->del</a></td><td>Delete items from a database</td></tr> +<tr><td><a href="../api_c/db_err.html">DB->err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_c/db_err.html">DB->errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_c/db_fd.html">DB->fd</a></td><td>Return a file descriptor from a database</td></tr> +<tr><td><a href="../api_c/db_get.html">DB->get</a></td><td>Get items from a database</td></tr> +<tr><td><a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a></td><td>Return if the underlying database is in host order</td></tr> +<tr><td><a href="../api_c/db_get_type.html">DB->get_type</a></td><td>Return the database type</td></tr> +<tr><td><a href="../api_c/db_join.html">DB->join</a></td><td>Perform a database join on cursors</td></tr> +<tr><td><a href="../api_c/db_key_range.html">DB->key_range</a></td><td>Return estimate of key location</td></tr> +<tr><td><a href="../api_c/db_open.html">DB->open</a></td><td>Open a database</td></tr> +<tr><td><a href="../api_c/db_get.html">DB->pget</a></td><td>Get items from a database</td></tr> +<tr><td><a href="../api_c/db_put.html">DB->put</a></td><td>Store items into a database</td></tr> +<tr><td><a href="../api_c/db_remove.html">DB->remove</a></td><td>Remove a database</td></tr> +<tr><td><a href="../api_c/db_rename.html">DB->rename</a></td><td>Rename a database</td></tr> +<tr><td><a href="../api_c/db_set_alloc.html">DB->set_alloc</a></td><td>Set local space allocation functions</td></tr> +<tr><td><a href="../api_c/db_set_append_recno.html">DB->set_append_recno</a></td><td>Set record append callback</td></tr> +<tr><td><a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a></td><td>Set a Btree comparison function</td></tr> +<tr><td><a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a></td><td>Set the minimum number of keys per Btree page</td></tr> +<tr><td><a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a></td><td>Set a Btree prefix comparison function</td></tr> +<tr><td><a href="../api_c/db_set_cache_priority.html">DB->set_cache_priority</a></td><td>Set the database cache priority</td></tr> +<tr><td><a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a></td><td>Set the database cache size</td></tr> +<tr><td><a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a></td><td>Set a duplicate comparison function</td></tr> +<tr><td><a href="../api_c/db_set_encrypt.html">DB->set_encrypt</a></td><td>Set the database cryptographic key</td></tr> +<tr><td><a href="../api_c/db_set_errcall.html">DB->set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_c/db_set_errfile.html">DB->set_errfile</a></td><td>Set error message FILE</td></tr> +<tr><td><a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_c/db_set_feedback.html">DB->set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_c/db_set_flags.html">DB->set_flags</a></td><td>General database configuration</td></tr> +<tr><td><a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a></td><td>Set the Hash table density</td></tr> +<tr><td><a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a></td><td>Set a hashing function</td></tr> +<tr><td><a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a></td><td>Set the Hash table size</td></tr> +<tr><td><a href="../api_c/db_set_lorder.html">DB->set_lorder</a></td><td>Set the database byte order</td></tr> +<tr><td><a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a></td><td>Set the underlying database page size</td></tr> +<tr><td><a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a></td><td>Set panic callback</td></tr> +<tr><td><a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a></td><td>Set Queue database extent size</td></tr> +<tr><td><a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a></td><td>Set the variable-length record delimiter</td></tr> +<tr><td><a href="../api_c/db_set_re_len.html">DB->set_re_len</a></td><td>Set the fixed-length record length</td></tr> +<tr><td><a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a></td><td>Set the fixed-length record pad byte</td></tr> +<tr><td><a href="../api_c/db_set_re_source.html">DB->set_re_source</a></td><td>Set the backing Recno text file</td></tr> +<tr><td><a href="../api_c/db_stat.html">DB->stat</a></td><td>Return database statistics</td></tr> +<tr><td><a href="../api_c/db_sync.html">DB->sync</a></td><td>Flush a database to stable storage</td></tr> +<tr><td><a href="../api_c/db_truncate.html">DB->truncate</a></td><td>Empty a database</td></tr> +<tr><td><a href="../api_c/db_upgrade.html">DB->upgrade</a></td><td>Upgrade a database</td></tr> +<tr><td><a href="../api_c/db_verify.html">DB->verify</a></td><td>Verify/salvage a database</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/dbc_class.html b/db/docs/api_c/dbc_class.html new file mode 100644 index 000000000..be55405f7 --- /dev/null +++ b/db/docs/api_c/dbc_class.html @@ -0,0 +1,41 @@ +<!--Id: dbc_class.so,v 10.16 2002/08/24 18:22:33 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DBC</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 width="100%"><tr valign=top> +<td> +<h1>DBC</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __dbc DBC; +</pre></h3> +<h1>Description</h1> +<p>The DBC object is the handle for a cursor into a Berkeley DB database. +The handle is not free-threaded, and cursors may not span threads; nor +may cursors be used by more than a single thread. If the cursor is to +be used to perform operations on behalf of a transaction, the cursor +must be opened and closed within the context of that single transaction. +Once <a href="../api_c/dbc_close.html">DBcursor->c_close</a> has been called, the handle may not be accessed +again, regardless of the method's return. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/dbc_list.html b/db/docs/api_c/dbc_list.html new file mode 100644 index 000000000..4fd0adefa --- /dev/null +++ b/db/docs/api_c/dbc_list.html @@ -0,0 +1,27 @@ +<!--Id: dbc_list.so,v 1.1 2002/08/30 20:00:49 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Database Cursors and Related Methods</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>Berkeley DB: Database Cursors and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:49 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Database Cursors and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/db_cursor.html">DB->cursor</a></td><td>Create a cursor handle</td></tr> +<tr><td><a href="../api_c/dbc_close.html">DBcursor->c_close</a></td><td>Close a cursor</td></tr> +<tr><td><a href="../api_c/dbc_count.html">DBcursor->c_count</a></td><td>Return count of duplicates</td></tr> +<tr><td><a href="../api_c/dbc_del.html">DBcursor->c_del</a></td><td>Delete by cursor</td></tr> +<tr><td><a href="../api_c/dbc_dup.html">DBcursor->c_dup</a></td><td>Duplicate a cursor</td></tr> +<tr><td><a href="../api_c/dbc_get.html">DBcursor->c_get</a></td><td>Retrieve by cursor</td></tr> +<tr><td><a href="../api_c/dbc_get.html">DBcursor->c_pget</a></td><td>Retrieve by cursor</td></tr> +<tr><td><a href="../api_c/dbc_put.html">DBcursor->c_put</a></td><td>Store by cursor</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/dbt_class.html b/db/docs/api_c/dbt_class.html new file mode 100644 index 000000000..d138a720f --- /dev/null +++ b/db/docs/api_c/dbt_class.html @@ -0,0 +1,137 @@ +<!--Id: dbt_class.so,v 10.1 2002/08/24 18:22:30 bostic Exp --> +<!--Id: dbt_c.so,v 10.47 2002/08/29 03:24:33 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DBT</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 width="100%"><tr valign=top> +<td> +<h1>DBT: Key/Data Pairs</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<a name="3"><!--meow--></a> +<p>Storage and retrieval for the Berkeley DB access methods are based on key/data +pairs. Both key and data items are represented by the DBT data +structure. (The name <i>DBT</i> is a mnemonic for <i>data +base thang</i>, and was used because no one could think of a reasonable +name that wasn't already in use somewhere else.) Key and data byte +strings may refer to strings of zero length up to strings of +essentially unlimited length. See <a href="../ref/am_misc/dbsizes.html">Database limits</a> for more information. +<p><blockquote><pre>typedef struct { + void *data; + u_int32_t size; + u_int32_t ulen; + u_int32_t dlen; + u_int32_t doff; + u_int32_t flags; +} DBT;</pre></blockquote> +<p>In order to ensure compatibility with future releases of Berkeley DB, all +fields of the DBT structure that are not explicitly set should be +initialized to nul bytes before the first time the structure is used. +Do this by declaring the structure external or static, or by calling +the C library routine <b>bzero</b>(3) or <b>memset</b>(3). +<p>By default, the <b>flags</b> structure element is expected to be set +to 0. In this default case, when the application is providing Berkeley DB a +key or data item to store into the database, Berkeley DB expects the +<b>data</b> structure element to point to a byte string of <b>size</b> +bytes. When returning a key/data item to the application, Berkeley DB will +store into the <b>data</b> structure element a pointer to a byte string +of <b>size</b> bytes, and the memory to which the pointer refers will be +allocated and managed by Berkeley DB. +<p>The elements of the DBT structure are defined as follows: +<p><dl compact> +<p><dt>void *<a name="data">data</a>;<dd>A pointer to a byte string. +<p><dt>u_int32_t <a name="size">size</a>;<dd>The length of <b>data</b>, in bytes. +<p><dt>u_int32_t <a name="ulen">ulen</a>;<dd>The size of the user's buffer (to which <b>data</b> refers), in bytes. +This location is not written by the Berkeley DB functions. +<p>Note that applications can determine the length of a record by setting +the <b>ulen</b> field to 0 and checking the return value in the +<b>size</b> field. See the DB_DBT_USERMEM flag for more information. +<p><dt>u_int32_t <a name="dlen">dlen</a>;<dd>The length of the partial record being read or written by the application, +in bytes. See the DB_DBT_PARTIAL flag for more information. +<p><dt>u_int32_t <a name="doff">doff</a>;<dd>The offset of the partial record being read or written by the application, +in bytes. See the DB_DBT_PARTIAL flag for more information. +<p><dt>u_int32_t flags;<dd> +<p>The <b>flags</b> value must be set to 0 or by bitwise inclusively <b>OR</b>'ing together one or +more of the following values: +<p><dl compact> +<p><dt><a name="DB_DBT_MALLOC">DB_DBT_MALLOC</a><dd>When this flag is set, Berkeley DB will allocate memory for the returned key +or data item (using <b>malloc</b>(3), or the user-specified malloc +function), and return a pointer to it in the <b>data</b> field of the +key or data DBT structure. Because any allocated memory becomes the +responsibility of the calling application, the caller must determine +whether memory was allocated using the returned value of the +<b>data</b> field. +<p>It is an error to specify more than one of DB_DBT_MALLOC, +DB_DBT_REALLOC, and DB_DBT_USERMEM. +<p><dt><a name="DB_DBT_REALLOC">DB_DBT_REALLOC</a><dd>When this flag is set Berkeley DB will allocate memory for the returned key +or data item (using <b>realloc</b>(3), or the user-specified realloc +function), and return a pointer to it in the <b>data</b> field of the +key or data DBT structure. Because any allocated memory becomes the +responsibility of the calling application, the caller must determine +whether memory was allocated using the returned value of the +<b>data</b> field. +<p>The difference between DB_DBT_MALLOC and DB_DBT_REALLOC +is that the latter will call <b>realloc</b>(3) instead of +<b>malloc</b>(3), so the allocated memory will be grown as necessary +instead of the application doing repeated free/malloc calls. +<p>It is an error to specify more than one of DB_DBT_MALLOC, +DB_DBT_REALLOC, and DB_DBT_USERMEM. +<p><dt><a name="DB_DBT_USERMEM">DB_DBT_USERMEM</a><dd>The <b>data</b> field of the key or data structure must refer to +memory that is at least <b>ulen</b> bytes in length. If the length of +the requested item is less than or equal to that number of bytes, the +item is copied into the memory to which the <b>data</b> field refers. +Otherwise, the <b>size</b> field is set to the length needed for the +requested item, and the error ENOMEM is returned. +<p>It is an error to specify more than one of DB_DBT_MALLOC, +DB_DBT_REALLOC, and DB_DBT_USERMEM. +<p><dt><a name="DB_DBT_PARTIAL">DB_DBT_PARTIAL</a><dd>Do partial retrieval or storage of an item. If the calling application +is doing a get, 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 get is successful, and any existing bytes +are returned. +<p>For example, if the data portion of a retrieved record was 100 bytes, +and a partial retrieval was done using a DBT having a <b>dlen</b> +field of 20 and a <b>doff</b> field of 85, the get call would succeed, +the <b>data</b> field would refer to the last 15 bytes of the record, +and the <b>size</b> field would be set to 15. +<p>If the calling application is doing a put, 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 <b>data</b> and +<b>size</b> structure elements. If <b>dlen</b> is smaller than +<b>size</b>, the record will grow; if <b>dlen</b> is larger than +<b>size</b>, the record will shrink. If the specified bytes do not +exist, the record will be extended using nul bytes as necessary, and +the put call will succeed. +<p>It is an error to attempt a partial put using the <a href="../api_c/db_put.html">DB->put</a> function +in a database that supports duplicate records. +Partial puts in databases supporting duplicate records must be done +using a <a href="../api_c/dbc_put.html">DBcursor->c_put</a> function. +<p>It is an error to attempt a partial put with differing <b>dlen</b> and +<b>size</b> values in Queue or Recno databases with fixed-length records. +<p>For example, if the data portion of a retrieved record was 100 bytes, +and a partial put was done using a DBT having a <b>dlen</b> field of 20, +a <b>doff</b> field of 85, and a <b>size</b> field of 30, the resulting +record would be 115 bytes in length, where the last 30 bytes would be +those specified by the put call. +</dl> +</dl> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/env_class.html b/db/docs/api_c/env_class.html new file mode 100644 index 000000000..848dc6956 --- /dev/null +++ b/db/docs/api_c/env_class.html @@ -0,0 +1,51 @@ +<!--Id: env_class.so,v 10.32 2002/08/29 03:24:38 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_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 width="100%"><tr valign=top> +<td> +<h1>DB_ENV</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db_env DB_ENV; +</pre></h3> +<h1>Description</h1> +<p>The DB_ENV object is the handle for a Berkeley DB environment -- a +collection including support for some or all of caching, locking, +logging and transaction subsystems, as well as databases and log files. +Methods off the DB_ENV handle are used to configure the +environment as well as to operate on subsystems and databases in the +environment. +<p>DB_ENV handles are free-threaded if the <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag +is specified to the <a href="../api_c/env_open.html">DB_ENV->open</a> method when the environment is opened. +The DB_ENV handle should not be closed while any other handle +remains open that is using it as a reference (for example, <a href="../api_c/db_class.html">DB</a> +or <a href="../api_c/txn_class.html">DB_TXN</a>). Once either the <a href="../api_c/env_close.html">DB_ENV->close</a> or +<a href="../api_c/env_remove.html">DB_ENV->remove</a> methods are called, the handle may not be accessed again, +regardless of the method's return. +<h1>Class</h1> +DB_ENV +<h1>See Also</h1> +<a href="../api_c/env_list.html">Database Environments and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/env_list.html b/db/docs/api_c/env_list.html new file mode 100644 index 000000000..099d4d241 --- /dev/null +++ b/db/docs/api_c/env_list.html @@ -0,0 +1,84 @@ +<!--Id: env_list.so,v 10.1 2002/08/30 20:00:50 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Database Environments and Related Methods</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>Berkeley DB: Database Environments and Related Methods</h1> +<!--Id: m4.methods,v 10.1 2002/08/30 20:00:51 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Database Environments and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_create.html">db_env_create</a></td><td>Create an environment handle</td></tr> +<tr><td><a href="../api_c/env_close.html">DB_ENV->close</a></td><td>Close an environment</td></tr> +<tr><td><a href="../api_c/env_dbremove.html">DB_ENV->dbremove</a></td><td>Remove a database</td></tr> +<tr><td><a href="../api_c/env_dbrename.html">DB_ENV->dbrename</a></td><td>Rename a database</td></tr> +<tr><td><a href="../api_c/env_err.html">DB_ENV->err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_c/env_err.html">DB_ENV->errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_c/lock_detect.html">DB_ENV->lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_c/lock_get.html">DB_ENV->lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_c/lock_id.html">DB_ENV->lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_c/lock_id_free.html">DB_ENV->lock_id_free</a></td><td>Release a locker ID</td></tr> +<tr><td><a href="../api_c/lock_put.html">DB_ENV->lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_c/lock_stat.html">DB_ENV->lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_c/lock_vec.html">DB_ENV->lock_vec</a></td><td>Acquire/release locks</td></tr> +<tr><td><a href="../api_c/log_archive.html">DB_ENV->log_archive</a></td><td>List log and database files</td></tr> +<tr><td><a href="../api_c/log_cursor.html">DB_ENV->log_cursor</a></td><td>Create a log cursor handle</td></tr> +<tr><td><a href="../api_c/log_file.html">DB_ENV->log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_c/log_flush.html">DB_ENV->log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_c/log_put.html">DB_ENV->log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_c/log_stat.html">DB_ENV->log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a></td><td>Open a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_register.html">DB_ENV->memp_register</a></td><td>Register input/output functions for a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a></td><td>Flush pages from a memory pool</td></tr> +<tr><td><a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a></td><td>Trickle flush pages from a memory pool</td></tr> +<tr><td><a href="../api_c/env_open.html">DB_ENV->open</a></td><td>Open an environment</td></tr> +<tr><td><a href="../api_c/env_remove.html">DB_ENV->remove</a></td><td>Remove an environment</td></tr> +<tr><td><a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a></td><td>Process a replication message</td></tr> +<tr><td><a href="../api_c/rep_start.html">DB_ENV->rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><a href="../api_c/rep_stat.html">DB_ENV->rep_stat</a></td><td>Replication statistics</td></tr> +<tr><td><a href="../api_c/env_set_alloc.html">DB_ENV->set_alloc</a></td><td>Set local space allocation functions</td></tr> +<tr><td><a href="../api_c/env_set_app_dispatch.html">DB_ENV->set_app_dispatch</a></td><td>Configure application recovery interface</td></tr> +<tr><td><a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_c/env_set_data_dir.html">DB_ENV->set_data_dir</a></td><td>Set the environment data directory</td></tr> +<tr><td><a href="../api_c/env_set_encrypt.html">DB_ENV->set_encrypt</a></td><td>Set the environment cryptographic key</td></tr> +<tr><td><a href="../api_c/env_set_errcall.html">DB_ENV->set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_c/env_set_errfile.html">DB_ENV->set_errfile</a></td><td>Set error message FILE</td></tr> +<tr><td><a href="../api_c/env_set_errpfx.html">DB_ENV->set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_c/env_set_feedback.html">DB_ENV->set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_c/env_set_flags.html">DB_ENV->set_flags</a></td><td>Environment configuration</td></tr> +<tr><td><a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a></td><td>Set logging region size</td></tr> +<tr><td><a href="../api_c/env_set_lk_conflicts.html">DB_ENV->set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_c/env_set_lk_detect.html">DB_ENV->set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_c/env_set_lk_max_lockers.html">DB_ENV->set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> +<tr><td><a href="../api_c/env_set_lk_max_locks.html">DB_ENV->set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> +<tr><td><a href="../api_c/env_set_lk_max_objects.html">DB_ENV->set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> +<tr><td><a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> +<tr><td><a href="../api_c/env_set_paniccall.html">DB_ENV->set_paniccall</a></td><td>Set panic callback</td></tr> +<tr><td><a href="../api_c/rep_limit.html">DB_ENV->set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> +<tr><td><a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a></td><td>Configure replication transport</td></tr> +<tr><td><a href="../api_c/env_set_rpc_server.html">DB_ENV->set_rpc_server</a></td><td>Establish an RPC server connection</td></tr> +<tr><td><a href="../api_c/env_set_shm_key.html">DB_ENV->set_shm_key</a></td><td>Set system memory shared segment ID</td></tr> +<tr><td><a href="../api_c/env_set_tas_spins.html">DB_ENV->set_tas_spins</a></td><td>Set the number of test-and-set spins</td></tr> +<tr><td><a href="../api_c/env_set_timeout.html">DB_ENV->set_timeout</a></td><td>Set lock and transaction timeout</td></tr> +<tr><td><a href="../api_c/env_set_tmp_dir.html">DB_ENV->set_tmp_dir</a></td><td>Set the environment temporary file directory</td></tr> +<tr><td><a href="../api_c/env_set_tx_max.html">DB_ENV->set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_c/env_set_tx_timestamp.html">DB_ENV->set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_c/env_set_verbose.html">DB_ENV->set_verbose</a></td><td>Set verbose messages</td></tr> +<tr><td><a href="../api_c/txn_begin.html">DB_ENV->txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_c/txn_checkpoint.html">DB_ENV->txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_c/txn_recover.html">DB_ENV->txn_recover</a></td><td>Distributed transaction recovery</td></tr> +<tr><td><a href="../api_c/txn_stat.html">DB_ENV->txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/lock_class.html b/db/docs/api_c/lock_class.html new file mode 100644 index 000000000..6b25d49cf --- /dev/null +++ b/db/docs/api_c/lock_class.html @@ -0,0 +1,41 @@ +<!--Id: lock_class.so,v 10.18 2002/08/24 18:22:41 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_LOCK</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 width="100%"><tr valign=top> +<td> +<h1>DB_LOCK</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db_lock_u DB_LOCK; +</pre></h3> +<h1>Description</h1> +<p>The locking interfaces for the Berkeley DB database environment are methods +of the <a href="../api_c/env_class.html">DB_ENV</a> handle. The DB_LOCK object is the handle +for a single lock, and has no methods of its own. +<h1>Class</h1> +<a href="../api_c/env_class.html">DB_ENV</a>, DB_LOCK +<h1>See Also</h1> +<a href="../api_c/lock_list.html">Locking Subsystem and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/lock_list.html b/db/docs/api_c/lock_list.html new file mode 100644 index 000000000..06f9803e0 --- /dev/null +++ b/db/docs/api_c/lock_list.html @@ -0,0 +1,32 @@ +<!--Id: lock_list.so,v 1.1 2002/08/30 20:00:51 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Locking Subsystem and Related Methods</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>Berkeley DB: Locking Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:52 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Locking Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_lk_conflicts.html">DB_ENV->set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_c/env_set_lk_detect.html">DB_ENV->set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_c/env_set_lk_max_lockers.html">DB_ENV->set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> +<tr><td><a href="../api_c/env_set_lk_max_locks.html">DB_ENV->set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> +<tr><td><a href="../api_c/env_set_lk_max_objects.html">DB_ENV->set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> +<tr><td><a href="../api_c/env_set_timeout.html">DB_ENV->set_timeout</a></td><td>Set lock and transaction timeout</td></tr> +<tr><td><a href="../api_c/lock_detect.html">DB_ENV->lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_c/lock_get.html">DB_ENV->lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_c/lock_id.html">DB_ENV->lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_c/lock_id_free.html">DB_ENV->lock_id_free</a></td><td>Release a locker ID</td></tr> +<tr><td><a href="../api_c/lock_put.html">DB_ENV->lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_c/lock_stat.html">DB_ENV->lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_c/lock_vec.html">DB_ENV->lock_vec</a></td><td>Acquire/release locks</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/log_list.html b/db/docs/api_c/log_list.html new file mode 100644 index 000000000..c0d6f4a2d --- /dev/null +++ b/db/docs/api_c/log_list.html @@ -0,0 +1,32 @@ +<!--Id: log_list.so,v 1.1 2002/08/30 20:00:56 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Logging Subsystem and Related Methods</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>Berkeley DB: Logging Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:01:00 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Logging Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/log_archive.html">DB_ENV->log_archive</a></td><td>List log and database files</td></tr> +<tr><td><a href="../api_c/log_cursor.html">DB_ENV->log_cursor</a></td><td>Create a log cursor handle</td></tr> +<tr><td><a href="../api_c/log_file.html">DB_ENV->log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_c/log_flush.html">DB_ENV->log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_c/log_put.html">DB_ENV->log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_c/env_set_lg_bsize.html">DB_ENV->set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_c/env_set_lg_dir.html">DB_ENV->set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_c/env_set_lg_max.html">DB_ENV->set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_c/env_set_lg_regionmax.html">DB_ENV->set_lg_regionmax</a></td><td>Set logging region size</td></tr> +<tr><td><a href="../api_c/log_compare.html">log_compare</a></td><td>Compare two Log Sequence Numbers</td></tr> +<tr><td><a href="../api_c/log_stat.html">DB_ENV->log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_c/logc_close.html">DB_LOGC->close</a></td><td>Close a log cursor</td></tr> +<tr><td><a href="../api_c/logc_get.html">DB_LOGC->get</a></td><td>Retrieve a log record</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/logc_class.html b/db/docs/api_c/logc_class.html new file mode 100644 index 000000000..f19323f67 --- /dev/null +++ b/db/docs/api_c/logc_class.html @@ -0,0 +1,43 @@ +<!--Id: logc_class.so,v 1.5 2002/08/24 18:22:51 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_LOGC</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 width="100%"><tr valign=top> +<td> +<h1>DB_LOGC</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db_log_cursor DB_LOGC; +</pre></h3> +<h1>Description</h1> +<p>The DB_LOGC object is the handle for a cursor into the log files, +supporting sequential access to the records stored in log files. The +handle is not free-threaded. Once the <a href="../api_c/logc_close.html">DB_LOGC->close</a> method is called, +the handle may not be accessed again, regardless of that method's +return. +<h1>Class</h1> +<a href="../api_c/env_class.html">DB_ENV</a>, DB_LOGC, <a href="../api_c/lsn_class.html">DB_LSN</a> +<h1>See Also</h1> +<a href="../api_c/log_list.html">Logging Subsystem and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/lsn_class.html b/db/docs/api_c/lsn_class.html new file mode 100644 index 000000000..58d9a5081 --- /dev/null +++ b/db/docs/api_c/lsn_class.html @@ -0,0 +1,41 @@ +<!--Id: lsn_class.so,v 10.13 2002/08/24 18:22:52 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_LSN</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 width="100%"><tr valign=top> +<td> +<h1>DB_LSN</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db_lsn DB_LSN; +</pre></h3> +<h1>Description</h1> +<p>The DB_LSN object is a <b>log sequence number</b> which +specifies a unique location in a log file. It has no methods and +its data may not be manipulated by an application. +<h1>Class</h1> +<a href="../api_c/env_class.html">DB_ENV</a>, <a href="../api_c/logc_class.html">DB_LOGC</a>, DB_LSN +<h1>See Also</h1> +<a href="../api_c/log_list.html">Logging Subsystem and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/memp_list.html b/db/docs/api_c/memp_list.html new file mode 100644 index 000000000..5f08f6c18 --- /dev/null +++ b/db/docs/api_c/memp_list.html @@ -0,0 +1,37 @@ +<!--Id: memp_list.so,v 1.1 2002/08/30 20:01:28 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Memory Pools and Related Methods</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>Berkeley DB: Memory Pools and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:01:28 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Memory Pools and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_cachesize.html">DB_ENV->set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_c/env_set_mp_mmapsize.html">DB_ENV->set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> +<tr><td><a href="../api_c/memp_register.html">DB_ENV->memp_register</a></td><td>Register input/output functions for a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_stat.html">DB_ENV->memp_stat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_c/memp_sync.html">DB_ENV->memp_sync</a></td><td>Flush pages from a memory pool</td></tr> +<tr><td><a href="../api_c/memp_trickle.html">DB_ENV->memp_trickle</a></td><td>Trickle flush pages from a memory pool</td></tr> +<tr><td><a href="../api_c/memp_fcreate.html">DB_ENV->memp_fcreate</a></td><td>Open a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a></td><td>Close a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a></td><td>Get page from a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_fopen.html">DB_MPOOLFILE->open</a></td><td>Open a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a></td><td>Return a page to a memory pool</td></tr> +<tr><td><a href="../api_c/memp_fset.html">DB_MPOOLFILE->set</a></td><td>Set memory pool page status</td></tr> +<tr><td><a href="../api_c/memp_fsync.html">DB_MPOOLFILE->sync</a></td><td>Flush pages from a file in a memory pool</td></tr> +<tr><td><a href="../api_c/memp_set_clear_len.html">DB_MPOOLFILE->set_clear_len</a></td><td>Set file page bytes to be cleared</td></tr> +<tr><td><a href="../api_c/memp_set_fileid.html">DB_MPOOLFILE->set_fileid</a></td><td>Set file unique identifier</td></tr> +<tr><td><a href="../api_c/memp_set_ftype.html">DB_MPOOLFILE->set_ftype</a></td><td>Set file type</td></tr> +<tr><td><a href="../api_c/memp_set_lsn_offset.html">DB_MPOOLFILE->set_lsn_offset</a></td><td>Set file log-sequence-number offset</td></tr> +<tr><td><a href="../api_c/memp_set_pgcookie.html">DB_MPOOLFILE->set_pgcookie</a></td><td>Set file cookie for pgin/pgout</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/mempfile_class.html b/db/docs/api_c/mempfile_class.html new file mode 100644 index 000000000..01671979d --- /dev/null +++ b/db/docs/api_c/mempfile_class.html @@ -0,0 +1,56 @@ +<!--Id: mempfile_class.so,v 10.18 2002/08/24 18:23:33 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_MPOOLFILE</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 width="100%"><tr valign=top> +<td> +<h1>DB_MPOOLFILE</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db_mpoolfile DB_MPOOLFILE; +</pre></h3> +<h1>Description</h1> +<p>The memory pool interfaces for the Berkeley DB database environment are +methods of the <a href="../api_c/env_class.html">DB_ENV</a> handle. The <a href="../api_c/env_class.html">DB_ENV</a> memory pool +methods and the DB_MPOOLFILE class provide general-purpose, +page-oriented buffer management of files. Although designed to work +with the other <a href="../api_c/db_class.html">DB</a> classes, they are also useful for more general +purposes. The memory pools are referred to in this document as simply +<i>pools</i>. +<p>Pools may be shared between processes. Pools are usually filled by +pages from one or more files. Pages in the pool are replaced in LRU +(least-recently-used) order, with each new page replacing the page that +has been unused the longest. Pages retrieved from the pool using +<a href="../api_c/memp_fget.html">DB_MPOOLFILE->get</a> are <i>pinned</i> in the pool until they are +returned to the control of the buffer pool using the <a href="../api_c/memp_fput.html">DB_MPOOLFILE->put</a> +method. +<p>The DB_MPOOLFILE object is the handle for a file in the memory +pool. The handle is not free-threaded. Once the <a href="../api_c/memp_fclose.html">DB_MPOOLFILE->close</a> method +is called, the handle may not be accessed again, regardless of that +method's return. +<h1>Class</h1> +<a href="../api_c/env_class.html">DB_ENV</a>, DB_MPOOLFILE +<h1>See Also</h1> +<a href="../api_c/memp_list.html">Memory Pools and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/rep_list.html b/db/docs/api_c/rep_list.html new file mode 100644 index 000000000..db10e79dc --- /dev/null +++ b/db/docs/api_c/rep_list.html @@ -0,0 +1,25 @@ +<!--Id: rep_list.so,v 1.1 2002/08/30 20:02:36 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Replication and Related Methods</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>Berkeley DB: Replication and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:02:36 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Replication and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/rep_transport.html">DB_ENV->set_rep_transport</a></td><td>Configure replication transport</td></tr> +<tr><td><a href="../api_c/rep_elect.html">DB_ENV->rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><a href="../api_c/rep_limit.html">DB_ENV->set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> +<tr><td><a href="../api_c/rep_message.html">DB_ENV->rep_process_message</a></td><td>Process a replication message</td></tr> +<tr><td><a href="../api_c/rep_start.html">DB_ENV->rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><a href="../api_c/rep_stat.html">DB_ENV->rep_stat</a></td><td>Replication statistics</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_c/txn_class.html b/db/docs/api_c/txn_class.html new file mode 100644 index 000000000..7811ef956 --- /dev/null +++ b/db/docs/api_c/txn_class.html @@ -0,0 +1,51 @@ +<!--Id: txn_class.so,v 10.21 2002/08/24 18:24:49 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DB_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 width="100%"><tr valign=top> +<td> +<h1>DB_TXN</h1> +</td> +<td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +typedef struct __db_txn DB_TXN; +</pre></h3> +<h1>Description</h1> +<p>The DB_TXN object is the handle for a transaction. Methods off +the DB_TXN handle are used to configure, abort and commit the +transaction. DB_TXN handles are provided to <a href="../api_c/db_class.html">DB</a> methods +in order to transactionally protect those database operations. +<p>DB_TXN handles are not free-threaded; transactions handles may +be used by multiple threads, but only serially, that is, the application +must serialize access to the DB_TXN handle. Once the +<a href="../api_c/txn_abort.html">DB_TXN->abort</a> or <a href="../api_c/txn_commit.html">DB_TXN->commit</a> methods are called, the handle may +not be accessed again, regardless of the method's return. In addition, +parent transactions may not issue any Berkeley DB operations while they have +active child transactions (child transactions that have not yet been +committed or aborted) except for <a href="../api_c/txn_begin.html">DB_ENV->txn_begin</a>, <a href="../api_c/txn_abort.html">DB_TXN->abort</a> +and <a href="../api_c/txn_commit.html">DB_TXN->commit</a>. +<h1>Class</h1> +<a href="../api_c/env_class.html">DB_ENV</a>, DB_TXN +<h1>See Also</h1> +<a href="../api_c/txn_list.html">Transaction Subsystem and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_c/txn_list.html b/db/docs/api_c/txn_list.html new file mode 100644 index 000000000..ad6633ca4 --- /dev/null +++ b/db/docs/api_c/txn_list.html @@ -0,0 +1,31 @@ +<!--Id: txn_list.so,v 1.1 2002/08/30 20:02:41 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Transaction Subsystem and Related Methods</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>Berkeley DB: Transaction Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:02:41 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Transaction Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_tx_max.html">DB_ENV->set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_c/env_set_tx_timestamp.html">DB_ENV->set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_c/txn_checkpoint.html">DB_ENV->txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_c/txn_recover.html">DB_ENV->txn_recover</a></td><td>Distributed transaction recovery</td></tr> +<tr><td><a href="../api_c/txn_stat.html">DB_ENV->txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +<tr><td><a href="../api_c/txn_begin.html">DB_ENV->txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_c/txn_abort.html">DB_TXN->abort</a></td><td>Abort a transaction</td></tr> +<tr><td><a href="../api_c/txn_commit.html">DB_TXN->commit</a></td><td>Commit a transaction</td></tr> +<tr><td><a href="../api_c/txn_discard.html">DB_TXN->discard</a></td><td>Discard a prepared but not resolved transaction handle</td></tr> +<tr><td><a href="../api_c/txn_id.html">DB_TXN->id</a></td><td>Return a transaction's ID</td></tr> +<tr><td><a href="../api_c/txn_prepare.html">DB_TXN->prepare</a></td><td>Prepare a transaction for commit</td></tr> +<tr><td><a href="../api_c/txn_set_timeout.html">DB_TXN->set_timeout</a></td><td>Set transaction timeout</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/db_list.html b/db/docs/api_cxx/db_list.html new file mode 100644 index 000000000..bd835909b --- /dev/null +++ b/db/docs/api_cxx/db_list.html @@ -0,0 +1,67 @@ +<!--Id: db_list.so,v 1.1 2002/08/30 20:00:48 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Databases and Related Methods</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>Berkeley DB: Databases and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:48 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Databases and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/db_associate.html">Db::associate</a></td><td>Associate a secondary index</td></tr> +<tr><td><a href="../api_cxx/db_close.html">Db::close</a></td><td>Close a database</td></tr> +<tr><td><a href="../api_cxx/db_cursor.html">Db::cursor</a></td><td>Create a cursor handle</td></tr> +<tr><td><a href="../api_cxx/db_del.html">Db::del</a></td><td>Delete items from a database</td></tr> +<tr><td><a href="../api_cxx/db_err.html">Db::err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_cxx/db_err.html">Db::errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_cxx/db_fd.html">Db::fd</a></td><td>Return a file descriptor from a database</td></tr> +<tr><td><a href="../api_cxx/db_get.html">Db::get</a></td><td>Get items from a database</td></tr> +<tr><td><a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a></td><td>Return if the underlying database is in host order</td></tr> +<tr><td><a href="../api_cxx/db_get_type.html">Db::get_type</a></td><td>Return the database type</td></tr> +<tr><td><a href="../api_cxx/db_join.html">Db::join</a></td><td>Perform a database join on cursors</td></tr> +<tr><td><a href="../api_cxx/db_key_range.html">Db::key_range</a></td><td>Return estimate of key location</td></tr> +<tr><td><a href="../api_cxx/db_open.html">Db::open</a></td><td>Open a database</td></tr> +<tr><td><a href="../api_cxx/db_get.html">Db::pget</a></td><td>Get items from a database</td></tr> +<tr><td><a href="../api_cxx/db_put.html">Db::put</a></td><td>Store items into a database</td></tr> +<tr><td><a href="../api_cxx/db_remove.html">Db::remove</a></td><td>Remove a database</td></tr> +<tr><td><a href="../api_cxx/db_rename.html">Db::rename</a></td><td>Rename a database</td></tr> +<tr><td><a href="../api_cxx/db_set_alloc.html">Db::set_alloc</a></td><td>Set local space allocation functions</td></tr> +<tr><td><a href="../api_cxx/db_set_append_recno.html">Db::set_append_recno</a></td><td>Set record append callback</td></tr> +<tr><td><a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a></td><td>Set a Btree comparison function</td></tr> +<tr><td><a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a></td><td>Set the minimum number of keys per Btree page</td></tr> +<tr><td><a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a></td><td>Set a Btree prefix comparison function</td></tr> +<tr><td><a href="../api_cxx/db_set_cache_priority.html">Db::set_cache_priority</a></td><td>Set the database cache priority</td></tr> +<tr><td><a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a></td><td>Set the database cache size</td></tr> +<tr><td><a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a></td><td>Set a duplicate comparison function</td></tr> +<tr><td><a href="../api_cxx/db_set_encrypt.html">Db::set_encrypt</a></td><td>Set the database cryptographic key</td></tr> +<tr><td><a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a></td><td>Set error message FILE</td></tr> +<tr><td><a href="../api_cxx/db_set_error_stream.html">Db::set_error_stream</a></td><td>Set error message output stream</td></tr> +<tr><td><a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_cxx/db_set_feedback.html">Db::set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_cxx/db_set_flags.html">Db::set_flags</a></td><td>General database configuration</td></tr> +<tr><td><a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a></td><td>Set the Hash table density</td></tr> +<tr><td><a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a></td><td>Set a hashing function</td></tr> +<tr><td><a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a></td><td>Set the Hash table size</td></tr> +<tr><td><a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a></td><td>Set the database byte order</td></tr> +<tr><td><a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a></td><td>Set the underlying database page size</td></tr> +<tr><td><a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a></td><td>Set panic callback</td></tr> +<tr><td><a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a></td><td>Set Queue database extent size</td></tr> +<tr><td><a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a></td><td>Set the variable-length record delimiter</td></tr> +<tr><td><a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a></td><td>Set the fixed-length record length</td></tr> +<tr><td><a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a></td><td>Set the fixed-length record pad byte</td></tr> +<tr><td><a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a></td><td>Set the backing Recno text file</td></tr> +<tr><td><a href="../api_cxx/db_stat.html">Db::stat</a></td><td>Return database statistics</td></tr> +<tr><td><a href="../api_cxx/db_sync.html">Db::sync</a></td><td>Flush a database to stable storage</td></tr> +<tr><td><a href="../api_cxx/db_truncate.html">Db::truncate</a></td><td>Empty a database</td></tr> +<tr><td><a href="../api_cxx/db_upgrade.html">Db::upgrade</a></td><td>Upgrade a database</td></tr> +<tr><td><a href="../api_cxx/db_verify.html">Db::verify</a></td><td>Verify/salvage a database</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/db_set_error_stream.html b/db/docs/api_cxx/db_set_error_stream.html new file mode 100644 index 000000000..d64f9fc81 --- /dev/null +++ b/db/docs/api_cxx/db_set_error_stream.html @@ -0,0 +1,64 @@ +<!--Id: db_set_error_stream.so,v 10.2 2002/08/18 21:15:54 bostic Exp --> +<!--Id: env_set_error_stream.so,v 10.19 2002/08/18 21:16:27 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Db::set_error_stream</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 width="100%"><tr valign=top> +<td> +<h1>Db::set_error_stream</h1> +</td> +<td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db_cxx.h> +<p> +void Db::set_error_stream(class ostream*); +</pre></h3> +<h1>Description</h1> +<p>When an error occurs in the Berkeley DB library, an exception is thrown or an +<b>errno</b> value is returned by the method. In some cases, +however, the <b>errno</b> value may be insufficient to completely +describe the cause of the error, especially during initial application +debugging. +<p>The <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> and Db::set_error_stream methods +are used to enhance the mechanism for reporting error messages to the +application by setting the C++ ostream 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 stream. +<p>The error message will consist of the prefix string and a colon +("<b>:</b>") (if a prefix string was previously specified using +<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>), an error string, and a trailing +<newline> character. +<p>Alternatively, you can use the <a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> method to display +the additional information via a C library FILE *, or the +<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method to capture the additional error information in +a way that does not use either output streams or C library FILE *'s. You +should not mix these approaches. +<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 <a href="../api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the +Db::set_error_stream method affects the entire environment and is equivalent to calling +the <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method. +<h1>Class</h1> +<a href="../api_cxx/db_class.html">Db</a> +<h1>See Also</h1> +<a href="../api_cxx/db_list.html">Databases and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_cxx/dbc_list.html b/db/docs/api_cxx/dbc_list.html new file mode 100644 index 000000000..99682459d --- /dev/null +++ b/db/docs/api_cxx/dbc_list.html @@ -0,0 +1,27 @@ +<!--Id: dbc_list.so,v 1.1 2002/08/30 20:00:49 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Database Cursors and Related Methods</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>Berkeley DB: Database Cursors and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:49 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Database Cursors and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/db_cursor.html">Db::cursor</a></td><td>Create a cursor handle</td></tr> +<tr><td><a href="../api_cxx/dbc_close.html">Dbc::close</a></td><td>Close a cursor</td></tr> +<tr><td><a href="../api_cxx/dbc_count.html">Dbc::count</a></td><td>Return count of duplicates</td></tr> +<tr><td><a href="../api_cxx/dbc_del.html">Dbc::del</a></td><td>Delete by cursor</td></tr> +<tr><td><a href="../api_cxx/dbc_dup.html">Dbc::dup</a></td><td>Duplicate a cursor</td></tr> +<tr><td><a href="../api_cxx/dbc_get.html">Dbc::get</a></td><td>Retrieve by cursor</td></tr> +<tr><td><a href="../api_cxx/dbc_get.html">Dbc::pget</a></td><td>Retrieve by cursor</td></tr> +<tr><td><a href="../api_cxx/dbc_put.html">Dbc::put</a></td><td>Store by cursor</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/env_class.html b/db/docs/api_cxx/env_class.html new file mode 100644 index 000000000..207dfc062 --- /dev/null +++ b/db/docs/api_cxx/env_class.html @@ -0,0 +1,96 @@ +<!--Id: env_class.so,v 10.32 2002/08/29 03:24:38 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DbEnv</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 width="100%"><tr valign=top> +<td> +<h1>DbEnv</h1> +</td> +<td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db_cxx.h> +<p> +class DbEnv { +public: + DbEnv(u_int32 flags); + ~DbEnv(); +<p> + DB_ENV *DbEnv::get_DB_ENV(); + const DB_ENV *DbEnv::get_const_DB_ENV() const; + static DbEnv *DbEnv::get_DbEnv(DB_ENV *dbenv); + static const DbEnv *DbEnv::get_const_DbEnv(const DB_ENV *dbenv); + ... +}; +</pre></h3> +<h1>Description</h1> +<p>The DbEnv object is the handle for a Berkeley DB environment -- a +collection including support for some or all of caching, locking, +logging and transaction subsystems, as well as databases and log files. +Methods off the DbEnv handle are used to configure the +environment as well as to operate on subsystems and databases in the +environment. +<p>DbEnv handles are free-threaded if the <a href="../api_cxx/env_open.html#DB_THREAD">DB_THREAD</a> flag +is specified to the <a href="../api_cxx/env_open.html">DbEnv::open</a> method when the environment is opened. +The DbEnv handle should not be closed while any other handle +remains open that is using it as a reference (for example, <a href="../api_cxx/db_class.html">Db</a> +or <a href="../api_cxx/txn_class.html">DbTxn</a>). Once either the <a href="../api_cxx/env_close.html">DbEnv::close</a> or +<a href="../api_cxx/env_remove.html">DbEnv::remove</a> methods are called, the handle may not be accessed again, +regardless of the method's return. +<p>The constructor creates the DbEnv object. The constructor +allocates memory internally; calling the <a href="../api_cxx/env_close.html">DbEnv::close</a> or +<a href="../api_cxx/env_remove.html">DbEnv::remove</a> methods will free that memory. +<p>The following <b>flags</b> value may be specified: +<p><dl compact> +<p><dt><a name="DB_CLIENT">DB_CLIENT</a><dd>Create a client environment to connect to a server. +<p>The DB_CLIENT flag indicates to the system that this environment +is remote on a server. The use of this flag causes the environment +methods to use functions that call a server instead of local functions. +Prior to making any environment or database method calls, the +application must call the <a href="../api_cxx/env_set_rpc_server.html">DbEnv::set_rpc_server</a> method to +establish the connection to the server. +<p><dt><a name="DB_CXX_NO_EXCEPTIONS">DB_CXX_NO_EXCEPTIONS</a><dd>The Berkeley DB C++ API supports two different error behaviors. By default, +whenever an error occurs, an exception is thrown that encapsulates the +error information. This generally allows for cleaner logic for +transaction processing because a try block can surround a single +transaction. However, if DB_CXX_NO_EXCEPTIONS is specified, +exceptions are not thrown; instead, each individual function returns an +error code. +</dl> +<p>Each DbEnv object has an associated DB_ENV structure, +which is used by the underlying implementation of Berkeley DB and its +C-language API. The DbEnv::get_DB_ENV method returns a pointer to this +struct. Given a const DbEnv object, DbEnv::get_const_DB_ENV +returns a const pointer to the same struct. +<p>Given a DB_ENV struct, the DbEnv::get_DbEnv method returns the +corresponding DbEnv object, if there is one. If the +DB_ENV object was not associated with a DbEnv (that is, +it was not returned from a call to DbEnv::get_DB_ENV), then the result +of DbEnv::get_DbEnv is undefined. Given a const DB_ENV struct, +DbEnv::get_const_Db_Env returns the associated const DbEnv +object, if there is one. +<p>These methods may be useful for Berkeley DB applications including both C +and C++ language software. It should not be necessary to use these +calls in a purely C++ application. +<h1>Class</h1> +DbEnv +<h1>See Also</h1> +<a href="../api_cxx/env_list.html">Database Environments and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_cxx/env_list.html b/db/docs/api_cxx/env_list.html new file mode 100644 index 000000000..d1705ed3d --- /dev/null +++ b/db/docs/api_cxx/env_list.html @@ -0,0 +1,82 @@ +<!--Id: env_list.so,v 10.1 2002/08/30 20:00:50 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Database Environments and Related Methods</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>Berkeley DB: Database Environments and Related Methods</h1> +<!--Id: m4.methods,v 10.1 2002/08/30 20:00:51 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Database Environments and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/env_close.html">DbEnv::close</a></td><td>Close an environment</td></tr> +<tr><td><a href="../api_cxx/env_dbremove.html">DbEnv::dbremove</a></td><td>Remove a database</td></tr> +<tr><td><a href="../api_cxx/env_dbrename.html">DbEnv::dbrename</a></td><td>Rename a database</td></tr> +<tr><td><a href="../api_cxx/env_err.html">DbEnv::err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_cxx/env_err.html">DbEnv::errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_cxx/lock_get.html">DbEnv::lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_cxx/lock_id.html">DbEnv::lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_cxx/lock_id_free.html">DbEnv::lock_id_free</a></td><td>Release a locker ID</td></tr> +<tr><td><a href="../api_cxx/lock_put.html">DbEnv::lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a></td><td>Acquire/release locks</td></tr> +<tr><td><a href="../api_cxx/log_archive.html">DbEnv::log_archive</a></td><td>List log and database files</td></tr> +<tr><td><a href="../api_cxx/log_file.html">DbEnv::log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_cxx/log_flush.html">DbEnv::log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_cxx/log_put.html">DbEnv::log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_cxx/log_stat.html">DbEnv::log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_cxx/memp_register.html">DbEnv::memp_register</a></td><td>Register input/output functions for a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a></td><td>Flush pages from a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a></td><td>Trickle flush pages from a memory pool</td></tr> +<tr><td><a href="../api_cxx/env_open.html">DbEnv::open</a></td><td>Open an environment</td></tr> +<tr><td><a href="../api_cxx/env_remove.html">DbEnv::remove</a></td><td>Remove an environment</td></tr> +<tr><td><a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a></td><td>Process a replication message</td></tr> +<tr><td><a href="../api_cxx/rep_start.html">DbEnv::rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><a href="../api_cxx/rep_stat.html">DbEnv::rep_stat</a></td><td>Replication statistics</td></tr> +<tr><td><a href="../api_cxx/env_set_alloc.html">DbEnv::set_alloc</a></td><td>Set local space allocation functions</td></tr> +<tr><td><a href="../api_cxx/env_set_app_dispatch.html">DbEnv::set_app_dispatch</a></td><td>Configure application recovery interface</td></tr> +<tr><td><a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a></td><td>Set the environment data directory</td></tr> +<tr><td><a href="../api_cxx/env_set_encrypt.html">DbEnv::set_encrypt</a></td><td>Set the environment cryptographic key</td></tr> +<tr><td><a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a></td><td>Set error message FILE</td></tr> +<tr><td><a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a></td><td>Set error message output stream</td></tr> +<tr><td><a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_cxx/env_set_feedback.html">DbEnv::set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a></td><td>Environment configuration</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a></td><td>Set logging region size</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> +<tr><td><a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> +<tr><td><a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a></td><td>Set panic callback</td></tr> +<tr><td><a href="../api_cxx/rep_limit.html">DbEnv::set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> +<tr><td><a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a></td><td>Configure replication transport</td></tr> +<tr><td><a href="../api_cxx/env_set_rpc_server.html">DbEnv::set_rpc_server</a></td><td>Establish an RPC server connection</td></tr> +<tr><td><a href="../api_cxx/env_set_shm_key.html">DbEnv::set_shm_key</a></td><td>Set system memory shared segment ID</td></tr> +<tr><td><a href="../api_cxx/env_set_tas_spins.html">DbEnv::set_tas_spins</a></td><td>Set the number of test-and-set spins</td></tr> +<tr><td><a href="../api_cxx/env_set_timeout.html">DbEnv::set_timeout</a></td><td>Set lock and transaction timeout</td></tr> +<tr><td><a href="../api_cxx/env_set_tmp_dir.html">DbEnv::set_tmp_dir</a></td><td>Set the environment temporary file directory</td></tr> +<tr><td><a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a></td><td>Set verbose messages</td></tr> +<tr><td><a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a></td><td>Distributed transaction recovery</td></tr> +<tr><td><a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/lock_list.html b/db/docs/api_cxx/lock_list.html new file mode 100644 index 000000000..035e7aa4f --- /dev/null +++ b/db/docs/api_cxx/lock_list.html @@ -0,0 +1,32 @@ +<!--Id: lock_list.so,v 1.1 2002/08/30 20:00:51 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Locking Subsystem and Related Methods</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>Berkeley DB: Locking Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:52 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Locking Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> +<tr><td><a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> +<tr><td><a href="../api_cxx/env_set_timeout.html">DbEnv::set_timeout</a></td><td>Set lock and transaction timeout</td></tr> +<tr><td><a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_cxx/lock_get.html">DbEnv::lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_cxx/lock_id.html">DbEnv::lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_cxx/lock_id_free.html">DbEnv::lock_id_free</a></td><td>Release a locker ID</td></tr> +<tr><td><a href="../api_cxx/lock_put.html">DbEnv::lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a></td><td>Acquire/release locks</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/log_list.html b/db/docs/api_cxx/log_list.html new file mode 100644 index 000000000..151c0121a --- /dev/null +++ b/db/docs/api_cxx/log_list.html @@ -0,0 +1,32 @@ +<!--Id: log_list.so,v 1.1 2002/08/30 20:00:56 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Logging Subsystem and Related Methods</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>Berkeley DB: Logging Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:01:00 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Logging Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/log_archive.html">DbEnv::log_archive</a></td><td>List log and database files</td></tr> +<tr><td><a href="../api_cxx/log_cursor.html">DbEnv::log_cursor</a></td><td>Create a log cursor handle</td></tr> +<tr><td><a href="../api_cxx/log_file.html">DbEnv::log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_cxx/log_flush.html">DbEnv::log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_cxx/log_put.html">DbEnv::log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_cxx/env_set_lg_regionmax.html">DbEnv::set_lg_regionmax</a></td><td>Set logging region size</td></tr> +<tr><td><a href="../api_cxx/log_compare.html">DbEnv::log_compare</a></td><td>Compare two Log Sequence Numbers</td></tr> +<tr><td><a href="../api_cxx/log_stat.html">DbEnv::log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_cxx/logc_close.html">DbLogc::close</a></td><td>Close a log cursor</td></tr> +<tr><td><a href="../api_cxx/logc_get.html">DbLogc::get</a></td><td>Retrieve a log record</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/memp_class.html b/db/docs/api_cxx/memp_class.html new file mode 100644 index 000000000..54b2c18a6 --- /dev/null +++ b/db/docs/api_cxx/memp_class.html @@ -0,0 +1,49 @@ +<!--Id: memp_class.so,v 10.14 2002/08/24 18:23:29 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DbMemoryException</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 width="100%"><tr valign=top> +<td> +<h1>DbMemoryException</h1> +</td> +<td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db_cxx.h> +<p> +class DbMemoryException : public DbException { +public: + Dbt *get_dbt() const; +}; +</pre></h3> +<h1>Description</h1> +<p>This manual page describes the DbMemoryException class and how +it is used by the various Db* classes. +<p>A DbMemoryException is thrown when there is insufficient memory +to complete an operation, and there is the possibility of recovering. +An example is during a <a href="../api_cxx/db_get.html">Db::get</a> or <a href="../api_cxx/dbc_get.html">Dbc::get</a> operation with +the <a href="../api_cxx/dbt_class.html">Dbt</a> flags set to <a href="../api_cxx/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a>. +<p>The <b>get_dbt</b> method returns the <a href="../api_cxx/dbt_class.html">Dbt</a> that has insufficient +memory to complete the operation, causing the DbMemoryException +to be thrown. +The <a href="../api_cxx/dbt_class.html">Dbt</a> pointer may or may not refer to valid memory, depending +on whether the <a href="../api_cxx/dbt_class.html">Dbt</a> used in the call to the failed Berkeley DB method +is still in scope and has not been deleted. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_cxx/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_cxx/memp_list.html b/db/docs/api_cxx/memp_list.html new file mode 100644 index 000000000..0ba9457b9 --- /dev/null +++ b/db/docs/api_cxx/memp_list.html @@ -0,0 +1,37 @@ +<!--Id: memp_list.so,v 1.1 2002/08/30 20:01:28 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Memory Pools and Related Methods</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>Berkeley DB: Memory Pools and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:01:28 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Memory Pools and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> +<tr><td><a href="../api_cxx/memp_register.html">DbEnv::memp_register</a></td><td>Register input/output functions for a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a></td><td>Flush pages from a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a></td><td>Trickle flush pages from a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_fcreate.html">DbEnv::memp_fcreate</a></td><td>Open a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a></td><td>Close a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a></td><td>Get page from a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a></td><td>Open a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a></td><td>Return a page to a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a></td><td>Set memory pool page status</td></tr> +<tr><td><a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a></td><td>Flush pages from a file in a memory pool</td></tr> +<tr><td><a href="../api_cxx/memp_set_clear_len.html">DbMpoolFile::set_clear_len</a></td><td>Set file page bytes to be cleared</td></tr> +<tr><td><a href="../api_cxx/memp_set_fileid.html">DbMpoolFile::set_fileid</a></td><td>Set file unique identifier</td></tr> +<tr><td><a href="../api_cxx/memp_set_ftype.html">DbMpoolFile::set_ftype</a></td><td>Set file type</td></tr> +<tr><td><a href="../api_cxx/memp_set_lsn_offset.html">DbMpoolFile::set_lsn_offset</a></td><td>Set file log-sequence-number offset</td></tr> +<tr><td><a href="../api_cxx/memp_set_pgcookie.html">DbMpoolFile::set_pgcookie</a></td><td>Set file cookie for pgin/pgout</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/rep_list.html b/db/docs/api_cxx/rep_list.html new file mode 100644 index 000000000..84d53ca57 --- /dev/null +++ b/db/docs/api_cxx/rep_list.html @@ -0,0 +1,25 @@ +<!--Id: rep_list.so,v 1.1 2002/08/30 20:02:36 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Replication and Related Methods</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>Berkeley DB: Replication and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:02:36 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Replication and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/rep_transport.html">DbEnv::set_rep_transport</a></td><td>Configure replication transport</td></tr> +<tr><td><a href="../api_cxx/rep_elect.html">DbEnv::rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><a href="../api_cxx/rep_limit.html">DbEnv::set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> +<tr><td><a href="../api_cxx/rep_message.html">DbEnv::rep_process_message</a></td><td>Process a replication message</td></tr> +<tr><td><a href="../api_cxx/rep_start.html">DbEnv::rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><a href="../api_cxx/rep_stat.html">DbEnv::rep_stat</a></td><td>Replication statistics</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_cxx/txn_list.html b/db/docs/api_cxx/txn_list.html new file mode 100644 index 000000000..b89b980d7 --- /dev/null +++ b/db/docs/api_cxx/txn_list.html @@ -0,0 +1,31 @@ +<!--Id: txn_list.so,v 1.1 2002/08/30 20:02:41 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Transaction Subsystem and Related Methods</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>Berkeley DB: Transaction Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:02:41 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Transaction Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_cxx/txn_recover.html">DbEnv::txn_recover</a></td><td>Distributed transaction recovery</td></tr> +<tr><td><a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +<tr><td><a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_cxx/txn_abort.html">DbTxn::abort</a></td><td>Abort a transaction</td></tr> +<tr><td><a href="../api_cxx/txn_commit.html">DbTxn::commit</a></td><td>Commit a transaction</td></tr> +<tr><td><a href="../api_cxx/txn_discard.html">DbTxn::discard</a></td><td>Discard a prepared but not resolved transaction handle</td></tr> +<tr><td><a href="../api_cxx/txn_id.html">DbTxn::id</a></td><td>Return a transaction's ID</td></tr> +<tr><td><a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a></td><td>Prepare a transaction for commit</td></tr> +<tr><td><a href="../api_cxx/txn_set_timeout.html">DbTxn::set_timeout</a></td><td>Set transaction timeout</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/db_list.html b/db/docs/api_java/db_list.html new file mode 100644 index 000000000..f3869dbbe --- /dev/null +++ b/db/docs/api_java/db_list.html @@ -0,0 +1,64 @@ +<!--Id: db_list.so,v 1.1 2002/08/30 20:00:48 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Databases and Related Methods</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>Berkeley DB: Databases and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:48 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Databases and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/db_associate.html">Db.associate</a></td><td>Associate a secondary index</td></tr> +<tr><td><a href="../api_java/db_close.html">Db.close</a></td><td>Close a database</td></tr> +<tr><td><a href="../api_java/db_cursor.html">Db.cursor</a></td><td>Create a cursor handle</td></tr> +<tr><td><a href="../api_java/db_del.html">Db.del</a></td><td>Delete items from a database</td></tr> +<tr><td><a href="../api_java/db_err.html">Db.err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_java/db_err.html">Db.errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_java/db_fd.html">Db.fd</a></td><td>Return a file descriptor from a database</td></tr> +<tr><td><a href="../api_java/db_get.html">Db.get</a></td><td>Get items from a database</td></tr> +<tr><td><a href="../api_java/db_get_byteswapped.html">Db.get_byteswapped</a></td><td>Return if the underlying database is in host order</td></tr> +<tr><td><a href="../api_java/db_get_type.html">Db.get_type</a></td><td>Return the database type</td></tr> +<tr><td><a href="../api_java/db_join.html">Db.join</a></td><td>Perform a database join on cursors</td></tr> +<tr><td><a href="../api_java/db_key_range.html">Db.key_range</a></td><td>Return estimate of key location</td></tr> +<tr><td><a href="../api_java/db_open.html">Db.open</a></td><td>Open a database</td></tr> +<tr><td><a href="../api_java/db_get.html">Db.pget</a></td><td>Get items from a database</td></tr> +<tr><td><a href="../api_java/db_put.html">Db.put</a></td><td>Store items into a database</td></tr> +<tr><td><a href="../api_java/db_remove.html">Db.remove</a></td><td>Remove a database</td></tr> +<tr><td><a href="../api_java/db_rename.html">Db.rename</a></td><td>Rename a database</td></tr> +<tr><td><a href="../api_java/db_set_append_recno.html">Db.set_append_recno</a></td><td>Set record append callback</td></tr> +<tr><td><a href="../api_java/db_set_bt_compare.html">Db.set_bt_compare</a></td><td>Set a Btree comparison function</td></tr> +<tr><td><a href="../api_java/db_set_bt_minkey.html">Db.set_bt_minkey</a></td><td>Set the minimum number of keys per Btree page</td></tr> +<tr><td><a href="../api_java/db_set_bt_prefix.html">Db.set_bt_prefix</a></td><td>Set a Btree prefix comparison function</td></tr> +<tr><td><a href="../api_java/db_set_cache_priority.html">Db.set_cache_priority</a></td><td>Set the database cache priority</td></tr> +<tr><td><a href="../api_java/db_set_cachesize.html">Db.set_cachesize</a></td><td>Set the database cache size</td></tr> +<tr><td><a href="../api_java/db_set_dup_compare.html">Db.set_dup_compare</a></td><td>Set a duplicate comparison function</td></tr> +<tr><td><a href="../api_java/db_set_encrypt.html">Db.set_encrypt</a></td><td>Set the database cryptographic key</td></tr> +<tr><td><a href="../api_java/db_set_errcall.html">Db.set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_java/db_set_error_stream.html">Db.set_error_stream</a></td><td>Set error message output stream</td></tr> +<tr><td><a href="../api_java/db_set_errpfx.html">Db.set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_java/db_set_feedback.html">Db.set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_java/db_set_flags.html">Db.set_flags</a></td><td>General database configuration</td></tr> +<tr><td><a href="../api_java/db_set_h_ffactor.html">Db.set_h_ffactor</a></td><td>Set the Hash table density</td></tr> +<tr><td><a href="../api_java/db_set_h_hash.html">Db.set_h_hash</a></td><td>Set a hashing function</td></tr> +<tr><td><a href="../api_java/db_set_h_nelem.html">Db.set_h_nelem</a></td><td>Set the Hash table size</td></tr> +<tr><td><a href="../api_java/db_set_lorder.html">Db.set_lorder</a></td><td>Set the database byte order</td></tr> +<tr><td><a href="../api_java/db_set_pagesize.html">Db.set_pagesize</a></td><td>Set the underlying database page size</td></tr> +<tr><td><a href="../api_java/db_set_q_extentsize.html">Db.set_q_extentsize</a></td><td>Set Queue database extent size</td></tr> +<tr><td><a href="../api_java/db_set_re_delim.html">Db.set_re_delim</a></td><td>Set the variable-length record delimiter</td></tr> +<tr><td><a href="../api_java/db_set_re_len.html">Db.set_re_len</a></td><td>Set the fixed-length record length</td></tr> +<tr><td><a href="../api_java/db_set_re_pad.html">Db.set_re_pad</a></td><td>Set the fixed-length record pad byte</td></tr> +<tr><td><a href="../api_java/db_set_re_source.html">Db.set_re_source</a></td><td>Set the backing Recno text file</td></tr> +<tr><td><a href="../api_java/db_stat.html">Db.stat</a></td><td>Return database statistics</td></tr> +<tr><td><a href="../api_java/db_sync.html">Db.sync</a></td><td>Flush a database to stable storage</td></tr> +<tr><td><a href="../api_java/db_truncate.html">Db.truncate</a></td><td>Empty a database</td></tr> +<tr><td><a href="../api_java/db_upgrade.html">Db.upgrade</a></td><td>Upgrade a database</td></tr> +<tr><td><a href="../api_java/db_verify.html">Db.verify</a></td><td>Verify/salvage a database</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/db_set_error_stream.html b/db/docs/api_java/db_set_error_stream.html new file mode 100644 index 000000000..611ae5420 --- /dev/null +++ b/db/docs/api_java/db_set_error_stream.html @@ -0,0 +1,62 @@ +<!--Id: db_set_error_stream.so,v 10.2 2002/08/18 21:15:54 bostic Exp --> +<!--Id: env_set_error_stream.so,v 10.19 2002/08/18 21:16:27 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Db.set_error_stream</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 width="100%"><tr valign=top> +<td> +<h1>Db.set_error_stream</h1> +</td> +<td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +import com.sleepycat.db.*; +<p> +public void Db.set_error_stream(OutputStream s) + throws DbException +</pre></h3> +<h1>Description</h1> +<p>When an error occurs in the Berkeley DB library, an exception is thrown. In +some cases, however, the <b>errno</b> value may be insufficient to +completely describe the cause of the error, especially during initial +application debugging. +<p>The <a href="../api_java/env_set_error_stream.html">DbEnv.set_error_stream</a> and Db.set_error_stream methods +are used to enhance the mechanism for reporting error messages to the +application by setting a OutputStream 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 stream. +<p>The error message will consist of the prefix string and a colon +("<b>:</b>") (if a prefix string was previously specified using +<a href="../api_java/env_set_errpfx.html">DbEnv.set_errpfx</a>), an error string, and a trailing +<newline> character. +<p>Alternatively, you can use the <a href="../api_java/env_set_errcall.html">DbEnv.set_errcall</a> method to capture the +additional error information in a way that does not use output streams. +You should not mix these approaches. +<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 <a href="../api_java/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the +Db.set_error_stream method affects the entire environment and is equivalent to calling +the <a href="../api_java/env_set_error_stream.html">DbEnv.set_error_stream</a> method. +<h1>Class</h1> +<a href="../api_java/db_class.html">Db</a> +<h1>See Also</h1> +<a href="../api_java/db_list.html">Databases and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_java/dbc_list.html b/db/docs/api_java/dbc_list.html new file mode 100644 index 000000000..a22904748 --- /dev/null +++ b/db/docs/api_java/dbc_list.html @@ -0,0 +1,27 @@ +<!--Id: dbc_list.so,v 1.1 2002/08/30 20:00:49 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Database Cursors and Related Methods</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>Berkeley DB: Database Cursors and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:49 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Database Cursors and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/db_cursor.html">Db.cursor</a></td><td>Create a cursor handle</td></tr> +<tr><td><a href="../api_java/dbc_close.html">Dbc.close</a></td><td>Close a cursor</td></tr> +<tr><td><a href="../api_java/dbc_count.html">Dbc.count</a></td><td>Return count of duplicates</td></tr> +<tr><td><a href="../api_java/dbc_del.html">Dbc.del</a></td><td>Delete by cursor</td></tr> +<tr><td><a href="../api_java/dbc_dup.html">Dbc.dup</a></td><td>Duplicate a cursor</td></tr> +<tr><td><a href="../api_java/dbc_get.html">Dbc.get</a></td><td>Retrieve by cursor</td></tr> +<tr><td><a href="../api_java/dbc_get.html">Dbc.pget</a></td><td>Retrieve by cursor</td></tr> +<tr><td><a href="../api_java/dbc_put.html">Dbc.put</a></td><td>Store by cursor</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/env_class.html b/db/docs/api_java/env_class.html new file mode 100644 index 000000000..25fe3f676 --- /dev/null +++ b/db/docs/api_java/env_class.html @@ -0,0 +1,68 @@ +<!--Id: env_class.so,v 10.32 2002/08/29 03:24:38 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DbEnv</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 width="100%"><tr valign=top> +<td> +<h1>DbEnv</h1> +</td> +<td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +import com.sleepycat.db.*; +<p> +public class DbEnv extends Object +{ + public DbEnv(int flags) throws DbException; + ... +} +</pre></h3> +<h1>Description</h1> +<p>The DbEnv object is the handle for a Berkeley DB environment -- a +collection including support for some or all of caching, locking, +logging and transaction subsystems, as well as databases and log files. +Methods off the DbEnv handle are used to configure the +environment as well as to operate on subsystems and databases in the +environment. +<p>DbEnv handles are free-threaded if the <a href="../api_java/env_open.html#DB_THREAD">Db.DB_THREAD</a> flag +is specified to the <a href="../api_java/env_open.html">DbEnv.open</a> method when the environment is opened. +The DbEnv handle should not be closed while any other handle +remains open that is using it as a reference (for example, <a href="../api_java/db_class.html">Db</a> +or <a href="../api_java/txn_class.html">DbTxn</a>). Once either the <a href="../api_java/env_close.html">DbEnv.close</a> or +<a href="../api_java/env_remove.html">DbEnv.remove</a> methods are called, the handle may not be accessed again, +regardless of the method's return. +<p>The constructor creates the DbEnv object. The constructor +allocates memory internally; calling the <a href="../api_java/env_close.html">DbEnv.close</a> or +<a href="../api_java/env_remove.html">DbEnv.remove</a> methods will free that memory. +<p>The following <b>flags</b> value may be specified: +<p><dl compact> +<p><dt><a name="Db.DB_CLIENT">Db.DB_CLIENT</a><dd>Create a client environment to connect to a server. +<p>The Db.DB_CLIENT flag indicates to the system that this environment +is remote on a server. The use of this flag causes the environment +methods to use functions that call a server instead of local functions. +Prior to making any environment or database method calls, the +application must call the <a href="../api_java/env_set_rpc_server.html">DbEnv.set_rpc_server</a> method to +establish the connection to the server. +</dl> +<h1>Class</h1> +DbEnv +<h1>See Also</h1> +<a href="../api_java/env_list.html">Database Environments and Related Methods</a> +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_java/env_list.html b/db/docs/api_java/env_list.html new file mode 100644 index 000000000..cc5ae1ba7 --- /dev/null +++ b/db/docs/api_java/env_list.html @@ -0,0 +1,78 @@ +<!--Id: env_list.so,v 10.1 2002/08/30 20:00:50 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Database Environments and Related Methods</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>Berkeley DB: Database Environments and Related Methods</h1> +<!--Id: m4.methods,v 10.1 2002/08/30 20:00:51 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Database Environments and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/env_close.html">DbEnv.close</a></td><td>Close an environment</td></tr> +<tr><td><a href="../api_java/env_dbremove.html">DbEnv.dbremove</a></td><td>Remove a database</td></tr> +<tr><td><a href="../api_java/env_dbrename.html">DbEnv.dbrename</a></td><td>Rename a database</td></tr> +<tr><td><a href="../api_java/env_err.html">DbEnv.err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_java/env_err.html">DbEnv.errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_java/lock_detect.html">DbEnv.lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_java/lock_get.html">DbEnv.lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_java/lock_id.html">DbEnv.lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_java/lock_id_free.html">DbEnv.lock_id_free</a></td><td>Release a locker ID</td></tr> +<tr><td><a href="../api_java/lock_put.html">DbEnv.lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_java/lock_stat.html">DbEnv.lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_java/lock_vec.html">DbEnv.lock_vec</a></td><td>Acquire/release locks</td></tr> +<tr><td><a href="../api_java/log_archive.html">DbEnv.log_archive</a></td><td>List log and database files</td></tr> +<tr><td><a href="../api_java/log_file.html">DbEnv.log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_java/log_flush.html">DbEnv.log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_java/log_put.html">DbEnv.log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_java/log_stat.html">DbEnv.log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_java/memp_stat.html">DbEnv.memp_stat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_java/memp_stat.html">DbEnv.memp_fstat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_java/memp_trickle.html">DbEnv.memp_trickle</a></td><td>Trickle flush pages from a memory pool</td></tr> +<tr><td><a href="../api_java/env_open.html">DbEnv.open</a></td><td>Open an environment</td></tr> +<tr><td><a href="../api_java/env_remove.html">DbEnv.remove</a></td><td>Remove an environment</td></tr> +<tr><td><a href="../api_java/rep_elect.html">DbEnv.rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><a href="../api_java/rep_message.html">DbEnv.rep_process_message</a></td><td>Process a replication message</td></tr> +<tr><td><a href="../api_java/rep_start.html">DbEnv.rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><a href="../api_java/rep_stat.html">DbEnv.rep_stat</a></td><td>Replication statistics</td></tr> +<tr><td><a href="../api_java/env_set_app_dispatch.html">DbEnv.set_app_dispatch</a></td><td>Configure application recovery interface</td></tr> +<tr><td><a href="../api_java/env_set_cachesize.html">DbEnv.set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_java/env_set_data_dir.html">DbEnv.set_data_dir</a></td><td>Set the environment data directory</td></tr> +<tr><td><a href="../api_java/env_set_encrypt.html">DbEnv.set_encrypt</a></td><td>Set the environment cryptographic key</td></tr> +<tr><td><a href="../api_java/env_set_errcall.html">DbEnv.set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_java/env_set_error_stream.html">DbEnv.set_error_stream</a></td><td>Set error message output stream</td></tr> +<tr><td><a href="../api_java/env_set_errpfx.html">DbEnv.set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_java/env_set_feedback.html">DbEnv.set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_java/env_set_flags.html">DbEnv.set_flags</a></td><td>Environment configuration</td></tr> +<tr><td><a href="../api_java/env_set_lg_bsize.html">DbEnv.set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_java/env_set_lg_dir.html">DbEnv.set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_java/env_set_lg_max.html">DbEnv.set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_java/env_set_lg_regionmax.html">DbEnv.set_lg_regionmax</a></td><td>Set logging region size</td></tr> +<tr><td><a href="../api_java/env_set_lk_conflicts.html">DbEnv.set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_java/env_set_lk_detect.html">DbEnv.set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_java/env_set_lk_max_lockers.html">DbEnv.set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> +<tr><td><a href="../api_java/env_set_lk_max_locks.html">DbEnv.set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> +<tr><td><a href="../api_java/env_set_lk_max_objects.html">DbEnv.set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> +<tr><td><a href="../api_java/env_set_mp_mmapsize.html">DbEnv.set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> +<tr><td><a href="../api_java/rep_limit.html">DbEnv.set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> +<tr><td><a href="../api_java/rep_transport.html">DbEnv.set_rep_transport</a></td><td>Configure replication transport</td></tr> +<tr><td><a href="../api_java/env_set_rpc_server.html">DbEnv.set_rpc_server</a></td><td>Establish an RPC server connection</td></tr> +<tr><td><a href="../api_java/env_set_shm_key.html">DbEnv.set_shm_key</a></td><td>Set system memory shared segment ID</td></tr> +<tr><td><a href="../api_java/env_set_tas_spins.html">DbEnv.set_tas_spins</a></td><td>Set the number of test-and-set spins</td></tr> +<tr><td><a href="../api_java/env_set_timeout.html">DbEnv.set_timeout</a></td><td>Set lock and transaction timeout</td></tr> +<tr><td><a href="../api_java/env_set_tmp_dir.html">DbEnv.set_tmp_dir</a></td><td>Set the environment temporary file directory</td></tr> +<tr><td><a href="../api_java/env_set_tx_max.html">DbEnv.set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_java/env_set_tx_timestamp.html">DbEnv.set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_java/env_set_verbose.html">DbEnv.set_verbose</a></td><td>Set verbose messages</td></tr> +<tr><td><a href="../api_java/txn_begin.html">DbEnv.txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_java/txn_checkpoint.html">DbEnv.txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_java/txn_recover.html">DbEnv.txn_recover</a></td><td>Distributed transaction recovery</td></tr> +<tr><td><a href="../api_java/txn_stat.html">DbEnv.txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/lock_list.html b/db/docs/api_java/lock_list.html new file mode 100644 index 000000000..6fbcc9395 --- /dev/null +++ b/db/docs/api_java/lock_list.html @@ -0,0 +1,32 @@ +<!--Id: lock_list.so,v 1.1 2002/08/30 20:00:51 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Locking Subsystem and Related Methods</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>Berkeley DB: Locking Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:00:52 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Locking Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/env_set_lk_conflicts.html">DbEnv.set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_java/env_set_lk_detect.html">DbEnv.set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_java/env_set_lk_max_lockers.html">DbEnv.set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> +<tr><td><a href="../api_java/env_set_lk_max_locks.html">DbEnv.set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> +<tr><td><a href="../api_java/env_set_lk_max_objects.html">DbEnv.set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> +<tr><td><a href="../api_java/env_set_timeout.html">DbEnv.set_timeout</a></td><td>Set lock and transaction timeout</td></tr> +<tr><td><a href="../api_java/lock_detect.html">DbEnv.lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_java/lock_get.html">DbEnv.lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_java/lock_id.html">DbEnv.lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_java/lock_id_free.html">DbEnv.lock_id_free</a></td><td>Release a locker ID</td></tr> +<tr><td><a href="../api_java/lock_put.html">DbEnv.lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_java/lock_stat.html">DbEnv.lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_java/lock_vec.html">DbEnv.lock_vec</a></td><td>Acquire/release locks</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/log_list.html b/db/docs/api_java/log_list.html new file mode 100644 index 000000000..e16db8aa2 --- /dev/null +++ b/db/docs/api_java/log_list.html @@ -0,0 +1,32 @@ +<!--Id: log_list.so,v 1.1 2002/08/30 20:00:56 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Logging Subsystem and Related Methods</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>Berkeley DB: Logging Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:01:00 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Logging Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/log_archive.html">DbEnv.log_archive</a></td><td>List log and database files</td></tr> +<tr><td><a href="../api_java/log_cursor.html">DbEnv.log_cursor</a></td><td>Create a log cursor handle</td></tr> +<tr><td><a href="../api_java/log_file.html">DbEnv.log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_java/log_flush.html">DbEnv.log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_java/log_put.html">DbEnv.log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_java/env_set_lg_bsize.html">DbEnv.set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_java/env_set_lg_dir.html">DbEnv.set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_java/env_set_lg_max.html">DbEnv.set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_java/env_set_lg_regionmax.html">DbEnv.set_lg_regionmax</a></td><td>Set logging region size</td></tr> +<tr><td><a href="../api_java/log_compare.html">DbEnv.log_compare</a></td><td>Compare two Log Sequence Numbers</td></tr> +<tr><td><a href="../api_java/log_stat.html">DbEnv.log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_java/logc_close.html">DbLogc.close</a></td><td>Close a log cursor</td></tr> +<tr><td><a href="../api_java/logc_get.html">DbLogc.get</a></td><td>Retrieve a log record</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/memp_class.html b/db/docs/api_java/memp_class.html new file mode 100644 index 000000000..5f5dca239 --- /dev/null +++ b/db/docs/api_java/memp_class.html @@ -0,0 +1,49 @@ +<!--Id: memp_class.so,v 10.14 2002/08/24 18:23:29 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DbMemoryException</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 width="100%"><tr valign=top> +<td> +<h1>DbMemoryException</h1> +</td> +<td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +import com.sleepycat.db.*; +<p> +public class DbMemoryException extends DbException { + public Dbt get_dbt(); +} +</pre></h3> +<h1>Description</h1> +<p>This manual page describes the DbMemoryException class and how +it is used by the various Db* classes. +<p>A DbMemoryException is thrown when there is insufficient memory +to complete an operation, and there is the possibility of recovering. +An example is during a <a href="../api_java/db_get.html">Db.get</a> or <a href="../api_java/dbc_get.html">Dbc.get</a> operation with +the <a href="../api_java/dbt_class.html">Dbt</a> flags set to <a href="../api_java/dbt_class.html#DB_DBT_USERMEM">Db.DB_DBT_USERMEM</a>. +<p>In a Java Virtual Machine, there are usually separate heaps for memory +allocated by native code and for objects allocated in Java code. If the +Java heap is exhausted, the JVM will throw an OutOfMemoryError, so you +may see that exception rather than DbMemoryException. +<p>The <b>get_dbt</b> method returns the <a href="../api_java/dbt_class.html">Dbt</a> that has insufficient +memory to complete the operation, causing the DbMemoryException +to be thrown. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_java/memp_list.html b/db/docs/api_java/memp_list.html new file mode 100644 index 000000000..b3fcef021 --- /dev/null +++ b/db/docs/api_java/memp_list.html @@ -0,0 +1,24 @@ +<!--Id: memp_list.so,v 1.1 2002/08/30 20:01:28 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Memory Pools and Related Methods</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>Berkeley DB: Memory Pools and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:01:28 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Memory Pools and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/env_set_cachesize.html">DbEnv.set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_java/env_set_mp_mmapsize.html">DbEnv.set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> +<tr><td><a href="../api_java/memp_stat.html">DbEnv.memp_stat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_java/memp_stat.html">DbEnv.memp_fstat</a></td><td>Return memory pool statistics</td></tr> +<tr><td><a href="../api_java/memp_trickle.html">DbEnv.memp_trickle</a></td><td>Trickle flush pages from a memory pool</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/mempfile_class.html b/db/docs/api_java/mempfile_class.html new file mode 100644 index 000000000..3c37148d6 --- /dev/null +++ b/db/docs/api_java/mempfile_class.html @@ -0,0 +1,35 @@ +<!--Id: mempfile_class.so,v 10.18 2002/08/24 18:23:33 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: DbMpoolFile</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 width="100%"><tr valign=top> +<td> +<h1>DbMpoolFile</h1> +</td> +<td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +import com.sleepycat.db.*; +<p> +</pre></h3> +<h1>Description</h1> +<p>The DbMpoolFile class is not included in the Berkeley DB +Java API. +</tt> +<table width="100%"><tr><td><br></td><td align=right> +<a href="../api_java/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../reftoc.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/db/docs/api_java/rep_list.html b/db/docs/api_java/rep_list.html new file mode 100644 index 000000000..c2dae3941 --- /dev/null +++ b/db/docs/api_java/rep_list.html @@ -0,0 +1,25 @@ +<!--Id: rep_list.so,v 1.1 2002/08/30 20:02:36 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Replication and Related Methods</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>Berkeley DB: Replication and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:02:36 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Replication and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/rep_transport.html">DbEnv.set_rep_transport</a></td><td>Configure replication transport</td></tr> +<tr><td><a href="../api_java/rep_elect.html">DbEnv.rep_elect</a></td><td>Hold a replication election</td></tr> +<tr><td><a href="../api_java/rep_limit.html">DbEnv.set_rep_limit</a></td><td>Limit data sent in response to a single message</td></tr> +<tr><td><a href="../api_java/rep_message.html">DbEnv.rep_process_message</a></td><td>Process a replication message</td></tr> +<tr><td><a href="../api_java/rep_start.html">DbEnv.rep_start</a></td><td>Configure an environment for replication</td></tr> +<tr><td><a href="../api_java/rep_stat.html">DbEnv.rep_stat</a></td><td>Replication statistics</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/api_java/txn_list.html b/db/docs/api_java/txn_list.html new file mode 100644 index 000000000..13061844e --- /dev/null +++ b/db/docs/api_java/txn_list.html @@ -0,0 +1,31 @@ +<!--Id: txn_list.so,v 1.1 2002/08/30 20:02:41 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB: Berkeley DB: Transaction Subsystem and Related Methods</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>Berkeley DB: Transaction Subsystem and Related Methods</h1> +<!--Id: m4.methods,v 1.1 2002/08/30 20:02:41 bostic Exp --> +<p><table border=1 align=center> +<tr><th>Transaction Subsystem and Related Methods</th><th>Description</th></tr> +<tr><td><a href="../api_java/env_set_tx_max.html">DbEnv.set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_java/env_set_tx_timestamp.html">DbEnv.set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_java/txn_checkpoint.html">DbEnv.txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_java/txn_recover.html">DbEnv.txn_recover</a></td><td>Distributed transaction recovery</td></tr> +<tr><td><a href="../api_java/txn_stat.html">DbEnv.txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +<tr><td><a href="../api_java/txn_begin.html">DbEnv.txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_java/txn_abort.html">DbTxn.abort</a></td><td>Abort a transaction</td></tr> +<tr><td><a href="../api_java/txn_commit.html">DbTxn.commit</a></td><td>Commit a transaction</td></tr> +<tr><td><a href="../api_java/txn_discard.html">DbTxn.discard</a></td><td>Discard a prepared but not resolved transaction handle</td></tr> +<tr><td><a href="../api_java/txn_id.html">DbTxn.id</a></td><td>Return a transaction's ID</td></tr> +<tr><td><a href="../api_java/txn_prepare.html">DbTxn.prepare</a></td><td>Prepare a transaction for commit</td></tr> +<tr><td><a href="../api_java/txn_set_timeout.html">DbTxn.set_timeout</a></td><td>Set transaction timeout</td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/ref/distrib/port.html b/db/docs/ref/distrib/port.html new file mode 100644 index 000000000..d453973e9 --- /dev/null +++ b/db/docs/ref/distrib/port.html @@ -0,0 +1,110 @@ +<!--Id: port.so,v 10.3 2002/08/30 19:57:07 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB Reference Guide: Porting Berkeley DB to new architectures</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> +<table width="100%"><tr valign=top> +<td><h3><dl><dt>Berkeley DB Reference Guide:<dd>Distribution</dl></h3></td> +<td align=right><a href="../../ref/test/faq.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/distrib/layout.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p> +<h1 align=center>Porting Berkeley DB to new architectures</h1> +<p>Berkeley DB is generally easy to port to new architectures. Berkeley DB was +designed to be as portable as possible, and has been ported to a wide +variety of systems, from Wind River's Tornado system, to VMS, to +Windows/NT and Windows/95, and most existing UNIX platforms. It runs +on 16, 32 and 64-bit machines, little or big-endian. The difficulty of +a port depends on how much of the ANSI C and POSIX 1003.1 standards the +new architecture offers. +<p>An abstraction layer separates the main Berkeley DB code from the operating +system and architecture specific components. This layer is comprised +of approximately 2500 lines of C language code, found in the <b>os</b> +subdirectory of the Berkeley DB distribution. The following list of files +include functionality that may need to be modified or implemented in +order to support a new architecture. Within each file, there is usually +one, but sometimes several functions (for example, the +<b>os_alloc.c</b> file contains the malloc, calloc, realloc, free, +and strdup functions). +<p><table border=1 align=center> +<tr><th>Source file</th><th>Description</th></tr> +<tr><td>os_abs.c</td><td>Return if a filename is an absolute pathname</td></tr> +<tr><td>os_alloc.c</td><td>ANSI C malloc, calloc, realloc, strdup, free front-ends</td></tr> +<tr><td>os_clock.c</td><td>Return the current time-of-day</td></tr> +<tr><td>os_config.c</td><td>Return run-time configuration information</td></tr> +<tr><td>os_dir.c</td><td>Read the filenames from a directory</td></tr> +<tr><td>os_errno.c</td><td>Set/get the ANSI C errno value</td></tr> +<tr><td>os_fid.c</td><td>Create a unique ID for a file</td></tr> +<tr><td>os_fsync.c</td><td>POSIX 1003.1 fsync front-end</td></tr> +<tr><td>os_handle.c</td><td>Open file handles</td></tr> +<tr><td>os_id.c</td><td>Return thread ID</td></tr> +<tr><td>os_map.c</td><td>Map a shared memory area</td></tr> +<tr><td>os_method.c</td><td>Run-time replacement of system calls</td></tr> +<tr><td>os_oflags.c</td><td>Convert POSIX 1003.1 open flags, modes to Berkeley DB flags</td></tr> +<tr><td>os_open.c</td><td>Open file handles</td></tr> +<tr><td>os_region.c</td><td>Map a shared memory area</td></tr> +<tr><td>os_rename.c</td><td>POSIX 1003.1 rename call</td></tr> +<tr><td>os_root.c</td><td>Return if application has special permissions</td></tr> +<tr><td>os_rpath.c</td><td>Return last pathname separator</td></tr> +<tr><td>os_rw.c</td><td>POSIX 1003.1 read/write calls</td></tr> +<tr><td>os_seek.c</td><td>POSIX 1003.1 seek call</td></tr> +<tr><td>os_sleep.c</td><td>Cause a thread of control to release the CPU</td></tr> +<tr><td>os_spin.c</td><td>Return the times to spin while waiting for a mutex</td></tr> +<tr><td>os_stat.c</td><td>POSIX 1003.1 stat call</td></tr> +<tr><td>os_tmpdir.c</td><td>Set the path for temporary files</td></tr> +<tr><td>os_unlink.c</td><td>POSIX 1003.1 unlink call</td></tr> +</table> +<p>All but a few of these files contain relatively trivial pieces of code. +Typically, there is only a single version of the code for all platforms +Berkeley DB supports, and that code lives in the <b>os</b> directory of the +distribution. Where different code is required, the code is either +conditionally compiled or an entirely different version is written. For +example, VxWorks versions of some of these files can be found in the +distribution directory os_vxworks, and Win32 versions can be found in +os_win32. +<p>Historically, there are only two difficult questions to answer for each +new port. The first question is how to handle shared memory. In order +to write multiprocess database applications (not multithreaded, but +threads of control running in different address spaces), Berkeley DB must be +able to name pieces of shared memory and access them from multiple +processes. On UNIX/POSIX systems, we use <b>mmap</b> and +<b>shmget</b> for that purpose, but any interface that provides access +to named shared memory is sufficient. If you have a simple, flat +address space, you should be able to use the code in +<b>os_vxworks/os_map.c</b> as a starting point for the port. If you +are not intending to write multiprocess database applications, then +this won't be necessary, as Berkeley DB can simply allocate memory from the +heap if all threads of control will live in a single address space. +<p>The second question is mutex support. Berkeley DB requires some form of +<b>self-blocking</b> mutual exclusion mutex. Blocking mutexes are +preferred as they tend to be less CPU-expensive and less likely to cause +thrashing. If blocking mutexes are not available, however, test-and-set +will work as well. The code for mutexes is in two places in the system: +the include file <b>dbinc/mutex.h</b>, and the distribution directory +<b>mutex</b>. +<p>Berkeley DB uses the GNU autoconf tools for configuration on almost all of +the platforms it supports. Specifically, the include file +<b>db_config.h</b> configures the Berkeley DB build. The simplest way to +begin a port is to configure and build Berkeley DB on a UNIX or UNIX-like +system, and then take the <b>Makefile</b> and <b>db_config.h</b> +file created by that configuration, and modify it by hand to reflect +the needs of the new architecture. Unless you're already familiar with +the GNU autoconf toolset, we don't recommend you take the time to +integrate your changes back into the Berkeley DB autoconfiguration framework. +Instead, send Sleepycat Software context diffs of your changes and any +new source files you created, and we'll integrate the changes into our +source tree. +<p>Finally, we're happy to work with you on the port, or potentially, do +the port ourselves, if that is of interest to you. Regardless, if you +have any porting questions, just let us know, and we will be happy to +answer them. +<table width="100%"><tr><td><br></td><td align=right><a href="../../ref/test/faq.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/distrib/layout.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/ref/env/db_config.html b/db/docs/ref/env/db_config.html new file mode 100644 index 000000000..bfb2afce2 --- /dev/null +++ b/db/docs/ref/env/db_config.html @@ -0,0 +1,51 @@ +<!--Id: db_config.so,v 10.1 2002/09/03 20:09:29 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB Reference Guide: DB_CONFIG configuration file</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><a name="3"><!--meow--></a> +<table width="100%"><tr valign=top> +<td><h3><dl><dt>Berkeley DB Reference Guide:<dd>Environment</dl></h3></td> +<td align=right><a href="../../ref/env/error.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/env/naming.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p> +<h1 align=center>DB_CONFIG configuration file</h1> +<p>Most of the configuration information that can be specified to +<a href="../../api_c/env_class.html">DB_ENV</a> methods can also be specified using a configuration file. +If an environment home directory has been specified (either by the +application specifying a non-NULL <b>db_home</b> argument to +<a href="../../api_c/env_open.html">DB_ENV->open</a>, or by the application setting the +<a href="../../api_c/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a> or <a href="../../api_c/env_open.html#DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a> flags and the +<a href="../../ref/env/naming.html#DB_HOME">DB_HOME</a> environment variable being set), any file named +DB_CONFIG in the database home directory will be read for lines +of the format <b>NAME VALUE</b>. +<p>One or more whitespace characters are used to delimit the two parts of +the line, and trailing whitespace characters are discarded. All empty +lines or lines whose first character is a whitespace or hash +(<b>#</b>) character will be ignored. Each line must specify both +the NAME and the VALUE of the pair. The specific NAME VALUE pairs are +documented in the manual for the corresponding methods (for example, +the <a href="../../api_c/env_set_data_dir.html">DB_ENV->set_data_dir</a> documentation includes NAME VALUE pair +information Berkeley DB administrators can use to configure locations for +database files). +<p>The DB_CONFIG configuration file is intended to allow database +environment administrators to customize environments independent of +applications using the environment. For example, a database +administrator can move the database log and data files to a different +location without application recompilation. In addition, because the +DB_CONFIG file is read when the database environment is opened, +it can be used to overrule application configuration done before that +time. For example a database administrator could override the +compiled-in application cache size to a size more appropriate for a +specific machine. +<table width="100%"><tr><td><br></td><td align=right><a href="../../ref/env/error.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/env/naming.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/ref/upgrade.4.1/cxx.html b/db/docs/ref/upgrade.4.1/cxx.html new file mode 100644 index 000000000..0e6958823 --- /dev/null +++ b/db/docs/ref/upgrade.4.1/cxx.html @@ -0,0 +1,48 @@ +<!--Id: cxx.so,v 1.3 2002/08/27 02:28:31 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB Reference Guide: Release 4.1: C++ exceptions</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> +<table width="100%"><tr valign=top> +<td><h3><dl><dt>Berkeley DB Reference Guide:<dd>Upgrading Berkeley DB Applications</dl></h3></td> +<td align=right><a href="../../ref/upgrade.4.1/java.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/upgrade.4.1/app_dispatch.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p> +<h1 align=center>Release 4.1: C++ exceptions</h1> +<p>With default flags, the C++ <a href="../../api_cxx/env_class.html">DbEnv</a> and <a href="../../api_cxx/db_class.html">Db</a> classes +can throw exceptions from their constructors. For example, this can +happen if invalid parameters are passed in or the underlying C +structures could not be created. If the objects are created in an +environment that is not configured for exceptions (that is, the +<a href="../../api_c/env_class.html#DB_CXX_NO_EXCEPTIONS">DB_CXX_NO_EXCEPTIONS</a> flag is specified), errors from the +constructor will be returned when the handle's open method is called. +<p>In addition, the behavior of the <a href="../../api_cxx/env_class.html">DbEnv</a> and <a href="../../api_cxx/db_class.html">Db</a> +destructors has changed to simplify exception handling in applications. +The destructors will now close the handle if the handle's close method +was not called prior to the object being destroyed. The return value +of the call is discarded, and no exceptions will be thrown. +Applications should call the close method in normal situations so any +errors while closing can be handled by the application. +<p>This change allows applications to be structured as follows: +<p><blockquote><pre>try { + DbEnv env(0); + env.open(/* ... */); + Db db(&env, 0); + db.open(/* ... */); + /* ... */ + db.close(0); + env.close(0); +} catch (DbException &dbe) { + // Handle the exception, the handles have already been closed. +}</pre></blockquote> +<table width="100%"><tr><td><br></td><td align=right><a href="../../ref/upgrade.4.1/java.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/upgrade.4.1/app_dispatch.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/ref/upgrade.4.1/hash_nelem.html b/db/docs/ref/upgrade.4.1/hash_nelem.html new file mode 100644 index 000000000..1da26083d --- /dev/null +++ b/db/docs/ref/upgrade.4.1/hash_nelem.html @@ -0,0 +1,25 @@ +<!--Id: hash_nelem.so,v 1.2 2002/08/26 23:05:29 mjc Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB Reference Guide: Release 4.1: DB->stat.hash_nelem</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> +<table width="100%"><tr valign=top> +<td><h3><dl><dt>Berkeley DB Reference Guide:<dd>Upgrading Berkeley DB Applications</dl></h3></td> +<td align=right><a href="../../ref/upgrade.4.1/memp_sync.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/upgrade.4.1/java.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p> +<h1 align=center>Release 4.1: DB->stat.hash_nelem</h1> +<p>The <b>hash_nelem</b> field of the <a href="../../api_c/db_stat.html">DB->stat</a> method for Hash +databases has been removed from the 4.1 release, this information is no +longer available to applications. +<table width="100%"><tr><td><br></td><td align=right><a href="../../ref/upgrade.4.1/memp_sync.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/upgrade.4.1/java.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/docs/ref/upgrade.4.1/java.html b/db/docs/ref/upgrade.4.1/java.html new file mode 100644 index 000000000..ac1f17654 --- /dev/null +++ b/db/docs/ref/upgrade.4.1/java.html @@ -0,0 +1,29 @@ +<!--Id: java.so,v 1.2 2002/08/27 01:11:08 bostic Exp --> +<!--Copyright 1997-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<!--See the file LICENSE for redistribution information.--> +<html> +<head> +<title>Berkeley DB Reference Guide: Release 4.1: Java exceptions</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> +<table width="100%"><tr valign=top> +<td><h3><dl><dt>Berkeley DB Reference Guide:<dd>Upgrading Berkeley DB Applications</dl></h3></td> +<td align=right><a href="../../ref/upgrade.4.1/hash_nelem.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/upgrade.4.1/cxx.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p> +<h1 align=center>Release 4.1: Java exceptions</h1> +<p>The Java <a href="../../api_java/env_class.html">DbEnv</a> constructor is now marked with "throws +DbException". This means applications must construct <a href="../../api_java/env_class.html">DbEnv</a> +objects in a context where <a href="../../api_java/except_class.html">DbException</a> throwables are +handled (either in a try/catch block or in a method that propagates the +exception up the stack). Note that previous versions of the Berkeley DB Java +API could throw this exception from the constructor but it was not +marked. +<table width="100%"><tr><td><br></td><td align=right><a href="../../ref/upgrade.4.1/hash_nelem.html"><img src="../../images/prev.gif" alt="Prev"></a><a href="../../reftoc.html"><img src="../../images/ref.gif" alt="Ref"></a><a href="../../ref/upgrade.4.1/cxx.html"><img src="../../images/next.gif" alt="Next"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/db/test/scr016/TestStat.java b/db/test/scr016/TestStat.java new file mode 100644 index 000000000..036e6290c --- /dev/null +++ b/db/test/scr016/TestStat.java @@ -0,0 +1,57 @@ +/*- + * See the file LICENSE for redistribution information. + * + * Copyright (c) 1997-2002 + * Sleepycat Software. All rights reserved. + * + * Id: TestStat.java,v 1.1 2002/08/16 19:35:56 dda Exp + */ + +/* + * Simple test for get/put of specific values. + */ + +package com.sleepycat.test; + +import com.sleepycat.db.*; +import java.io.FileNotFoundException; + +public class TestStat +{ + public static void main(String[] args) + { + int envflags = + Db.DB_INIT_MPOOL | Db.DB_INIT_LOCK | + Db.DB_INIT_LOG | Db.DB_INIT_TXN | Db.DB_CREATE; + try { + DbEnv dbenv = new DbEnv(0); + dbenv.open(".", envflags, 0); + Db db = new Db(dbenv, 0); + db.open(null, "my.db", null, Db.DB_BTREE, Db.DB_CREATE, 0); + + TestUtil.populate(db); + System.out.println("BtreeStat:"); + DbBtreeStat stat = (DbBtreeStat)db.stat(0); + System.out.println(" bt_magic: " + stat.bt_magic); + + System.out.println("LogStat:"); + DbLogStat logstat = dbenv.log_stat(0); + System.out.println(" st_magic: " + logstat.st_magic); + System.out.println(" st_cur_file: " + logstat.st_cur_file); + + System.out.println("RepStat:"); + DbRepStat repstat = dbenv.rep_stat(0); + System.out.println(" st_status: " + repstat.st_status); + System.out.println(" st_log_duplication: " + + repstat.st_log_duplicated); + + System.out.println("finished test"); + } + catch (DbException dbe) { + System.err.println("Db Exception: " + dbe); + } + catch (FileNotFoundException fnfe) { + System.err.println("FileNotFoundException: " + fnfe); + } + } +} diff --git a/db/test/scr016/TestStat.testout b/db/test/scr016/TestStat.testout new file mode 100644 index 000000000..caf9db1fb --- /dev/null +++ b/db/test/scr016/TestStat.testout @@ -0,0 +1,11 @@ +got data: data +get using bad key: DB_NOTFOUND: No matching key/data pair found +BtreeStat: + bt_magic: 340322 +LogStat: + st_magic: 264584 + st_cur_file: 1 +RepStat: + st_status: 0 + st_log_duplication: 0 +finished test diff --git a/db/test/scr016/TestUtil.java b/db/test/scr016/TestUtil.java new file mode 100644 index 000000000..00d99a03c --- /dev/null +++ b/db/test/scr016/TestUtil.java @@ -0,0 +1,57 @@ +/*- + * See the file LICENSE for redistribution information. + * + * Copyright (c) 1997-2002 + * Sleepycat Software. All rights reserved. + * + * Id: TestUtil.java,v 1.1 2002/08/16 19:35:56 dda Exp + */ + +/* + * Utilities used by many tests. + */ + +package com.sleepycat.test; + +import com.sleepycat.db.*; +import java.io.FileNotFoundException; + +public class TestUtil +{ + public static void populate(Db db) + throws DbException + { + // populate our massive database. + Dbt keydbt = new Dbt("key".getBytes()); + Dbt datadbt = new Dbt("data".getBytes()); + db.put(null, keydbt, datadbt, 0); + + // Now, retrieve. We could use keydbt over again, + // but that wouldn't be typical in an application. + Dbt goodkeydbt = new Dbt("key".getBytes()); + Dbt badkeydbt = new Dbt("badkey".getBytes()); + Dbt resultdbt = new Dbt(); + resultdbt.set_flags(Db.DB_DBT_MALLOC); + + int ret; + + if ((ret = db.get(null, goodkeydbt, resultdbt, 0)) != 0) { + System.out.println("get: " + DbEnv.strerror(ret)); + } + else { + String result = + new String(resultdbt.get_data(), 0, resultdbt.get_size()); + System.out.println("got data: " + result); + } + + if ((ret = db.get(null, badkeydbt, resultdbt, 0)) != 0) { + // We expect this... + System.out.println("get using bad key: " + DbEnv.strerror(ret)); + } + else { + String result = + new String(resultdbt.get_data(), 0, resultdbt.get_size()); + System.out.println("*** got data using bad key!!: " + result); + } + } +} diff --git a/db/test/test100.tcl b/db/test/test100.tcl new file mode 100644 index 000000000..e72408e8f --- /dev/null +++ b/db/test/test100.tcl @@ -0,0 +1,17 @@ +# See the file LICENSE for redistribution information. +# +# Copyright (c) 2000-2002 +# Sleepycat Software. All rights reserved. +# +# Id: test100.tcl,v 11.1 2002/08/15 20:55:20 sandstro Exp +# +# TEST test100 +# TEST Test for functionality near the end of the queue +# TEST using test025 (DB_APPEND). +proc test100 { method {nentries 10000} {txn -txn} {tnum "100"} args} { + if { [is_queueext $method ] == 0 } { + puts "Skipping test0$tnum for $method." + return; + } + eval {test025 $method $nentries 4294967000 $tnum} $args +} diff --git a/db/test/test101.tcl b/db/test/test101.tcl new file mode 100644 index 000000000..578171ce6 --- /dev/null +++ b/db/test/test101.tcl @@ -0,0 +1,17 @@ +# See the file LICENSE for redistribution information. +# +# Copyright (c) 2000-2002 +# Sleepycat Software. All rights reserved. +# +# Id: test101.tcl,v 11.1 2002/08/15 20:55:20 sandstro Exp +# +# TEST test101 +# TEST Test for functionality near the end of the queue +# TEST using test070 (DB_CONSUME). +proc test101 { method {nentries 10000} {txn -txn} {tnum "101"} args} { + if { [is_queueext $method ] == 0 } { + puts "Skipping test0$tnum for $method." + return; + } + eval {test070 $method 4 2 1000 WAIT 4294967000 $txn $tnum} $args +} |