diff options
| author | unknown <tim@threads.polyesthetic.msg> | 2001-03-04 19:42:05 -0500 |
|---|---|---|
| committer | unknown <tim@threads.polyesthetic.msg> | 2001-03-04 19:42:05 -0500 |
| commit | ec6ae091617bdfdca9e65e8d3e65b950d234f676 (patch) | |
| tree | 9dd732e08dba156ee3d7635caedc0dc3107ecac6 /bdb/docs/api_c | |
| parent | 87d70fb598105b64b538ff6b81eef9da626255b1 (diff) | |
| download | mariadb-git-ec6ae091617bdfdca9e65e8d3e65b950d234f676.tar.gz | |
Import changeset
Diffstat (limited to 'bdb/docs/api_c')
144 files changed, 13506 insertions, 0 deletions
diff --git a/bdb/docs/api_c/c_index.html b/bdb/docs/api_c/c_index.html new file mode 100644 index 00000000000..4b6023c8057 --- /dev/null +++ b/bdb/docs/api_c/c_index.html @@ -0,0 +1,172 @@ +<!--$Id: c_index.so,v 10.53 2000/12/21 19:11:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: C Interface by Function/Structure</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>C Interface by Function/Structure</h1> +<p><table border=1 align=center> +<tr><th>Database Environment</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">DBENV->close</a></td><td>Close an environment</td></tr> +<tr><td><a href="../api_c/db_err.html">DBENV->err</a></td><td>Error message with error string</td></tr> +<tr><td><a href="../api_c/db_err.html">DBENV->errx</a></td><td>Error message</td></tr> +<tr><td><a href="../api_c/env_open.html">DBENV->open</a></td><td>Open an environment</td></tr> +<tr><td><a href="../api_c/env_remove.html">DBENV->remove</a></td><td>Remove an environment</td></tr> +<tr><td><a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_c/env_set_data_dir.html">DBENV->set_data_dir</a></td><td>Set the environment data directory</td></tr> +<tr><td><a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a></td><td>Set error message callback</td></tr> +<tr><td><a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a></td><td>Set error message FILE</td></tr> +<tr><td><a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a></td><td>Set error message prefix</td></tr> +<tr><td><a href="../api_c/env_set_feedback.html">DBENV->set_feedback</a></td><td>Set feedback callback</td></tr> +<tr><td><a href="../api_c/env_set_flags.html">DBENV->set_flags</a></td><td>Environment configuration</td></tr> +<tr><td><a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a></td><td>Turn off mutual exclusion locking</td></tr> +<tr><td><a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a></td><td>Set panic callback</td></tr> +<tr><td><a href="../api_c/env_set_rec_init.html">DBENV->set_recovery_init</a></td><td>Set recovery initialization callback</td></tr> +<tr><td><a href="../api_c/env_set_server.html">DBENV->set_server</a></td><td>Establish server connection</td></tr> +<tr><td><a href="../api_c/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_c/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_c/env_set_verbose.html">DBENV->set_verbose</a></td><td>Set verbose messages</td></tr> +<tr><td><a href="../api_c/env_strerror.html">db_strerror</a></td><td>Error strings</td></tr> +<tr><td><a href="../api_c/env_version.html">db_version</a></td><td>Return version information</td></tr> +<tr><th>Database Operations</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_close.html">DB->close</a></td><td>Close a database</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_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_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_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_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_malloc.html">DB->set_malloc</a></td><td>Set a local space allocation function</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_set_realloc.html">DB->set_realloc</a></td><td>Set a local space allocation function</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_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> +<tr><th>Database Cursors</th><th>Description</th></tr> +<tr><td><a href="../api_c/db_cursor.html">DB->cursor</a></td><td>Open a cursor into a database</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_put.html">DBcursor->c_put</a></td><td>Store by cursor</td></tr> +<tr><th>Lock Manager</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> +<tr><td><a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> +<tr><td><a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a></td><td>Set maximum number of locks (<b>Deprecated</b>)</td></tr> +<tr><td><a href="../api_c/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_c/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_c/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_c/lock_detect.html">lock_detect</a></td><td>Perform deadlock detection</td></tr> +<tr><td><a href="../api_c/lock_get.html">lock_get</a></td><td>Acquire a lock</td></tr> +<tr><td><a href="../api_c/lock_id.html">lock_id</a></td><td>Acquire a locker ID</td></tr> +<tr><td><a href="../api_c/lock_put.html">lock_put</a></td><td>Release a lock</td></tr> +<tr><td><a href="../api_c/lock_stat.html">lock_stat</a></td><td>Return lock subsystem statistics</td></tr> +<tr><td><a href="../api_c/lock_vec.html">lock_vec</a></td><td>Acquire/release locks</td></tr> +<tr><th>Log Manager</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a></td><td>Set log buffer size</td></tr> +<tr><td><a href="../api_c/env_set_lg_dir.html">DBENV->set_lg_dir</a></td><td>Set the environment logging directory</td></tr> +<tr><td><a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a></td><td>Set log file size</td></tr> +<tr><td><a href="../api_c/log_archive.html">log_archive</a></td><td>List log and database files</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_file.html">log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> +<tr><td><a href="../api_c/log_flush.html">log_flush</a></td><td>Flush log records</td></tr> +<tr><td><a href="../api_c/log_get.html">log_get</a></td><td>Get a log record</td></tr> +<tr><td><a href="../api_c/log_put.html">log_put</a></td><td>Write a log record</td></tr> +<tr><td><a href="../api_c/log_register.html">log_register</a></td><td>Register a file name with the log manager</td></tr> +<tr><td><a href="../api_c/log_stat.html">log_stat</a></td><td>Return log subsystem statistics</td></tr> +<tr><td><a href="../api_c/log_unregister.html">log_unregister</a></td><td>Unregister a file name with the log manager</td></tr> +<tr><th>Buffer Pool</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a></td><td>Set the environment cache size</td></tr> +<tr><td><a href="../api_c/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_c/memp_fclose.html">memp_fclose</a></td><td>Close a file in a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_fget.html">memp_fget</a></td><td>Get a page from a file in a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_fopen.html">memp_fopen</a></td><td>Open a file in a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_fput.html">memp_fput</a></td><td>Return a page to a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_fset.html">memp_fset</a></td><td>Modify meta information for buffer pool page</td></tr> +<tr><td><a href="../api_c/memp_fsync.html">memp_fsync</a></td><td>Flush pages from a file in a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_register.html">memp_register</a></td><td>Register input/output functions for a file in a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_stat.html">memp_stat</a></td><td>Return buffer pool statistics</td></tr> +<tr><td><a href="../api_c/memp_sync.html">memp_sync</a></td><td>Flush pages from a buffer pool</td></tr> +<tr><td><a href="../api_c/memp_trickle.html">memp_trickle</a></td><td>Trickle flush pages from a buffer pool</td></tr> +<tr><th>Transaction Manager</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a></td><td>Set maximum number of transactions</td></tr> +<tr><td><a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a></td><td>Set transaction abort recover function</td></tr> +<tr><td><a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> +<tr><td><a href="../api_c/txn_abort.html">txn_abort</a></td><td>Abort a transaction</td></tr> +<tr><td><a href="../api_c/txn_begin.html">txn_begin</a></td><td>Begin a transaction</td></tr> +<tr><td><a href="../api_c/txn_checkpoint.html">txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> +<tr><td><a href="../api_c/txn_commit.html">txn_commit</a></td><td>Commit a transaction</td></tr> +<tr><td><a href="../api_c/txn_id.html">txn_id</a></td><td>Return a transaction ID</td></tr> +<tr><td><a href="../api_c/txn_prepare.html">txn_prepare</a></td><td>Prepare a transaction for commit</td></tr> +<tr><td><a href="../api_c/txn_stat.html">txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> +<tr><th>Historic Interfaces</th><th>Description</th></tr> +<tr><td><a href="../api_c/dbm.html">dbm</a></td><td>UNIX Dbm/Ndbm Interfaces</td></tr> +<tr><td><a href="../api_c/hsearch.html">hsearch</a></td><td>UNIX Hsearch Interfaces</td></tr> +<tr><th>Data Structures</th><th>Description</th></tr> +<tr><td><a href="../api_c/dbt.html">DBT</a></td><td>DBT structures</td></tr> +<tr><td><a href="../api_c/db_lsn.html">DB_LSN</a></td><td>DB_LSN structures</td></tr> +<tr><th>DB Library Configuration</th><th>Description</th></tr> +<tr><td><a href="../api_c/env_set_pageyield.html">db_env_set_pageyield</a></td><td>Yield the processor on each page access</td></tr> +<tr><td><a href="../api_c/env_set_panicstate.html">db_env_set_panicstate</a></td><td>Reset panic state</td></tr> +<tr><td><a href="../api_c/env_set_region_init.html">db_env_set_region_init</a></td><td>Fault in shared regions on initial access</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><th>DB System Call Configuration</th><th>Description</th></tr> +<tr><td><a href="../api_c/set_func_close.html">db_env_set_func_close</a></td><td>Replace underlying Berkeley DB system interfaces</td></tr> +<tr><td><a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_exists.html">db_env_set_func_exists</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_free.html">db_env_set_func_free</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_map.html">db_env_set_func_map</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_open.html">db_env_set_func_open</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_read.html">db_env_set_func_read</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_rename.html">db_env_set_func_rename</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_seek.html">db_env_set_func_seek</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_write.html">db_env_set_func_write</a></td><td><br></td></tr> +<tr><td><a href="../api_c/set_func_yield.html">db_env_set_func_yield</a></td><td><br></td></tr> +</table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/c_pindex.html b/bdb/docs/api_c/c_pindex.html new file mode 100644 index 00000000000..725bf0068a9 --- /dev/null +++ b/bdb/docs/api_c/c_pindex.html @@ -0,0 +1,530 @@ +<html> +<head> +<title>Berkeley DB: C Interface Index</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> +<h1 align=center>C Interface Index</h1> +<center> +<table cellspacing=0 cellpadding=0> +<tr><td align=right> configuring Berkeley DB </td><td><a href="../ref/build_unix/conf.html#5">1.85</a> API compatibility</td></tr> +<tr><td align=right> building a utility to dump Berkeley DB </td><td><a href="../ref/build_unix/conf.html#7">1.85</a> databases</td></tr> +<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.2.0/intro.html#2">2.0</a></td></tr> +<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.3.0/intro.html#2">3.0</a></td></tr> +<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.3.1/intro.html#2">3.1</a></td></tr> +<tr><td align=right> Upgrading to release </td><td><a href="../ref/upgrade.3.2/intro.html#2">3.2</a></td></tr> +<tr><td align=right> selecting an </td><td><a href="../ref/am_conf/select.html#2">access</a> method</td></tr> +<tr><td align=right> </td><td><a href="../ref/am_conf/intro.html#2">access</a> methods</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/aix.html#2">AIX</a></td></tr> +<tr><td align=right> data </td><td><a href="../api_c/dbt.html#5">alignment</a></td></tr> +<tr><td align=right> programmatic </td><td><a href="../ref/arch/apis.html#2">APIs</a></td></tr> +<tr><td align=right> utility to </td><td><a href="../utility/db_archive.html#3">archive</a> log files</td></tr> +<tr><td align=right> </td><td><a href="../utility/berkeley_db_svc.html#2">berkeley_db_svc</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/intro.html#2">building</a> for UNIX</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/notes.html#2">building</a> for UNIX FAQ</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_vxworks/intro.html#2">building</a> for VxWorks</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_vxworks/faq.html#2">building</a> for VxWorks FAQ</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_win/intro.html#2">building</a> for Win32</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_win/faq.html#2">building</a> for Windows FAQ</td></tr> +<tr><td align=right> selecting a </td><td><a href="../ref/am_conf/byteorder.html#2">byte</a> order</td></tr> +<tr><td align=right> </td><td><a href="../ref/program/byteorder.html#2">byte</a> ordering</td></tr> +<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#6">C++</a> API</td></tr> +<tr><td align=right> flushing the database </td><td><a href="../ref/am/sync.html#2">cache</a></td></tr> +<tr><td align=right> selecting a </td><td><a href="../ref/am_conf/cachesize.html#2">cache</a> size</td></tr> +<tr><td align=right> </td><td><a href="../ref/transapp/archival.html#3">catastrophic</a> recovery</td></tr> +<tr><td align=right>Patches, Updates and </td><td><a href="http://www.sleepycat.com/update/index.html">Change</a> logs</td></tr> +<tr><td align=right> utility to take </td><td><a href="../utility/db_checkpoint.html#3">checkpoints</a></td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#clear_len">clear_len</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/am/curclose.html#2">closing</a> a cursor</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/close.html#2">closing</a> a database</td></tr> +<tr><td align=right> specifying a Btree </td><td><a href="../ref/am_conf/bt_compare.html#2">comparison</a> function</td></tr> +<tr><td align=right> changing </td><td><a href="../ref/build_unix/flags.html#2">compile</a> or load options</td></tr> +<tr><td align=right> </td><td><a href="../ref/cam/intro.html#2">Concurrent</a> Data Store</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/conf.html#2">configuring</a> Berkeley DB for UNIX systems</td></tr> +<tr><td align=right> recovering </td><td><a href="../ref/am/verify.html#4">corrupted</a> databases</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/count.html#2">counting</a> data items for a key</td></tr> +<tr><td align=right> closing a </td><td><a href="../ref/am/curclose.html#3">cursor</a></td></tr> +<tr><td align=right> deleting records with a </td><td><a href="../ref/am/curdel.html#3">cursor</a></td></tr> +<tr><td align=right> duplicating a </td><td><a href="../ref/am/curdup.html#3">cursor</a></td></tr> +<tr><td align=right> retrieving records with a </td><td><a href="../ref/am/curget.html#3">cursor</a></td></tr> +<tr><td align=right> storing records with a </td><td><a href="../ref/am/curput.html#3">cursor</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/am/stability.html#2">cursor</a> stability</td></tr> +<tr><td align=right> database </td><td><a href="../ref/am/cursor.html#2">cursors</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#data">data</a></td></tr> +<tr><td align=right> utility to upgrade </td><td><a href="../utility/db_upgrade.html#3">database</a> files</td></tr> +<tr><td align=right> utility to verify </td><td><a href="../utility/db_verify.html#3">database</a> files</td></tr> +<tr><td align=right>DBcursor->c_put</td><td><a href="../api_c/dbc_put.html#DB_AFTER">DB_AFTER</a></td></tr> +<tr><td align=right>DB->verify</td><td><a href="../api_c/db_verify.html#DB_AGGRESSIVE">DB_AGGRESSIVE</a></td></tr> +<tr><td align=right>DB->put</td><td><a href="../api_c/db_put.html#DB_APPEND">DB_APPEND</a></td></tr> +<tr><td align=right>log_archive</td><td><a href="../api_c/log_archive.html#DB_ARCH_ABS">DB_ARCH_ABS</a></td></tr> +<tr><td align=right>log_archive</td><td><a href="../api_c/log_archive.html#DB_ARCH_DATA">DB_ARCH_DATA</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_archive.html#2">db_archive</a></td></tr> +<tr><td align=right>log_archive</td><td><a href="../api_c/log_archive.html#DB_ARCH_LOG">DB_ARCH_LOG</a></td></tr> +<tr><td align=right>DBcursor->c_put</td><td><a href="../api_c/dbc_put.html#DB_BEFORE">DB_BEFORE</a></td></tr> +<tr><td align=right>DB->stat</td><td><a href="../api_c/db_stat.html#DB_CACHED_COUNTS">DB_CACHED_COUNTS</a></td></tr> +<tr><td align=right>DBENV->set_flags</td><td><a href="../api_c/env_set_flags.html#DB_CDB_ALLDB">DB_CDB_ALLDB</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_CHECKPOINT">DB_CHECKPOINT</a></td></tr> +<tr><td align=right>log_put</td><td><a href="../api_c/log_put.html#DB_CHECKPOINT">DB_CHECKPOINT</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_checkpoint.html#2">db_checkpoint</a></td></tr> +<tr><td align=right>db_env_create</td><td><a href="../api_c/env_create.html#DB_CLIENT">DB_CLIENT</a></td></tr> +<tr><td align=right>File naming</td><td><a href="../ref/env/naming.html#DB_CONFIG">DB_CONFIG</a></td></tr> +<tr><td align=right>DB->get</td><td><a href="../api_c/db_get.html#DB_CONSUME">DB_CONSUME</a></td></tr> +<tr><td align=right>DB->get</td><td><a href="../api_c/db_get.html#DB_CONSUME_WAIT">DB_CONSUME_WAIT</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_create.html#2">db_create</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_CREATE">DB_CREATE</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_CREATE">DB_CREATE</a></td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#DB_CREATE">DB_CREATE</a></td></tr> +<tr><td align=right>log_put</td><td><a href="../api_c/log_put.html#DB_CURLSN">DB_CURLSN</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_CURRENT">DB_CURRENT</a></td></tr> +<tr><td align=right>DBcursor->c_put</td><td><a href="../api_c/dbc_put.html#DB_CURRENT">DB_CURRENT</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_CURRENT">DB_CURRENT</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbc_close.html#2">DBcursor->c_close</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbc_count.html#2">DBcursor->c_count</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbc_del.html#2">DBcursor->c_del</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbc_dup.html#2">DBcursor->c_dup</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbc_get.html#2">DBcursor->c_get</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbc_put.html#2">DBcursor->c_put</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#DB_DBT_PARTIAL">DB_DBT_PARTIAL</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_deadlock.html#2">db_deadlock</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_dump.html#2">db_dump</a></td></tr> +<tr><td align=right>DB->set_flags</td><td><a href="../api_c/db_set_flags.html#DB_DUP">DB_DUP</a></td></tr> +<tr><td align=right>DB->set_flags</td><td><a href="../api_c/db_set_flags.html#DB_DUPSORT">DB_DUPSORT</a></td></tr> +<tr><td align=right>DB->upgrade</td><td><a href="../api_c/db_upgrade.html#DB_DUPSORT">DB_DUPSORT</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_create.html#2">db_env_create</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_close.html#2">DBENV->close</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_err.html#2">DBENV->err</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_open.html#2">DBENV->open</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_remove.html#2">DBENV->remove</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_cachesize.html#2">DBENV->set_cachesize</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_data_dir.html#2">DBENV->set_data_dir</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_errcall.html#2">DBENV->set_errcall</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_errfile.html#2">DBENV->set_errfile</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_errpfx.html#2">DBENV->set_errpfx</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_feedback.html#2">DBENV->set_feedback</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_flags.html#2">DBENV->set_flags</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lg_bsize.html#2">DBENV->set_lg_bsize</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lg_dir.html#2">DBENV->set_lg_dir</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lg_max.html#2">DBENV->set_lg_max</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lk_conflicts.html#2">DBENV->set_lk_conflicts</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lk_detect.html#2">DBENV->set_lk_detect</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lk_max.html#2">DBENV->set_lk_max</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lk_max_lockers.html#2">DBENV->set_lk_max_lockers</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lk_max_locks.html#2">DBENV->set_lk_max_locks</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_lk_max_objects.html#2">DBENV->set_lk_max_objects</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_mp_mmapsize.html#2">DBENV->set_mp_mmapsize</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_mutexlocks.html#2">DBENV->set_mutexlocks</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_paniccall.html#2">DBENV->set_paniccall</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_rec_init.html#2">DBENV->set_recovery_init</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_server.html#2">DBENV->set_server</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_shm_key.html#2">DBENV->set_shm_key</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_tmp_dir.html#2">DBENV->set_tmp_dir</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_tx_max.html#2">DBENV->set_tx_max</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_tx_recover.html#2">DBENV->set_tx_recover</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_tx_timestamp.html#2">DBENV->set_tx_timestamp</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_verbose.html#2">DBENV->set_verbose</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_close.html#2">db_env_set_func_close</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_dirfree.html#2">db_env_set_func_dirfree</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_dirlist.html#2">db_env_set_func_dirlist</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_exists.html#2">db_env_set_func_exists</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_free.html#2">db_env_set_func_free</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_fsync.html#2">db_env_set_func_fsync</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_ioinfo.html#2">db_env_set_func_ioinfo</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_malloc.html#2">db_env_set_func_malloc</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_map.html#2">db_env_set_func_map</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_open.html#2">db_env_set_func_open</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_read.html#2">db_env_set_func_read</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_realloc.html#2">db_env_set_func_realloc</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_rename.html#2">db_env_set_func_rename</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_seek.html#2">db_env_set_func_seek</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_sleep.html#2">db_env_set_func_sleep</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_unlink.html#2">db_env_set_func_unlink</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_unmap.html#2">db_env_set_func_unmap</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_write.html#2">db_env_set_func_write</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/set_func_yield.html#2">db_env_set_func_yield</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_pageyield.html#2">db_env_set_pageyield</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_panicstate.html#2">db_env_set_panicstate</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_region_init.html#2">db_env_set_region_init</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_set_tas_spins.html#2">db_env_set_tas_spins</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_EXCL">DB_EXCL</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_FIRST">DB_FIRST</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_FIRST">DB_FIRST</a></td></tr> +<tr><td align=right>log_put</td><td><a href="../api_c/log_put.html#DB_FLUSH">DB_FLUSH</a></td></tr> +<tr><td align=right>DBENV->remove</td><td><a href="../api_c/env_remove.html#DB_FORCE">DB_FORCE</a></td></tr> +<tr><td align=right>txn_checkpoint</td><td><a href="../api_c/txn_checkpoint.html#DB_FORCE">DB_FORCE</a></td></tr> +<tr><td align=right>DB->get</td><td><a href="../api_c/db_get.html#DB_GET_BOTH">DB_GET_BOTH</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_GET_BOTH">DB_GET_BOTH</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_GET_RECNO">DB_GET_RECNO</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_close.html#2">DB->close</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_cursor.html#2">DB->cursor</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_del.html#2">DB->del</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_fd.html#2">DB->fd</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_get.html#2">DB->get</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_get_byteswapped.html#2">DB->get_byteswapped</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_get_type.html#2">DB->get_type</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_join.html#2">DB->join</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_key_range.html#2">DB->key_range</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_open.html#2">DB->open</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_put.html#2">DB->put</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_remove.html#2">DB->remove</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_rename.html#2">DB->rename</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_append_recno.html#2">DB->set_append_recno</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_bt_compare.html#2">DB->set_bt_compare</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_bt_minkey.html#2">DB->set_bt_minkey</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_bt_prefix.html#2">DB->set_bt_prefix</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_cachesize.html#2">DB->set_cachesize</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_dup_compare.html#2">DB->set_dup_compare</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_errcall.html#2">DB->set_errcall</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_errfile.html#2">DB->set_errfile</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_errpfx.html#2">DB->set_errpfx</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_feedback.html#2">DB->set_feedback</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_flags.html#2">DB->set_flags</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_h_ffactor.html#2">DB->set_h_ffactor</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_h_hash.html#2">DB->set_h_hash</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_h_nelem.html#2">DB->set_h_nelem</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_lorder.html#2">DB->set_lorder</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_malloc.html#2">DB->set_malloc</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_pagesize.html#2">DB->set_pagesize</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_paniccall.html#2">DB->set_paniccall</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_q_extentsize.html#2">DB->set_q_extentsize</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_realloc.html#2">DB->set_realloc</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_re_delim.html#2">DB->set_re_delim</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_re_len.html#2">DB->set_re_len</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_re_pad.html#2">DB->set_re_pad</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_set_re_source.html#2">DB->set_re_source</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_stat.html#2">DB->stat</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_sync.html#2">DB->sync</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_upgrade.html#2">DB->upgrade</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_verify.html#2">DB->verify</a></td></tr> +<tr><td align=right>File naming</td><td><a href="../ref/env/naming.html#DB_HOME">DB_HOME</a></td></tr> +<tr><td align=right>File naming</td><td><a href="../ref/env/naming.html#db_home">db_home</a></td></tr> +<tr><td align=right> DB->close </td><td><a href="../api_c/db_close.html#3">DB_INCOMPLETE</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_INIT_LOCK">DB_INIT_LOCK</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_INIT_LOG">DB_INIT_LOG</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_INIT_MPOOL">DB_INIT_MPOOL</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_INIT_TXN">DB_INIT_TXN</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_JOINENV">DB_JOINENV</a></td></tr> +<tr><td align=right>DB->join</td><td><a href="../api_c/db_join.html#DB_JOIN_ITEM">DB_JOIN_ITEM</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_JOIN_ITEM">DB_JOIN_ITEM</a></td></tr> +<tr><td align=right>DB->join</td><td><a href="../api_c/db_join.html#DB_JOIN_NOSORT">DB_JOIN_NOSORT</a></td></tr> +<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a></td></tr> +<tr><td align=right>DBcursor->c_put</td><td><a href="../api_c/dbc_put.html#DB_KEYFIRST">DB_KEYFIRST</a></td></tr> +<tr><td align=right>DBcursor->c_put</td><td><a href="../api_c/dbc_put.html#DB_KEYLAST">DB_KEYLAST</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_LAST">DB_LAST</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_LAST">DB_LAST</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_load.html#2">db_load</a></td></tr> +<tr><td align=right>lock_detect</td><td><a href="../api_c/lock_detect.html#DB_LOCK_CONFLICT">DB_LOCK_CONFLICT</a></td></tr> +<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a></td></tr> +<tr><td align=right>DBENV->set_lk_detect</td><td><a href="../api_c/env_set_lk_detect.html#DB_LOCK_DEFAULT">DB_LOCK_DEFAULT</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_LOCKDOWN">DB_LOCKDOWN</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#DB_LOCK_GET">DB_LOCK_GET</a></td></tr> +<tr><td align=right>lock_get</td><td><a href="../api_c/lock_get.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a></td></tr> +<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a></td></tr> +<tr><td align=right>lock_get</td><td><a href="../api_c/lock_get.html#DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a></td></tr> +<tr><td align=right>DBENV->set_lk_detect</td><td><a href="../api_c/env_set_lk_detect.html#DB_LOCK_OLDEST">DB_LOCK_OLDEST</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#DB_LOCK_PUT">DB_LOCK_PUT</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#DB_LOCK_PUT_ALL">DB_LOCK_PUT_ALL</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#DB_LOCK_PUT_OBJ">DB_LOCK_PUT_OBJ</a></td></tr> +<tr><td align=right>DBENV->set_lk_detect</td><td><a href="../api_c/env_set_lk_detect.html#DB_LOCK_RANDOM">DB_LOCK_RANDOM</a></td></tr> +<tr><td align=right>DBENV->set_lk_detect</td><td><a href="../api_c/env_set_lk_detect.html#DB_LOCK_YOUNGEST">DB_LOCK_YOUNGEST</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/db_lsn.html#2">DB_LSN</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbm.html#2">dbm/ndbm</a></td></tr> +<tr><td align=right>memp_fput</td><td><a href="../api_c/memp_fput.html#DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a></td></tr> +<tr><td align=right>memp_fset</td><td><a href="../api_c/memp_fset.html#DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a></td></tr> +<tr><td align=right>memp_fget</td><td><a href="../api_c/memp_fget.html#DB_MPOOL_CREATE">DB_MPOOL_CREATE</a></td></tr> +<tr><td align=right>memp_fput</td><td><a href="../api_c/memp_fput.html#DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a></td></tr> +<tr><td align=right>memp_fset</td><td><a href="../api_c/memp_fset.html#DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a></td></tr> +<tr><td align=right>memp_fput</td><td><a href="../api_c/memp_fput.html#DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a></td></tr> +<tr><td align=right>memp_fset</td><td><a href="../api_c/memp_fset.html#DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a></td></tr> +<tr><td align=right>memp_fget</td><td><a href="../api_c/memp_fget.html#DB_MPOOL_LAST">DB_MPOOL_LAST</a></td></tr> +<tr><td align=right>memp_fget</td><td><a href="../api_c/memp_fget.html#DB_MPOOL_NEW">DB_MPOOL_NEW</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_NEXT">DB_NEXT</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_NEXT">DB_NEXT</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_NEXT_DUP">DB_NEXT_DUP</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_NEXT_NODUP">DB_NEXT_NODUP</a></td></tr> +<tr><td align=right>DB->put</td><td><a href="../api_c/db_put.html#DB_NODUPDATA">DB_NODUPDATA</a></td></tr> +<tr><td align=right>DBcursor->c_put</td><td><a href="../api_c/dbc_put.html#DB_NODUPDATA">DB_NODUPDATA</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_NOMMAP">DB_NOMMAP</a></td></tr> +<tr><td align=right>DBENV->set_flags</td><td><a href="../api_c/env_set_flags.html#DB_NOMMAP">DB_NOMMAP</a></td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#DB_NOMMAP">DB_NOMMAP</a></td></tr> +<tr><td align=right>DB->verify</td><td><a href="../api_c/db_verify.html#DB_NOORDERCHK">DB_NOORDERCHK</a></td></tr> +<tr><td align=right>DB->put</td><td><a href="../api_c/db_put.html#DB_NOOVERWRITE">DB_NOOVERWRITE</a></td></tr> +<tr><td align=right>DBENV->set_server</td><td><a href="../api_c/env_set_server.html#DB_NOSERVER">DB_NOSERVER</a></td></tr> +<tr><td align=right>DBENV->set_server</td><td><a href="../api_c/env_set_server.html#DB_NOSERVER_ID">DB_NOSERVER_ID</a></td></tr> +<tr><td align=right>DB->close</td><td><a href="../api_c/db_close.html#DB_NOSYNC">DB_NOSYNC</a></td></tr> +<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_OLD_VERSION">DB_OLD_VERSION</a></td></tr> +<tr><td align=right>DB->upgrade</td><td><a href="../api_c/db_upgrade.html#DB_OLD_VERSION">DB_OLD_VERSION</a></td></tr> +<tr><td align=right>DB->verify</td><td><a href="../api_c/db_verify.html#DB_ORDERCHKONLY">DB_ORDERCHKONLY</a></td></tr> +<tr><td align=right>DBcursor->c_dup</td><td><a href="../api_c/dbc_dup.html#DB_POSITION">DB_POSITION</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_PREV">DB_PREV</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_PREV">DB_PREV</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_PREV_NODUP">DB_PREV_NODUP</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_printlog.html#2">db_printlog</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_PRIVATE">DB_PRIVATE</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_RDONLY">DB_RDONLY</a></td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#DB_RDONLY">DB_RDONLY</a></td></tr> +<tr><td align=right>DB->set_flags</td><td><a href="../api_c/db_set_flags.html#DB_RECNUM">DB_RECNUM</a></td></tr> +<tr><td align=right>DB->stat</td><td><a href="../api_c/db_stat.html#DB_RECORDCOUNT">DB_RECORDCOUNT</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_RECOVER">DB_RECOVER</a></td></tr> +<tr><td align=right>DBENV->set_feedback</td><td><a href="../api_c/env_set_feedback.html#DB_RECOVER">DB_RECOVER</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_recover.html#2">db_recover</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_RECOVER_FATAL">DB_RECOVER_FATAL</a></td></tr> +<tr><td align=right>DB->set_flags</td><td><a href="../api_c/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a></td></tr> +<tr><td align=right>DB->set_flags</td><td><a href="../api_c/db_set_flags.html#DB_REVSPLITOFF">DB_REVSPLITOFF</a></td></tr> +<tr><td align=right>DB->get</td><td><a href="../api_c/db_get.html#DB_RMW">DB_RMW</a></td></tr> +<tr><td align=right>DB->join</td><td><a href="../api_c/db_join.html#DB_RMW">DB_RMW</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_RMW">DB_RMW</a></td></tr> +<tr><td align=right>Error returns to applications</td><td><a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a></td></tr> +<tr><td align=right>DB->verify</td><td><a href="../api_c/db_verify.html#DB_SALVAGE">DB_SALVAGE</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_SET">DB_SET</a></td></tr> +<tr><td align=right>log_get</td><td><a href="../api_c/log_get.html#DB_SET">DB_SET</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_SET_RANGE">DB_SET_RANGE</a></td></tr> +<tr><td align=right>DB->get</td><td><a href="../api_c/db_get.html#DB_SET_RECNO">DB_SET_RECNO</a></td></tr> +<tr><td align=right>DBcursor->c_get</td><td><a href="../api_c/dbc_get.html#DB_SET_RECNO">DB_SET_RECNO</a></td></tr> +<tr><td align=right>DB->set_flags</td><td><a href="../api_c/db_set_flags.html#DB_SNAPSHOT">DB_SNAPSHOT</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_stat.html#2">db_stat</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_strerror.html#2">db_strerror</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_THREAD">DB_THREAD</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a></td></tr> +<tr><td align=right>DB->open</td><td><a href="../api_c/db_open.html#DB_TRUNCATE">DB_TRUNCATE</a></td></tr> +<tr><td align=right>DBENV->set_tx_recover</td><td><a href="../api_c/env_set_tx_recover.html#DB_TXN_ABORT">DB_TXN_ABORT</a></td></tr> +<tr><td align=right>DBENV->set_tx_recover</td><td><a href="../api_c/env_set_tx_recover.html#DB_TXN_BACKWARD_ROLL">DB_TXN_BACKWARD_ROLL</a></td></tr> +<tr><td align=right>DBENV->set_tx_recover</td><td><a href="../api_c/env_set_tx_recover.html#DB_TXN_FORWARD_ROLL">DB_TXN_FORWARD_ROLL</a></td></tr> +<tr><td align=right>DBENV->set_flags</td><td><a href="../api_c/env_set_flags.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></td></tr> +<tr><td align=right>txn_begin</td><td><a href="../api_c/txn_begin.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></td></tr> +<tr><td align=right>txn_commit</td><td><a href="../api_c/txn_commit.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></td></tr> +<tr><td align=right>txn_begin</td><td><a href="../api_c/txn_begin.html#DB_TXN_NOWAIT">DB_TXN_NOWAIT</a></td></tr> +<tr><td align=right>txn_begin</td><td><a href="../api_c/txn_begin.html#DB_TXN_SYNC">DB_TXN_SYNC</a></td></tr> +<tr><td align=right>txn_commit</td><td><a href="../api_c/txn_commit.html#DB_TXN_SYNC">DB_TXN_SYNC</a></td></tr> +<tr><td align=right>DB->set_feedback</td><td><a href="../api_c/db_set_feedback.html#DB_UPGRADE">DB_UPGRADE</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_upgrade.html#2">db_upgrade</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a></td></tr> +<tr><td align=right>DBENV->remove</td><td><a href="../api_c/env_remove.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a></td></tr> +<tr><td align=right>DBENV->open</td><td><a href="../api_c/env_open.html#DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a></td></tr> +<tr><td align=right>DBENV->remove</td><td><a href="../api_c/env_remove.html#DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a></td></tr> +<tr><td align=right>DBENV->set_verbose</td><td><a href="../api_c/env_set_verbose.html#DB_VERB_CHKPOINT">DB_VERB_CHKPOINT</a></td></tr> +<tr><td align=right>DBENV->set_verbose</td><td><a href="../api_c/env_set_verbose.html#DB_VERB_DEADLOCK">DB_VERB_DEADLOCK</a></td></tr> +<tr><td align=right>DBENV->set_verbose</td><td><a href="../api_c/env_set_verbose.html#DB_VERB_RECOVERY">DB_VERB_RECOVERY</a></td></tr> +<tr><td align=right>DBENV->set_verbose</td><td><a href="../api_c/env_set_verbose.html#DB_VERB_WAITSFOR">DB_VERB_WAITSFOR</a></td></tr> +<tr><td align=right>DB->set_feedback</td><td><a href="../api_c/db_set_feedback.html#DB_VERIFY">DB_VERIFY</a></td></tr> +<tr><td align=right> </td><td><a href="../utility/db_verify.html#2">db_verify</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/env_version.html#2">db_version</a></td></tr> +<tr><td align=right>DB->cursor</td><td><a href="../api_c/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a></td></tr> +<tr><td align=right>db_create</td><td><a href="../api_c/db_create.html#DB_XA_CREATE">DB_XA_CREATE</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/lock/dead.html#2">deadlocks</a></td></tr> +<tr><td align=right> utility to detect </td><td><a href="../utility/db_deadlock.html#3">deadlocks</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/debug/common.html#2">debugging</a> applications</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/delete.html#2">deleting</a> records</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/curdel.html#2">deleting</a> records with a cursor</td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--disable-bigfile">--disable-bigfile</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/program/diskspace.html#2">disk</a> space requirements</td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#dlen">dlen</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#doff">doff</a></td></tr> +<tr><td align=right> utility to </td><td><a href="../utility/db_dump.html#3">dump</a> databases as text files</td></tr> +<tr><td align=right> </td><td><a href="../ref/am_conf/dup.html#2">duplicate</a> data items</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/curdup.html#2">duplicating</a> a cursor</td></tr> +<tr><td align=right> configuring </td><td><a href="../ref/build_unix/conf.html#9">dynamic</a> shared libraries</td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-compat185">--enable-compat185</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-cxx">--enable-cxx</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-debug">--enable-debug</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-debug_rop">--enable-debug_rop</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-debug_wop">--enable-debug_wop</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-diagnostic">--enable-diagnostic</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-dump185">--enable-dump185</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-dynamic">--enable-dynamic</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-java">--enable-java</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-posixmutexes">--enable-posixmutexes</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-rpc">--enable-rpc</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-shared">--enable-shared</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-tcl">--enable-tcl</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-test">--enable-test</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-uimutexes">--enable-uimutexes</a></td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--enable-umrw">--enable-umrw</a></td></tr> +<tr><td align=right> byte </td><td><a href="../ref/program/byteorder.html#3">endian</a></td></tr> +<tr><td align=right> database </td><td><a href="../ref/env/create.html#2">environment</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/program/environ.html#2">environment</a> variables</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/error.html#2">error</a> handling</td></tr> +<tr><td align=right> </td><td><a href="../ref/program/errorret.html#3">error</a> name space</td></tr> +<tr><td align=right> </td><td><a href="../ref/program/errorret.html#2">error</a> returns</td></tr> +<tr><td align=right> </td><td><a href="../ref/install/file.html#2">/etc/magic</a></td></tr> +<tr><td align=right> selecting a Queue </td><td><a href="../ref/am_conf/extentsize.html#2">extent</a> size</td></tr> +<tr><td align=right> Java </td><td><a href="../ref/java/faq.html#2">FAQ</a></td></tr> +<tr><td align=right> Tcl </td><td><a href="../ref/tcl/faq.html#2">FAQ</a></td></tr> +<tr><td align=right> configuring without large </td><td><a href="../ref/build_unix/conf.html#4">file</a> support</td></tr> +<tr><td align=right> </td><td><a href="../ref/install/file.html#3">file</a> utility</td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#fileid">fileid</a></td></tr> +<tr><td align=right> recovery and </td><td><a href="../ref/transapp/filesys.html#2">filesystem</a> operations</td></tr> +<tr><td align=right> remote </td><td><a href="../ref/env/remote.html#2">filesystems</a></td></tr> +<tr><td align=right> page </td><td><a href="../ref/am_conf/h_ffactor.html#2">fill</a> factor</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/freebsd.html#2">FreeBSD</a></td></tr> +<tr><td align=right> Berkeley DB </td><td><a href="../ref/program/scope.html#3">free-threaded</a> handles</td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#ftype">ftype</a></td></tr> +<tr><td align=right> specifying a database </td><td><a href="../ref/am_conf/h_hash.html#2">hash</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/am_conf/h_nelem.html#2">hash</a> table size</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/hpux.html#2">HP-UX</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/hsearch.html#2">hsearch</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/install.html#2">installing</a> Berkeley DB for UNIX systems</td></tr> +<tr><td align=right> </td><td><a href="../ref/program/compatible.html#2">interface</a> compatibility</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/irix.html#2">IRIX</a></td></tr> +<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#10">Java</a> API</td></tr> +<tr><td align=right> </td><td><a href="../ref/java/compat.html#2">Java</a> compatibility</td></tr> +<tr><td align=right> </td><td><a href="../ref/java/conf.html#2">Java</a> configuration</td></tr> +<tr><td align=right> </td><td><a href="../ref/java/faq.html#3">Java</a> FAQ</td></tr> +<tr><td align=right> logical </td><td><a href="../ref/am/join.html#2">join</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/dbt.html#2">key/data</a> pairs</td></tr> +<tr><td align=right> retrieved </td><td><a href="../api_c/dbt.html#4">key/data</a> permanence</td></tr> +<tr><td align=right> database </td><td><a href="../ref/program/dbsizes.html#2">limits</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/linux.html#2">Linux</a></td></tr> +<tr><td align=right> changing compile or </td><td><a href="../ref/build_unix/flags.html#3">load</a> options</td></tr> +<tr><td align=right> utility to </td><td><a href="../utility/db_load.html#3">load</a> text files into databases</td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#lock">lock</a></td></tr> +<tr><td align=right> standard </td><td><a href="../ref/lock/stdmode.html#2">lock</a> modes</td></tr> +<tr><td align=right> </td><td><a href="../api_c/lock_detect.html#2">lock_detect</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/lock_get.html#2">lock_get</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/lock_id.html#2">lock_id</a></td></tr> +<tr><td align=right> page-level </td><td><a href="../ref/lock/page.html#2">locking</a></td></tr> +<tr><td align=right> two-phase </td><td><a href="../ref/lock/twopl.html#2">locking</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/lock/nondb.html#2">locking</a> and non-Berkeley DB applications</td></tr> +<tr><td align=right> </td><td><a href="../ref/lock/config.html#2">locking</a> configuration</td></tr> +<tr><td align=right> </td><td><a href="../ref/lock/am_conv.html#2">locking</a> conventions</td></tr> +<tr><td align=right> Berkeley DB Concurrent Data Store </td><td><a href="../ref/lock/cam_conv.html#2">locking</a> conventions</td></tr> +<tr><td align=right> </td><td><a href="../ref/lock/intro.html#2">locking</a> introduction</td></tr> +<tr><td align=right> sizing the </td><td><a href="../ref/lock/max.html#2">locking</a> subsystem</td></tr> +<tr><td align=right> </td><td><a href="../ref/lock/notxn.html#2">locking</a> without transactions</td></tr> +<tr><td align=right> </td><td><a href="../api_c/lock_put.html#2">lock_put</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/lock_stat.html#2">lock_stat</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/lock_vec.html#2">lock_vec</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/log/limits.html#2">log</a> file limits</td></tr> +<tr><td align=right> </td><td><a href="../ref/transapp/logfile.html#2">log</a> file removal</td></tr> +<tr><td align=right> utility to display </td><td><a href="../utility/db_printlog.html#3">log</a> files as text</td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_archive.html#2">log_archive</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_compare.html#2">log_compare</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_file.html#2">log_file</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_flush.html#2">log_flush</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_get.html#2">log_get</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/log/config.html#2">logging</a> configuration</td></tr> +<tr><td align=right> </td><td><a href="../ref/log/intro.html#2">logging</a> introduction</td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_put.html#2">log_put</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_register.html#2">log_register</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_stat.html#2">log_stat</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/log_unregister.html#2">log_unregister</a></td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#lsn_offset">lsn_offset</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/mp/config.html#2">memory</a> pool configuration</td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_fclose.html#2">memp_fclose</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_fget.html#2">memp_fget</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_fopen.html#2">memp_fopen</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_fput.html#2">memp_fput</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_fset.html#2">memp_fset</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_fsync.html#2">memp_fsync</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_register.html#2">memp_register</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_stat.html#2">memp_stat</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_sync.html#2">memp_sync</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/memp_trickle.html#2">memp_trickle</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#mode">mode</a></td></tr> +<tr><td align=right> Berkeley DB library </td><td><a href="../ref/program/namespace.html#2">name</a> spaces</td></tr> +<tr><td align=right> file </td><td><a href="../ref/env/naming.html#2">naming</a></td></tr> +<tr><td align=right> retrieving Btree records by </td><td><a href="../ref/am_conf/bt_recnum.html#2">number</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#obj">obj</a></td></tr> +<tr><td align=right>lock_vec</td><td><a href="../api_c/lock_vec.html#op">op</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/am/open.html#2">opening</a> a database</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/osf1.html#2">OSF/1</a></td></tr> +<tr><td align=right> selecting a </td><td><a href="../ref/am_conf/pagesize.html#2">page</a> size</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/partial.html#2">partial</a> record storage and retrieval</td></tr> +<tr><td align=right></td><td><a href="http://www.sleepycat.com/update/index.html">Patches,</a> Updates and Change logs</td></tr> +<tr><td align=right> </td><td><a href="../ref/perl/intro.html#2">Perl</a></td></tr> +<tr><td align=right> retrieved key/data </td><td><a href="../api_c/dbt.html#3">permanence</a></td></tr> +<tr><td align=right>memp_fopen</td><td><a href="../api_c/memp_fopen.html#pgcookie">pgcookie</a></td></tr> +<tr><td align=right> Sleepycat Software's Berkeley DB </td><td><a href="../ref/intro/products.html#2">products</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/qnx.html#2">QNX</a></td></tr> +<tr><td align=right> logical </td><td><a href="../api_c/dbt.html#6">record</a> number format</td></tr> +<tr><td align=right> logical </td><td><a href="../ref/am_conf/logrec.html#2">record</a> numbers</td></tr> +<tr><td align=right> managing </td><td><a href="../ref/am_conf/recno.html#2">record-based</a> databases</td></tr> +<tr><td align=right> logically renumbering </td><td><a href="../ref/am_conf/renumber.html#2">records</a></td></tr> +<tr><td align=right> utility to </td><td><a href="../utility/db_recover.html#3">recover</a> database environments</td></tr> +<tr><td align=right> Berkeley DB </td><td><a href="../ref/transapp/reclimit.html#2">recoverability</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/am/get.html#2">retrieving</a> records</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/curget.html#2">retrieving</a> records with a cursor</td></tr> +<tr><td align=right> </td><td><a href="../ref/rpc/client.html#2">RPC</a> client</td></tr> +<tr><td align=right> configuring a </td><td><a href="../ref/build_unix/conf.html#11">RPC</a> client/server</td></tr> +<tr><td align=right> utility to support </td><td><a href="../utility/berkeley_db_svc.html#3">RPC</a> client/server</td></tr> +<tr><td align=right> </td><td><a href="../ref/rpc/server.html#2">RPC</a> server</td></tr> +<tr><td align=right> database </td><td><a href="../ref/am/verify.html#3">salvage</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/sco.html#2">SCO</a></td></tr> +<tr><td align=right> Berkeley DB handle </td><td><a href="../ref/program/scope.html#2">scope</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/env/security.html#2">security</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/sendmail/intro.html#2">Sendmail</a></td></tr> +<tr><td align=right> configuring </td><td><a href="../ref/build_unix/conf.html#8">shared</a> libraries</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/shlib.html#2">shared</a> libraries</td></tr> +<tr><td align=right> application </td><td><a href="../ref/program/appsignals.html#2">signal</a> handling</td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#size">size</a></td></tr> +<tr><td align=right></td><td><a href="http://www.sleepycat.com/">Sleepycat</a> Software</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/solaris.html#2">Solaris</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/distrib/layout.html#2">source</a> code layout</td></tr> +<tr><td align=right> cursor </td><td><a href="../ref/am/stability.html#3">stability</a></td></tr> +<tr><td align=right> database </td><td><a href="../ref/am/stat.html#2">statistics</a></td></tr> +<tr><td align=right> utility to display database and environment </td><td><a href="../utility/db_stat.html#3">statistics</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/am/put.html#2">storing</a> records</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/curput.html#2">storing</a> records with a cursor</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/sunos.html#2">SunOS</a></td></tr> +<tr><td align=right> loading Berkeley DB with </td><td><a href="../ref/tcl/intro.html#2">Tcl</a></td></tr> +<tr><td align=right> using Berkeley DB with </td><td><a href="../ref/tcl/using.html#2">Tcl</a></td></tr> +<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#12">Tcl</a> API</td></tr> +<tr><td align=right> </td><td><a href="../ref/tcl/program.html#2">Tcl</a> API programming notes</td></tr> +<tr><td align=right> </td><td><a href="../ref/tcl/faq.html#3">Tcl</a> FAQ</td></tr> +<tr><td align=right> configuring the </td><td><a href="../ref/build_unix/conf.html#13">test</a> suite</td></tr> +<tr><td align=right> running the </td><td><a href="../ref/test/run.html#2">test</a> suite</td></tr> +<tr><td align=right> running the </td><td><a href="../ref/build_unix/test.html#2">test</a> suite under UNIX</td></tr> +<tr><td align=right> running the </td><td><a href="../ref/build_win/test.html#2">test</a> suite under Windows</td></tr> +<tr><td align=right> </td><td><a href="../ref/am_conf/re_source.html#2">text</a> backing files</td></tr> +<tr><td align=right> loading </td><td><a href="../ref/dumpload/text.html#2">text</a> into databases</td></tr> +<tr><td align=right> dumping/loading </td><td><a href="../ref/dumpload/utility.html#2">text</a> to/from databases</td></tr> +<tr><td align=right> building </td><td><a href="../ref/program/mt.html#2">threaded</a> applications</td></tr> +<tr><td align=right> </td><td><a href="../ref/txn/config.html#2">transaction</a> configuration</td></tr> +<tr><td align=right> </td><td><a href="../ref/txn/limits.html#2">transaction</a> limits</td></tr> +<tr><td align=right> administering </td><td><a href="../ref/transapp/admin.html#2">transaction</a> protected applications</td></tr> +<tr><td align=right> archival in </td><td><a href="../ref/transapp/archival.html#2">transaction</a> protected applications</td></tr> +<tr><td align=right> checkpoints in </td><td><a href="../ref/transapp/checkpoint.html#2">transaction</a> protected applications</td></tr> +<tr><td align=right> deadlock detection in </td><td><a href="../ref/transapp/deadlock.html#2">transaction</a> protected applications</td></tr> +<tr><td align=right> recovery in </td><td><a href="../ref/transapp/recovery.html#2">transaction</a> protected applications</td></tr> +<tr><td align=right> </td><td><a href="../ref/transapp/throughput.html#2">transaction</a> throughput</td></tr> +<tr><td align=right> </td><td><a href="../ref/transapp/intro.html#2">Transactional</a> Data Store</td></tr> +<tr><td align=right> Berkeley DB and </td><td><a href="../ref/txn/intro.html#2">transactions</a></td></tr> +<tr><td align=right> nested </td><td><a href="../ref/txn/nested.html#2">transactions</a></td></tr> +<tr><td align=right> configuring Berkeley DB with the </td><td><a href="../ref/xa/config.html#2">Tuxedo</a> System</td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_abort.html#2">txn_abort</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_begin.html#2">txn_begin</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_checkpoint.html#2">txn_checkpoint</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_commit.html#2">txn_commit</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_id.html#2">txn_id</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_prepare.html#2">txn_prepare</a></td></tr> +<tr><td align=right> </td><td><a href="../api_c/txn_stat.html#2">txn_stat</a></td></tr> +<tr><td align=right>DBT</td><td><a href="../api_c/dbt.html#ulen">ulen</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/build_unix/ultrix.html#2">Ultrix</a></td></tr> +<tr><td align=right> building for </td><td><a href="../ref/build_unix/notes.html#3">UNIX</a> FAQ</td></tr> +<tr><td align=right> configuring Berkeley DB for </td><td><a href="../ref/build_unix/conf.html#3">UNIX</a> systems</td></tr> +<tr><td align=right>Patches, </td><td><a href="http://www.sleepycat.com/update/index.html">Updates</a> and Change logs</td></tr> +<tr><td align=right> utility to </td><td><a href="../utility/db_upgrade.html#4">upgrade</a> database files</td></tr> +<tr><td align=right> </td><td><a href="../ref/am/upgrade.html#2">upgrading</a> databases</td></tr> +<tr><td align=right> </td><td><a href="../ref/arch/utilities.html#2">utilities</a></td></tr> +<tr><td align=right> database </td><td><a href="../ref/am/verify.html#2">verification</a></td></tr> +<tr><td align=right> utility to </td><td><a href="../utility/db_verify.html#4">verify</a> database files</td></tr> +<tr><td align=right> building for </td><td><a href="../ref/build_vxworks/faq.html#3">VxWorks</a> FAQ</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_vxworks/notes.html#2">VxWorks</a> notes</td></tr> +<tr><td align=right> running the test suite under </td><td><a href="../ref/build_win/test.html#3">Windows</a></td></tr> +<tr><td align=right> building for </td><td><a href="../ref/build_win/faq.html#3">Windows</a> FAQ</td></tr> +<tr><td align=right> </td><td><a href="../ref/build_win/notes.html#2">Windows</a> notes</td></tr> +<tr><td align=right>Configuring Berkeley DB</td><td><a href="../ref/build_unix/conf.html#--with-tcl=DIR">--with-tcl=DIR</a></td></tr> +<tr><td align=right> </td><td><a href="../ref/xa/intro.html#2">XA</a> Resource Manager</td></tr> +</table> +</center> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_close.html b/bdb/docs/api_c/db_close.html new file mode 100644 index 00000000000..f6c763c5b12 --- /dev/null +++ b/bdb/docs/api_c/db_close.html @@ -0,0 +1,119 @@ +<!--$Id: db_close.so,v 10.27 2000/09/08 15:20:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->close</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->close</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->close(DB *db, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->close function flushes any cached database information to disk, +closes any open cursors, frees any allocated resources, and closes any +underlying files. Since key/data pairs are cached in memory, failing to +sync the file with the DB->close or <a href="../api_c/db_sync.html">DB->sync</a> function may result +in inconsistent or lost information. +<p>The <b>flags</b> parameter must be set to 0 or the following value: +<p><dl compact> +<p><dt><a name="DB_NOSYNC">DB_NOSYNC</a><dd>Do not flush cached information to disk. +<p>The <a href="../api_c/db_close.html#DB_NOSYNC">DB_NOSYNC</a> flag is a dangerous option. It should only be set +if the application is doing logging (with transactions) so that the +database is recoverable after a system or application crash, or if the +database is always generated from scratch after any system or application +crash. +<p><b>It is important to understand that flushing cached information to disk +only minimizes the window of opportunity for corrupted data.</b> +While unlikely, it is possible for database corruption to happen if a +system or application crash occurs while writing data to the database. +To ensure that database corruption never occurs, applications must either: +use transactions and logging with automatic recovery, use logging and +application-specific recovery, or edit a copy of the database, +and, once all applications using the database have successfully called +DB->close, atomically replace the original database with the +updated copy. +</dl> +<p>When multiple threads are using the Berkeley DB handle concurrently, only a single +thread may call the DB->close function. +<p>Once DB->close has been called, regardless of its return, the +DB handle may not be accessed again. + <a name="3"><!--meow--></a> +<p>The DB->close function returns a non-zero error value on failure, 0 on success, and returns <a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> if the underlying database still has +dirty pages in the cache. (The only reason to return +<a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> is if another thread of control was writing pages +in the underlying database file at the same time as the +DB->close function was called. For this reason, a return of +<a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> can normally be ignored, or, in cases where it is +a possible return value, the <a href="../api_c/db_close.html#DB_NOSYNC">DB_NOSYNC</a> option should probably +have been specified.) +<p>The DB->close function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->close function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->close function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_create.html b/bdb/docs/api_c/db_create.html new file mode 100644 index 00000000000..c1fd3fca10b --- /dev/null +++ b/bdb/docs/api_c/db_create.html @@ -0,0 +1,107 @@ +<!--$Id: db_create.so,v 10.12 2000/10/25 18:51:08 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_create</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_create</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_create(DB **dbp, DB_ENV *dbenv, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The db_create function creates a DB structure which is the +handle for a Berkeley DB database. A pointer to this structure is returned +in the memory referenced by <b>db</b>. +<p>If the <b>dbenv</b> argument is NULL, the database is standalone, i.e., +it is not part of any Berkeley DB environment. +<p>If the <b>dbenv</b> argument is not NULL, the database is created within +the specified Berkeley DB environment. The database access methods +automatically make calls to the other subsystems in Berkeley DB based on the +enclosing environment. For example, if the environment has been +configured to use locking, then the access methods will automatically +acquire the correct locks when reading and writing pages of the database. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_XA_CREATE">DB_XA_CREATE</a><dd>Instead of creating a standalone database, create a database intended to +be accessed via applications running under a X/Open conformant Transaction +Manager. The database will be opened in the environment specified by the +OPENINFO parameter of the GROUPS section of the ubbconfig file. See the +<a href="../ref/xa/intro.html">XA Resource Manager</a> chapter in the +Reference Guide for more information. +</dl> +<p>The DB handle contains a special field, "app_private", which +is declared as type "void *". This field is provided for the use of +the application program. It is initialized to NULL and is not further +used by Berkeley DB in any way. +<p>The db_create function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The db_create function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the db_create function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_cursor.html b/bdb/docs/api_c/db_cursor.html new file mode 100644 index 00000000000..1fb6616ab63 --- /dev/null +++ b/bdb/docs/api_c/db_cursor.html @@ -0,0 +1,103 @@ +<!--$Id: db_cursor.so,v 10.25 2000/07/11 19:11:25 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->cursor</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->cursor</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->cursor(DB *db, + DB_TXN *txnid, DBC **cursorp, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->cursor function +creates a cursor and copies a pointer to it into the memory referenced +by <b>cursorp</b>. +<p>If the file is being accessed under transaction protection, the +<b>txnid</b> parameter is a transaction ID returned from +<a href="../api_c/txn_begin.html">txn_begin</a>, otherwise, NULL. +<p>If transaction protection is enabled, cursors must be opened and closed +within the context of a transaction, and the <b>txnid</b> parameter +specifies the transaction context in which the cursor may be used. +<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_WRITECURSOR">DB_WRITECURSOR</a><dd>Specify that the cursor will be used to update the database. This +flag should <b>only</b> be set when the <a href="../api_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag +was specified to <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<p>The DB->cursor function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->cursor function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The DB->cursor function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->cursor function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_del.html b/bdb/docs/api_c/db_del.html new file mode 100644 index 00000000000..b273d29fd14 --- /dev/null +++ b/bdb/docs/api_c/db_del.html @@ -0,0 +1,101 @@ +<!--$Id: db_del.so,v 10.23 2000/09/05 19:35:10 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->del</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->del</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->del(DB *db, DB_TXN *txnid, DBT *key, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->del function removes key/data pairs from the database. The +key/data pair associated with the specified <b>key</b> is discarded from +the database. In the presence of duplicate key values, all records +associated with the designated key will be discarded. +<p>If the file is being accessed under transaction protection, the +<b>txnid</b> parameter is a transaction ID returned from +<a href="../api_c/txn_begin.html">txn_begin</a>, otherwise, NULL. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>The DB->del function returns a non-zero error value on failure, 0 on success, and <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a> if the specified <b>key</b> did not exist in +the file. +<h1>Errors</h1> +<p>The DB->del function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EACCES<dd>An attempt was made to modify a read-only database. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The DB->del function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->del function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_err.html b/bdb/docs/api_c/db_err.html new file mode 100644 index 00000000000..1eae12fabf0 --- /dev/null +++ b/bdb/docs/api_c/db_err.html @@ -0,0 +1,93 @@ +<!--$Id: db_err.so,v 10.11 1999/12/20 08:52:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->err</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->err</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DBENV->err(DB_ENV *dbenv, int error, const char *fmt, ...); +<p> +void +DBENV->errx(DB_ENV *dbenv, const char *fmt, ...); +<p> +void +DB->err(DB *db, int error, const char *fmt, ...); +<p> +void +DB->errx(DB *db, const char *fmt, ...); +</pre></h3> +<h1>Description</h1> +<p>The DBENV->err, DBENV->errx, DB->err and +DB->errx functions provide error messaging functionality for +applications written using the Berkeley DB library. +<p>The DBENV->err function constructs an error message consisting of the +following elements: +<p><blockquote><p><dl compact> +<p><dt>An optional prefix string<dd>If no error callback function has been set using the +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a> function, any prefix string specified using the +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a> function, followed by two separating characters: a colon +and a <space> character. +<p><dt>An optional printf-style message<dd>The supplied message <b>fmt</b>, if non-NULL, where the ANSI C X3.159-1989 (ANSI C) +printf function specifies how subsequent arguments are converted for +output. +<p><dt>A separator<dd>Two separating characters: a colon and a <space> character. +<p><dt>A standard error string<dd>The standard system or Berkeley DB library error string associated with the +<b>error</b> value, as returned by the <a href="../api_c/env_strerror.html">db_strerror</a> function. +</dl> +</blockquote> +<p>This constructed error message is then handled as follows: +<p><blockquote> +<p>If an error callback function has been set (see <a href="../api_c/db_set_errcall.html">DB->set_errcall</a> +and <a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>), that function is called with two +arguments: any prefix string specified (see <a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> and +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>), and the error message. +<p>If a C library FILE * has been set (see <a href="../api_c/db_set_errfile.html">DB->set_errfile</a> and +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>), the error message is written to that output +stream. +<p>If none of these output options has been configured, the error message +is written to stderr, the standard error output stream.</blockquote> +<p>The DBENV->errx and DB->errx functions perform identically to the +DBENV->err and DB->err functions except that they do not append +the final separator characters and standard error string to the error +message. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_fd.html b/bdb/docs/api_c/db_fd.html new file mode 100644 index 00000000000..2a385c1b3d1 --- /dev/null +++ b/bdb/docs/api_c/db_fd.html @@ -0,0 +1,92 @@ +<!--$Id: db_fd.so,v 10.21 2000/03/01 21:41:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->fd</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->fd</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->fd(DB *db, int *fdp); +</pre></h3> +<h1>Description</h1> +<p>The DB->fd function +copies a file descriptor representative of the underlying database into +the memory referenced by <b>fdp</b>. A file descriptor referencing the +same file will be returned to all processes that call <a href="../api_c/db_open.html">DB->open</a> with +the same <b>file</b> argument. This file descriptor may be safely used +as an argument to the <b>fcntl</b>(2) and <b>flock</b>(2) locking +functions. The file descriptor is not necessarily associated with any of +the underlying files actually used by the access method. +<p>The DB->fd function only supports a coarse-grained form of locking. +Applications should use the lock manager where possible. +<p>The DB->fd function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->fd function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->fd function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_get.html b/bdb/docs/api_c/db_get.html new file mode 100644 index 00000000000..c6cc3fcce43 --- /dev/null +++ b/bdb/docs/api_c/db_get.html @@ -0,0 +1,156 @@ +<!--$Id: db_get.so,v 10.31 2000/11/28 20:12:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->get</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->get</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->get(DB *db, + DB_TXN *txnid, DBT *key, DBT *data, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->get function retrieves key/data pairs from the database. The +address +and length of the data associated with the specified <b>key</b> are +returned in the structure referenced by <b>data</b>. +<p>In the presence of duplicate key values, DB->get will return the +first data item for the designated key. Duplicates are sorted by insert +order except where this order has been overridden by cursor operations. +<b>Retrieval of duplicates requires the use of cursor operations.</b> +See <a href="../api_c/dbc_get.html">DBcursor->c_get</a> for details. +<p>If the file is being accessed under transaction protection, the +<b>txnid</b> parameter is a transaction ID returned from +<a href="../api_c/txn_begin.html">txn_begin</a>, otherwise, NULL. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_CONSUME">DB_CONSUME</a><dd>Return the record number and data from the available record closest to +the head of the queue and delete the record. The cursor will be +positioned on the deleted record. The record number will be returned +in <b>key</b> as described in <a href="../api_c/dbt.html">DBT</a>. The data will be returned +in the <b>data</b> parameter. A record is available if it is not +deleted and is not currently locked. The underlying database must be +of type Queue for DB_CONSUME to be specified. +<p><dt><a name="DB_CONSUME_WAIT">DB_CONSUME_WAIT</a><dd>The DB_CONSUME_WAIT flag is the same as the DB_CONSUME +flag except that if the Queue database is empty, the thread of control +will wait until there is data in the queue before returning. The +underlying database must be of type Queue for DB_CONSUME_WAIT +to be specified. +<p><dt><a name="DB_GET_BOTH">DB_GET_BOTH</a><dd>Retrieve the key/data pair only if both the key and data match the +arguments. +<p><dt><a name="DB_SET_RECNO">DB_SET_RECNO</a><dd>Retrieve the specified numbered key/data pair from a database. +Upon return, both the <b>key</b> and <b>data</b> items will have been +filled in, not just the data item as is done for all other uses of the +DB->get function. +<p>The <b>data</b> field of the specified <b>key</b> +must be a pointer to a logical record number (i.e., a <b>db_recno_t</b>). +This record number determines the record to be retrieved. +<p>For DB_SET_RECNO to be specified, the underlying database must be +of type Btree and it must have been created with the DB_RECNUM flag. +</dl> +<p>In addition, the following flag may be set by bitwise inclusively <b>OR</b>'ing it into the +<b>flags</b> parameter: +<p><dl compact> +<p><dt><a name="DB_RMW">DB_RMW</a><dd>Acquire write locks instead of read locks when doing the retrieval. +Setting this flag may decrease the likelihood of deadlock during a +read-modify-write cycle by immediately acquiring the write lock during +the read part of the cycle so that another thread of control acquiring +a read lock for the same item, in its own read-modify-write cycle, will +not result in deadlock. +<p>As the DB->get interface will not hold locks across +Berkeley DB interface calls in non-transactional environments, the +<a href="../api_c/dbc_get.html#DB_RMW">DB_RMW</a> flag to the DB->get call is only meaningful in +the presence of transactions. +</dl> +<p>If the database is a Queue or Recno database and the requested key exists, +but was never explicitly created by the application or was later deleted, +the DB->get function returns <a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. +<p>Otherwise, if the requested key is not in the database, the +DB->get function returns <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p>Otherwise, the DB->get function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->get function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>There was insufficient memory to return the requested item. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>A record number of 0 was specified. +<p>The <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified to the +<a href="../api_c/db_open.html">DB->open</a> function and none of the <a href="../api_c/dbt.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, +<a href="../api_c/dbt.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> or <a href="../api_c/dbt.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags were set in the +<a href="../api_c/dbt.html">DBT</a>. +</dl> +<p>The DB->get function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->get function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_get_byteswapped.html b/bdb/docs/api_c/db_get_byteswapped.html new file mode 100644 index 00000000000..205ddb79467 --- /dev/null +++ b/bdb/docs/api_c/db_get_byteswapped.html @@ -0,0 +1,84 @@ +<!--$Id: db_get_byteswapped.so,v 10.7 1999/12/20 08:52:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->get_byteswapped</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->get_byteswapped</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->get_byteswapped(DB *db); +</pre></h3> +<h1>Description</h1> +<p>The DB->get_byteswapped function returns +0 +if the underlying database files were created on an architecture +of the same byte order as the current one, and +1 +if they were not (i.e., big-endian on a little-endian machine or +vice-versa). This field may be used to determine if application +data needs to be adjusted for this architecture or not. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_get_type.html b/bdb/docs/api_c/db_get_type.html new file mode 100644 index 00000000000..a1905c782e4 --- /dev/null +++ b/bdb/docs/api_c/db_get_type.html @@ -0,0 +1,81 @@ +<!--$Id: db_get_type.so,v 10.10 1999/12/20 08:52:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->get_type</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->get_type</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +DBTYPE +DB->get_type(DB *db); +</pre></h3> +<h1>Description</h1> +<p>The DB->get_type function returns the type of the underlying access method +(and file format). It returns one of DB_BTREE, +DB_HASH or DB_RECNO. This value may be used to +determine the type of the database after a return from <a href="../api_c/db_open.html">DB->open</a> +with the <b>type</b> argument set to DB_UNKNOWN. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_join.html b/bdb/docs/api_c/db_join.html new file mode 100644 index 00000000000..13fe95d84d7 --- /dev/null +++ b/bdb/docs/api_c/db_join.html @@ -0,0 +1,151 @@ +<!--$Id: db_join.so,v 10.30 2000/12/20 15:34:50 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->join</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->join</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->join(DB *primary, + DBC **curslist, DBC **dbcp, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->join function creates a specialized cursor for use in performing +joins on secondary indexes. For information on how to organize your data +to use this functionality, see <a href="../ref/am/join.html">Logical +join</a>. +<p>The <b>primary</b> argument contains the DB handle of the primary +database, which is keyed by the data values found in entries in the +<b>curslist</b>. +<p>The <b>curslist</b> argument contains a NULL terminated array of cursors. +Each cursor must have been initialized to reference the key on which the +underlying database should be joined. Typically, this initialization is done +by a <a href="../api_c/dbc_get.html">DBcursor->c_get</a> call with the <a href="../api_c/dbc_get.html#DB_SET">DB_SET</a> flag specified. Once the +cursors have been passed as part of a <b>curslist</b>, they should not +be accessed or modified until the newly created join cursor has been closed, +or else inconsistent results may be returned. +<p>Joined values are retrieved by doing a sequential iteration over the first +cursor in the <b>curslist</b> argument, and a nested iteration over each +secondary cursor in the order they are specified in the <b>curslist</b> +argument. This requires database traversals to search for the current +datum in all the cursors after the first. For this reason, the best join +performance normally results from sorting the cursors from the one that +references the least number of data items to the one that references the +most. By default, DB->join does this sort on behalf of its caller. +<p>The <b>flags</b> parameter must be set to 0 or the following value: +<p><dl compact> +<p><dt><a name="DB_JOIN_NOSORT">DB_JOIN_NOSORT</a><dd>Do not sort the cursors based on the number of data items they reference. +If the data are structured such that cursors with many data items also +share many common elements, higher performance will result from listing +those cursors before cursors with fewer data items, that is, a sort order +other than the default. The DB_JOIN_NOSORT flag permits +applications to perform join optimization prior to calling DB->join. +</dl> +<p>A newly created cursor is returned in the memory location referenced by +<b>dbcp</b> and has the standard cursor functions: +<p><dl compact> +<p><dt><a href="../api_c/dbc_get.html">DBcursor->c_get</a><dd>Iterates over the values associated with the keys to which each item in +<b>curslist</b> has been initialized. Any data value which appears in +all items specified by the <b>curslist</b> argument is then used as a +key into the <b>primary</b>, and the key/data pair found in the +<b>primary</b> is returned. +<p>The <b>flags</b> parameter must be set to 0 or the following value: +<p><dl compact> +<p><dt><a name="DB_JOIN_ITEM">DB_JOIN_ITEM</a><dd>Do not use the data value found in all of the cursors as a lookup +key for the <b>primary</b>, but simply return it in the key parameter +instead. The data parameter is left unchanged. +</dl> +<p>In addition, the following flag may be set by bitwise inclusively <b>OR</b>'ing it into the +<b>flags</b> parameter: +<p><dl compact> +<p><dt><a name="DB_RMW">DB_RMW</a><dd>Acquire write locks instead of read locks when doing the retrieval. +Setting this flag may decrease the likelihood of deadlock during a +read-modify-write cycle by immediately acquiring the write lock during +the read part of the cycle so that another thread of control acquiring +a read lock for the same item, in its own read-modify-write cycle, will +not result in deadlock. +</dl> +<p><dt><a href="../api_c/dbc_put.html">DBcursor->c_put</a><dd>Returns EINVAL. +<p><dt><a href="../api_c/dbc_del.html">DBcursor->c_del</a><dd>Returns EINVAL. +<p><dt><a href="../api_c/dbc_close.html">DBcursor->c_close</a><dd>Close the returned cursor and release all resources. (Closing the cursors +in <b>curslist</b> is the responsibility of the caller.) +</dl> +<p>For the returned join cursor to be used in a transaction protected manner, +the cursors listed in <b>curslist</b> must have been created within the +context of the same transaction. +<p>The DB->join function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->join function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The <a href="../api_c/dbc_put.html">DBcursor->c_put</a> or <a href="../api_c/dbc_del.html">DBcursor->c_del</a> functions were called. +</dl> +<p>The DB->join function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->join function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_key_range.html b/bdb/docs/api_c/db_key_range.html new file mode 100644 index 00000000000..1e3c4c91f99 --- /dev/null +++ b/bdb/docs/api_c/db_key_range.html @@ -0,0 +1,106 @@ +<!--$Id: db_key_range.so,v 10.5 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->key_range</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->key_range</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->key_range(DB *db, DB_TXN *txnid, + DBT *key, DB_KEY_RANGE *key_range, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->key_range function returns an estimate of the proportion of keys +that are less than, equal to and greater than the specified key. The +underlying database must be of type Btree. +<p>The information is returned in the <b>key_range</b> argument, which +contains three elements of type double, <b>less</b>, <b>equal</b> and +<b>greater</b>. Values are in the range of 0 to 1, e.g., if the field +<b>less</b> is 0.05, that indicates that 5% of the keys in the database +are less than the key argument. The value for <b>equal</b> will be zero +if there is no matching key and non-zero otherwise. +<p>If the file is being accessed under transaction protection, the +<b>txnid</b> parameter is a transaction ID returned from +<a href="../api_c/txn_begin.html">txn_begin</a>, otherwise, NULL. +The DB->key_range function does not retain the locks it acquires for the +life of the transaction, so estimates may not be repeatable. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>The DB->key_range function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->key_range function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The underlying database was not of type Btree. +</dl> +<p>The DB->key_range function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->key_range function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_lsn.html b/bdb/docs/api_c/db_lsn.html new file mode 100644 index 00000000000..1fc62e5e688 --- /dev/null +++ b/bdb/docs/api_c/db_lsn.html @@ -0,0 +1,36 @@ +<!--$Id: db_lsn.so,v 10.7 1999/12/20 08:52:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<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><tr valign=top> +<td> +<h1>DB_LSN</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +</pre></h3> +<h1>Description</h1> +<p>A <a href="../api_c/db_lsn.html">DB_LSN</a> is a <b>log sequence number</b>, which indicates a +unique position in the log. The <a href="../api_c/db_lsn.html">DB_LSN</a> structure is completely +opaque, and no application should ever need to look inside. +<a href="../api_c/db_lsn.html">DB_LSN</a> structures are used by the logging and memory pool +subsystems. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_open.html b/bdb/docs/api_c/db_open.html new file mode 100644 index 00000000000..afd410223a6 --- /dev/null +++ b/bdb/docs/api_c/db_open.html @@ -0,0 +1,182 @@ +<!--$Id: db_open.so,v 10.61 2000/10/25 15:24:44 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->open</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->open</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->open(DB *db, const char *file, + const char *database, DBTYPE type, u_int32_t flags, int mode); +</pre></h3> +<h1>Description</h1> +<p>The currently supported Berkeley DB file formats (or <i>access methods</i>) +are Btree, Hash, Queue and Recno. The Btree format is a representation +of a sorted, balanced tree structure. The Hash format is an extensible, +dynamic hashing scheme. The Queue format supports fast access to +fixed-length records accessed by sequentially or logical record number. +The Recno format supports fixed- or variable-length records, accessed +sequentially or by logical record number, and optionally retrieved from +a flat text file. +<p>Storage and retrieval for the Berkeley DB access methods are based on key/data +pairs, see <a href="../api_c/dbt.html">DBT</a> for more information. +<p>The DB->open interface opens the database represented by the +<b>file</b> and <b>database</b> arguments for both reading and writing. +The <b>file</b> argument is used as the name of a physical file on disk +that will be used to back the database. The <b>database</b> argument is +optional and allows applications to have multiple logical databases in a +single physical file. While no <b>database</b> argument needs to be +specified, it is an error to attempt to open a second database in a +<b>file</b> that was not initially created using a <b>database</b> name. +In-memory databases never intended to be preserved on disk may +be created by setting both the <b>file</b> and <b>database</b> arguments +to NULL. Note that in-memory databases can only ever be shared by +sharing the single database handle that created them, in circumstances +where doing so is safe. +<p>The <b>type</b> argument is of type DBTYPE +and must be set to one of DB_BTREE, DB_HASH, +DB_QUEUE, DB_RECNO or DB_UNKNOWN, except +that databases of type DB_QUEUE are restricted to one per +<b>file</b>. If <b>type</b> is DB_UNKNOWN, the database must +already exist and DB->open will automatically determine its type. +The <a href="../api_c/db_get_type.html">DB->get_type</a> function may be used to determine the underlying type of +databases opened using DB_UNKNOWN. +<p>The <b>flags</b> and <b>mode</b> arguments specify how files will be opened +and/or created if they do not already exist. +<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_CREATE">DB_CREATE</a><dd>Create any underlying files, as necessary. If the files do not already +exist and the DB_CREATE flag is not specified, the call will fail. +<p><dt><a name="DB_EXCL">DB_EXCL</a><dd>Return an error if the file already exists. Underlying filesystem +primitives are used to implement this flag. For this reason it is only +applicable to the physical file and cannot be used to test if a database +in a file already exists. +<p>The DB_EXCL flag is only meaningful when specified with the +DB_CREATE flag. +<p><dt><a name="DB_NOMMAP">DB_NOMMAP</a><dd>Do not map this database into process memory (see the description of the +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a> function for further information). +<p><dt><a name="DB_RDONLY">DB_RDONLY</a><dd>Open the database for reading only. Any attempt to modify items in the +database will fail regardless of the actual permissions of any underlying +files. +<p><dt><a name="DB_THREAD">DB_THREAD</a><dd>Cause the DB handle returned by DB->open to be +<i>free-threaded</i>, that is, useable by multiple threads within a +single address space. +<p><dt><a name="DB_TRUNCATE">DB_TRUNCATE</a><dd>Physically truncate the underlying file, discarding all previous databases +it might have held. Underlying filesystem primitives are used to +implement this flag. For this reason it is only applicable to the +physical file and cannot be used to discard databases within a file. +<p>The DB_TRUNCATE flag cannot be transaction protected, and it is +an error to specify it in a transaction protected environment. +</dl> +<p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by the access methods +are created with mode <b>mode</b> (as described in <b>chmod</b>(2)) and +modified by the process' umask value at the time of creation (see +<b>umask</b>(2)). The group ownership of created files is based on +the system and directory defaults, and is not further specified by Berkeley DB. +If <b>mode</b> is 0, files are created readable and writeable by both +owner and group. On Windows systems, the mode argument is ignored. +<p>Calling DB->open is a reasonably expensive operation, and +maintaining a set of open databases will normally be preferable to +repeatedly open and closing the database for each new query. +<p>The DB->open function returns a non-zero error value on failure and 0 on success. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using +<a href="../api_c/env_open.html">DBENV->open</a> the environment variable <b>DB_HOME</b> may be used +as the path of the database environment home. Specifically, DB->open +is affected by the configuration value DB_DATA_DIR. +</dl> +<p><dl compact> +<p><dt>TMPDIR<dd>If the <b>file</b> and <b>dbenv</b> arguments to DB->open are +NULL, the environment variable <b>TMPDIR</b> may be used as a +directory in which to create a temporary backing file. +</dl> +<h1>Errors</h1> +<p>The DB->open function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt><a name="DB_OLD_VERSION">DB_OLD_VERSION</a><dd>The database cannot be opened without being first upgraded. +<p><dt>EEXIST<dd>DB_CREATE and DB_EXCL were specified and the file exists. +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified (e.g., unknown database +type, page size, hash function, pad byte, byte order) or a flag value +or parameter that is incompatible with the specified database. +<p> +The <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified and spinlocks are not +implemented for this architecture. +<p>The <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified to DB->open, but was not +specified to the <a href="../api_c/env_open.html">DBENV->open</a> call for the environment in which the +DB handle was created. +<p>A <b>re_source</b> file was specified with either the <a href="../api_c/env_open.html#DB_THREAD">DB_THREAD</a> +flag or the provided database environment supports transaction +processing. +<p><dt>ENOENT<dd>A non-existent <b>re_source</b> file was specified. +</dl> +<p>The DB->open function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->open function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_put.html b/bdb/docs/api_c/db_put.html new file mode 100644 index 00000000000..85c63b7cc7e --- /dev/null +++ b/bdb/docs/api_c/db_put.html @@ -0,0 +1,136 @@ +<!--$Id: db_put.so,v 10.34 2000/09/16 22:27:56 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->put</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->put</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->put(DB *db, + DB_TXN *txnid, DBT *key, DBT *data, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->put function stores key/data pairs in the database. The default +behavior of the DB->put function is to enter the new key/data +pair, replacing any previously existing key if duplicates are disallowed, +or adding a duplicate data item if duplicates are allowed. If the database +supports duplicates, the DB->put function adds the new data value at the +end of the duplicate set. If the database supports sorted duplicates, +the new data value is inserted at the correct sorted location. +<p>If the file is being accessed under transaction protection, the +<b>txnid</b> parameter is a transaction ID returned from +<a href="../api_c/txn_begin.html">txn_begin</a>, otherwise, NULL. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_APPEND">DB_APPEND</a><dd>Append the key/data pair to the end of the database. For the +DB_APPEND flag to be specified, the underlying database must be +a Queue or Recno database. The record number allocated to the record is +returned in the specified <b>key</b>. +<p>There is a minor behavioral difference between the Recno and Queue access +methods for the DB_APPEND flag. If a transaction enclosing a +DB->put operation with the DB_APPEND flag aborts, the +record number may be decremented (and later re-allocated by a subsequent +DB_APPEND operation) by the Recno access method, but will not be +decremented or re-allocated by the Queue access method. +<p><dt><a name="DB_NODUPDATA">DB_NODUPDATA</a><dd>In the case of the Btree and Hash access methods, enter the new key/data +pair only if it does not already appear in the database. If the +key/data pair already appears in the database, <a href="../api_c/dbc_put.html#DB_KEYEXIST">DB_KEYEXIST</a> is +returned. The DB_NODUPDATA flag may only be specified if the +underlying database has been configured to support sorted duplicates. +<p>The DB_NODUPDATA flag may not be specified to the Queue or Recno +access methods. +<p><dt><a name="DB_NOOVERWRITE">DB_NOOVERWRITE</a><dd>Enter the new key/data pair only if the key does not already appear in +the database. If the key already appears in the database, +<a href="../api_c/dbc_put.html#DB_KEYEXIST">DB_KEYEXIST</a> is returned. Even if the database allows duplicates, +a call to DB->put with the DB_NOOVERWRITE flag set will +fail if the key already exists in the database. +</dl> +<p>Otherwise, the DB->put function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->put function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EACCES<dd>An attempt was made to modify a read-only database. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>A record number of 0 was specified. +<p>An attempt was made to add a record to a fixed-length database that was too +large to fit. +<p>An attempt was made to do a partial put. +</dl> +<p><dl compact> +<p><dt>ENOSPC<dd>A btree exceeded the maximum btree depth (255). +</dl> +<p>The DB->put function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->put function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_remove.html b/bdb/docs/api_c/db_remove.html new file mode 100644 index 00000000000..e8dae864538 --- /dev/null +++ b/bdb/docs/api_c/db_remove.html @@ -0,0 +1,108 @@ +<!--$Id: db_remove.so,v 10.20 2000/10/25 15:24:44 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->remove</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->remove</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->remove(DB *db, + const char *file, const char *database, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->remove interface removes the database specified by the +<b>file</b> and <b>database</b> arguments. If no <b>database</b> is +specified, the physical file represented by <b>file</b> is removed, +incidentally removing all databases that it contained. +<p>If a physical file is being removed and logging is currently enabled in +the database environment, no database in the file may be open when the +DB->remove function is called. Otherwise, no reference count of database +use is maintained by Berkeley DB. Applications should not remove databases that +are currently in use. In particular, some architectures do not permit +the removal of files with open handles. On these architectures, attempts +to remove databases that are currently in use will fail. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>Once DB->remove has been called, regardless of its return, the +DB handle may not be accessed again. +<p>The DB->remove function returns a non-zero error value on failure and 0 on success. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using +<a href="../api_c/env_open.html">DBENV->open</a> the environment variable <b>DB_HOME</b> may be used +as the path of the database environment home. Specifically, DB->remove +is affected by the configuration value DB_DATA_DIR. +</dl> +<h1>Errors</h1> +<p>The DB->remove function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>A database in the file is currently open. +</dl> +<p>The DB->remove function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->remove function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_rename.html b/bdb/docs/api_c/db_rename.html new file mode 100644 index 00000000000..ff90836c6b2 --- /dev/null +++ b/bdb/docs/api_c/db_rename.html @@ -0,0 +1,109 @@ +<!--$Id: db_rename.so,v 10.7 2000/10/25 15:24:44 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->rename</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->rename</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->rename(DB *db, const char *file, + const char *database, const char *newname, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->rename interface renames the database specified by the +<b>file</b> and <b>database</b> arguments to <b>newname</b>. If no +<b>database</b> is specified, the physical file represented by +<b>file</b> is renamed, incidentally renaming all databases that it +contained. +<p>If a physical file is being renamed and logging is currently enabled in +the database environment, no database in the file may be open when the +DB->rename function is called. Otherwise, no reference count of database +use is maintained by Berkeley DB. Applications should not rename databases that +are currently in use. In particular, some architectures do not permit +renaming files with open handles. On these architectures, attempts to +rename databases that are currently in use will fail. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>Once DB->rename has been called, regardless of its return, the +DB handle may not be accessed again. +<p>The DB->rename function returns a non-zero error value on failure and 0 on success. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using +<a href="../api_c/env_open.html">DBENV->open</a> the environment variable <b>DB_HOME</b> may be used +as the path of the database environment home. Specifically, DB->rename +is affected by the configuration value DB_DATA_DIR. +</dl> +<h1>Errors</h1> +<p>The DB->rename function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>A database in the file is currently open. +</dl> +<p>The DB->rename function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->rename function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_append_recno.html b/bdb/docs/api_c/db_set_append_recno.html new file mode 100644 index 00000000000..4b90190ffbd --- /dev/null +++ b/bdb/docs/api_c/db_set_append_recno.html @@ -0,0 +1,66 @@ +<!--$Id: db_set_append_recno.so,v 1.3 2000/07/18 16:19:44 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_append_recno</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_append_recno</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_append_recno(DB *, + int (*db_append_recno_fcn)(DB *dbp, DBT *data, db_recno_t recno)); +</pre></h3> +<h1>Description</h1> +<p>When using the <a href="../api_c/db_put.html#DB_APPEND">DB_APPEND</a> option of the <a href="../api_c/db_put.html">DB->put</a> method, +it may be useful to modify the stored data based on the generated key. +If a callback function is specified using the +DB->set_append_recno function, it will be called after the record number +has been selected but before the data has been stored. +The callback function must return 0 on success and <b>errno</b> or +a value outside of the Berkeley DB error name space on failure. +<p>The called function must take three arguments: a reference to the +enclosing database handle, the data <a href="../api_c/dbt.html">DBT</a> to be stored and the +selected record number. The called function may then modify the data +<a href="../api_c/dbt.html">DBT</a>. +<p>The DB->set_append_recno interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_append_recno function returns a non-zero error value on failure and 0 on success. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_bt_compare.html b/bdb/docs/api_c/db_set_bt_compare.html new file mode 100644 index 00000000000..bf38ee51d94 --- /dev/null +++ b/bdb/docs/api_c/db_set_bt_compare.html @@ -0,0 +1,105 @@ +<!--$Id: db_set_bt_compare.so,v 10.24 2000/10/26 15:20:40 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_bt_compare</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_bt_compare</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_bt_compare(DB *db, + int (*bt_compare_fcn)(DB *, const DBT *, const DBT *)); +</pre></h3> +<h1>Description</h1> +<p>Set the Btree key comparison function. The comparison function is +called when it is necessary to compare a key specified by the +application with a key currently stored in the tree. The first argument +to the comparison function is the <a href="../api_c/dbt.html">DBT</a> representing the +application supplied key, the second is the current tree's key. +<p>The comparison function must return an integer value less than, equal +to, or greater than zero if the first key argument is considered to be +respectively less than, equal to, or greater than the second key +argument. In addition, the comparison function must cause the keys in +the database to be <i>well-ordered</i>. The comparison function +must correctly handle any key values used by the application (possibly +including zero-length keys). In addition, when Btree key prefix +comparison is being performed (see <a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a> for more +information), the comparison routine may be passed a prefix of any +database key. The <b>data</b> and <b>size</b> fields of the +<a href="../api_c/dbt.html">DBT</a> are the only fields that may be used for the purposes of +this comparison. +<p>If no comparison function is specified, the keys are compared lexically, +with shorter keys collating before longer keys. The same comparison +method must be used each time a particular Btree is opened. +<p>The DB->set_bt_compare interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_bt_compare function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_bt_minkey.html b/bdb/docs/api_c/db_set_bt_minkey.html new file mode 100644 index 00000000000..c36f3637ba5 --- /dev/null +++ b/bdb/docs/api_c/db_set_bt_minkey.html @@ -0,0 +1,92 @@ +<!--$Id: db_set_bt_minkey.so,v 10.14 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_bt_minkey</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_bt_minkey</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_bt_minkey(DB *db, u_int32_t bt_minkey); +</pre></h3> +<h1>Description</h1> +<p>Set the minimum number of keys that will be stored on any single +Btree page. +<p>This value is used to determine which keys will be stored on overflow +pages, i.e. if a key or data item is larger than the underlying database +page size divided by the <b>bt_minkey</b> value, it will be stored on +overflow pages instead of within the page itself. The <b>bt_minkey</b> +value specified must be at least 2; if <b>bt_minkey</b> is not explicitly +set, a value of 2 is used. +<p>The DB->set_bt_minkey interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_bt_minkey function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_bt_prefix.html b/bdb/docs/api_c/db_set_bt_prefix.html new file mode 100644 index 00000000000..88bf3157f97 --- /dev/null +++ b/bdb/docs/api_c/db_set_bt_prefix.html @@ -0,0 +1,106 @@ +<!--$Id: db_set_bt_prefix.so,v 10.25 2000/09/08 21:35:26 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_bt_prefix</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_bt_prefix</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_bt_prefix(DB *db, + size_t (*bt_prefix_fcn)(DB *, const DBT *, const DBT *)); +</pre></h3> +<h1>Description</h1> +<p>Set the Btree prefix function. The prefix function must return the +number of bytes of the second key argument that would be required by +the Btree key comparison function to determine the second key argument's +ordering relationship with respect to the first key argument. If the +two keys are equal, the key length should be returned. The prefix +function must correctly handle any key values used by the application +(possibly including zero-length keys). The <b>data</b> and +<b>size</b> fields of the <a href="../api_c/dbt.html">DBT</a> are the only fields that may be +used for the purposes of this determination. +<p>The prefix function is used to determine the amount by which keys stored +on the Btree internal pages can be safely truncated without losing their +uniqueness. See the <a href="../ref/am_conf/bt_prefix.html">Btree +prefix comparison</a> section of the Reference Guide for more details about +how this works. The usefulness of this is data dependent, but in some +data sets can produce significantly reduced tree sizes and search times. +<p>If no prefix function or key comparison function is specified by the +application, a default lexical comparison function is used as the prefix +function. If no prefix function is specified and a key comparison +function is specified, no prefix function is used. It is an error to +specify a prefix function without also specifying a key comparison +function. +<p>The DB->set_bt_prefix interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_bt_prefix function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_cachesize.html b/bdb/docs/api_c/db_set_cachesize.html new file mode 100644 index 00000000000..fd7176cbf7d --- /dev/null +++ b/bdb/docs/api_c/db_set_cachesize.html @@ -0,0 +1,107 @@ +<!--$Id: db_set_cachesize.so,v 10.17 2000/05/01 21:57:43 bostic Exp $--> +<!--$Id: m4.cachesize,v 10.7 2000/02/11 18:54:45 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_cachesize</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_cachesize</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_cachesize(DB *db, + u_int32_t gbytes, u_int32_t bytes, int ncache); +</pre></h3> +<h1>Description</h1> +<p>Set the size of the database's shared memory buffer pool, i.e., the cache, +to <b>gbytes</b> gigabytes plus <b>bytes</b>. The cache should be the +size of the normal working data set of the application, with some small +amount of additional memory for unusual situations. (Note, the working +set is not the same as the number of simultaneously referenced pages, and +should be quite a bit larger!) +<p>The default cache size is 256KB, and may not be specified as less than +20KB. Any cache size less than 500MB is automatically increased by 25% +to account for buffer pool overhead, cache sizes larger than 500MB are +used as specified. For information on tuning the Berkeley DB cache size, see +<a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>. +<p>It is possible to specify caches to Berkeley DB that are large enough so that +they cannot be allocated contiguously on some architectures, e.g., some +releases of Solaris limit the amount of memory that may be allocated +contiguously by a process. If <b>ncache</b> is 0 or 1, the cache will +be allocated contiguously in memory. If it is greater than 1, the cache +will be broken up into <b>ncache</b> equally sized separate pieces of +memory. +<p>As databases opened within Berkeley DB environments use the cache specified to +the environment, it is an error to attempt to set a cache in a database +created within an environment. +<p>The DB->set_cachesize interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_cachesize function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The specified cache size was impossibly small. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_dup_compare.html b/bdb/docs/api_c/db_set_dup_compare.html new file mode 100644 index 00000000000..2ac6ed9dec2 --- /dev/null +++ b/bdb/docs/api_c/db_set_dup_compare.html @@ -0,0 +1,102 @@ +<!--$Id: db_set_dup_compare.so,v 10.21 2000/10/26 15:20:40 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_dup_compare</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_dup_compare</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_dup_compare(DB *db, + int (*dup_compare_fcn)(DB *, const DBT *, const DBT *)); +</pre></h3> +<h1>Description</h1> +<p>Set the duplicate data item comparison function. The comparison function +is called when it is necessary to compare a data item specified by the +application with a data item currently stored in the tree. The first +argument to the comparison function is the <a href="../api_c/dbt.html">DBT</a> representing the +application's data item, the second is the current tree's data item. +<p>The comparison function must return an integer value less than, equal +to, or greater than zero if the first data item argument is considered +to be respectively less than, equal to, or greater than the second data +item argument. In addition, the comparison function must cause the data +items in the set to be <i>well-ordered</i>. The comparison function +must correctly handle any data item values used by the application +(possibly including zero-length data items). The <b>data</b> and +<b>size</b> fields of the <a href="../api_c/dbt.html">DBT</a> are the only fields that may be +used for the purposes of this comparison. +<p>If no comparison function is specified, the data items are compared +lexically, with shorter data items collating before longer data items. +The same duplicate data item comparison method must be used each time +a particular Btree is opened. +<p>The DB->set_dup_compare interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_dup_compare function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_errcall.html b/bdb/docs/api_c/db_set_errcall.html new file mode 100644 index 00000000000..97d8d9a3aca --- /dev/null +++ b/bdb/docs/api_c/db_set_errcall.html @@ -0,0 +1,76 @@ +<!--$Id: db_set_errcall.so,v 10.7 1999/12/20 08:52:28 bostic Exp $--> +<!--$Id: m4.errset,v 10.8 2000/02/19 20:57:57 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_errcall</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_errcall</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DB->set_errcall(DB *, + void (*db_errcall_fcn)(const char *errpfx, char *msg)); +</pre></h3> +<h1>Description</h1> +When an error occurs in the Berkeley DB library, a Berkeley DB error or an error +return value is returned by the function. In some cases, however, +the <b>errno</b> value may be insufficient to completely describe +the cause of the error especially during initial application debugging. +<p>The DB->set_errcall function is used to enhance the mechanism for reporting error +messages to the application. In some cases, when an error occurs, Berkeley DB +will call <b>db_errcall_fcn</b> with additional error information. The +function must be declared with two arguments; the first will be the prefix +string (as previously set by <a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> or +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>), the second will be the error message string. +It is up to the <b>db_errcall_fcn</b> function to display the error +message in an appropriate manner. +<p>Alternatively, you can use the <a href="../api_c/db_set_errfile.html">DB->set_errfile</a> or +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a> functions to display the additional information +via a C library FILE *. +<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 DB handles opened inside of Berkeley DB environments, calling the +DB->set_errcall function affects the entire environment and is equivalent to calling +the <a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a> function. +<p>The DB->set_errcall interface may be used to configure Berkeley DB at any time +during the life of the application. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_errfile.html b/bdb/docs/api_c/db_set_errfile.html new file mode 100644 index 00000000000..5d160ed5cf2 --- /dev/null +++ b/bdb/docs/api_c/db_set_errfile.html @@ -0,0 +1,73 @@ +<!--$Id: db_set_errfile.so,v 10.7 1999/12/20 08:52:28 bostic Exp $--> +<!--$Id: m4.errset,v 10.8 2000/02/19 20:57:57 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_errfile</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_errfile</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DB->set_errfile(DB *db, FILE *errfile); +</pre></h3> +<h1>Description</h1> +When an error occurs in the Berkeley DB library, a Berkeley DB error or an error +return value is returned by the function. In some cases, however, +the <b>errno</b> value may be insufficient to completely describe +the cause of the error especially during initial application debugging. +<p>The DB->set_errfile function is used to enhance the mechanism for reporting error +messages to the application by setting a C library FILE * to be used for +displaying additional Berkeley DB error messages. In some cases, when an error +occurs, Berkeley DB will output an additional error message to the specified +file reference. +<p>The error message will consist of the prefix string and a colon +("<b>:</b>") (if a prefix string was previously specified using +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> or <a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>), an error string, and +a trailing <newline> character. +<p>This error logging enhancement does not slow performance or significantly +increase application size, and may be run during normal operation as well +as during application debugging. +<p>For DB handles opened inside of Berkeley DB environments, calling the +DB->set_errfile function affects the entire environment and is equivalent to calling +the <a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a> function. +<p>The DB->set_errfile interface may be used to configure Berkeley DB at any time +during the life of the application. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_errpfx.html b/bdb/docs/api_c/db_set_errpfx.html new file mode 100644 index 00000000000..baf8f61fef7 --- /dev/null +++ b/bdb/docs/api_c/db_set_errpfx.html @@ -0,0 +1,62 @@ +<!--$Id: db_set_errpfx.so,v 10.6 1999/12/20 08:52:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_errpfx</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_errpfx</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DB->set_errpfx(DB *db, const char *errpfx); +</pre></h3> +<h1>Description</h1> +<p>Set the prefix string that appears before error messages issued by Berkeley DB. +<p>The DB->set_errpfx function does not copy the memory referenced by the +<b>errpfx</b> argument, rather, it maintains a reference to it. This +allows applications to modify the error message prefix at any time, +without repeatedly calling DB->set_errpfx, but means that the +memory must be maintained until the handle is closed. +<p>For DB handles opened inside of Berkeley DB environments, calling the +DB->set_errpfx function affects the entire environment and is equivalent to calling +the <a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a> function. +<p>The DB->set_errpfx interface may be used to configure Berkeley DB at any time +during the life of the application. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_feedback.html b/bdb/docs/api_c/db_set_feedback.html new file mode 100644 index 00000000000..213060ee765 --- /dev/null +++ b/bdb/docs/api_c/db_set_feedback.html @@ -0,0 +1,95 @@ +<!--$Id: db_set_feedback.so,v 10.16 2000/07/09 19:11:54 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_feedback</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_feedback</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_feedback(DB *, + void (*db_feedback_fcn)(DB *dbp, int opcode, int pct)); +</pre></h3> +<h1>Description</h1> +<p>Some operations performed by the Berkeley DB library can take non-trivial +amounts of time. The DB->set_feedback function can be used by +applications to monitor progress within these operations. +<p>When an operation is likely to take a long time, Berkeley DB will call the +specified callback function. This function must be declared with +three arguments: the first will be a reference to the enclosing database +handle, the second a flag value, and the third the percent of the +operation that has been completed, specified as an integer value between +0 and 100. It is up to the callback function to display this +information in an appropriate manner. +<p>The <b>opcode</b> argument may take on any of the following values: +<p><dl compact> +<p><dt><a name="DB_UPGRADE">DB_UPGRADE</a><dd>The underlying database is being upgraded. +<p><dt><a name="DB_VERIFY">DB_VERIFY</a><dd>The underlying database is being verified. +</dl> +<p>The DB->set_feedback interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The DB->set_feedback function returns a non-zero error value on failure and 0 on success. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_flags.html b/bdb/docs/api_c/db_set_flags.html new file mode 100644 index 00000000000..f1823381776 --- /dev/null +++ b/bdb/docs/api_c/db_set_flags.html @@ -0,0 +1,181 @@ +<!--$Id: db_set_flags.so,v 10.26 2000/03/17 01:53:58 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_flags</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_flags</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_flags(DB *db, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>Calling DB->set_flags is additive, there is no way to clear flags. +<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. +<h3>Btree</h3> +<p>The following flags may be specified for the Btree access method: +<p><dl compact> +<p><dt><a name="DB_DUP">DB_DUP</a><dd>Permit duplicate data items in the tree, i.e. insertion when the key of +the key/data pair being inserted already exists in the tree will be +successful. The ordering of duplicates in the tree is determined by the +order of insertion, unless the ordering is otherwise specified by use of +a cursor operation. It is an error to specify both DB_DUP and +DB_RECNUM. +<p><dt><a name="DB_DUPSORT">DB_DUPSORT</a><dd>Permit duplicate data items in the tree, i.e. insertion when the key of +the key/data pair being inserted already exists in the tree will be +successful. The ordering of duplicates in the tree is determined by the +duplicate comparison function. +If the application does not specify a comparison function using the +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a> function, a default, lexical comparison will be +used. +It is an error to specify both DB_DUPSORT and DB_RECNUM. +<p><dt><a name="DB_RECNUM">DB_RECNUM</a><dd>Support retrieval from the Btree using record numbers. For more +information, see the DB_GET_RECNO flag to the <a href="../api_c/db_get.html">DB->get</a> and +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> methods. +<p>Logical record numbers in Btree databases are mutable in the face of +record insertion or deletion. See the DB_RENUMBER flag in the Recno +access method information for further discussion. +<p>Maintaining record counts within a Btree introduces a serious point of +contention, namely the page locations where the record counts are stored. +In addition, the entire tree must be locked during both insertions and +deletions, effectively single-threading the tree for those operations. +Specifying DB_RECNUM can result in serious performance degradation for +some applications and data sets. +<p>It is an error to specify both DB_DUP and DB_RECNUM. +<p><dt><a name="DB_REVSPLITOFF">DB_REVSPLITOFF</a><dd>Turn off reverse splitting in the Btree. As pages are emptied in a +database, the Berkeley DB Btree implementation attempts to coalesce empty pages +into higher-level pages in order to keep the tree as small as possible +and minimize tree search time. This can hurt performance in applications +with cyclical data demands, that is, applications where the database grows +and shrinks repeatedly. For example, because Berkeley DB does page-level +locking, the maximum level of concurrency in a database of 2 pages is far +smaller than that in a database of 100 pages, and so a database that has +shrunk to a minimal size can cause severe deadlocking when a new cycle of +data insertion begins. +</dl> +<h3>Hash</h3> +<p>The following flags may be specified for the Hash access method: +<p><dl compact> +<p><dt><a name="DB_DUP">DB_DUP</a><dd>Permit duplicate data items in the tree, i.e. insertion when the key of +the key/data pair being inserted already exists in the tree will be +successful. The ordering of duplicates in the tree is determined by the +order of insertion, unless the ordering is otherwise specified by use of +a cursor operation. It is an error to specify both DB_DUP and +DB_RECNUM. +<p><dt><a name="DB_DUPSORT">DB_DUPSORT</a><dd>Permit duplicate data items in the tree, i.e. insertion when the key of +the key/data pair being inserted already exists in the tree will be +successful. The ordering of duplicates in the tree is determined by the +duplicate comparison function. +If the application does not specify a comparison function using the +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a> function, a default, lexical comparison will be +used. +It is an error to specify both DB_DUPSORT and DB_RECNUM. +</dl> +<h3>Queue</h3> +<p>There are no additional flags that may be specified for the Queue access +method. +<h3>Recno</h3> +<p>The following flags may be specified for the Recno access method: +<p><dl compact> +<p><dt><a name="DB_RENUMBER">DB_RENUMBER</a><dd>Specifying the DB_RENUMBER flag causes the logical record numbers to be +mutable, and change as records are added to and deleted from the database. +For example, the deletion of record number 4 causes records numbered 5 +and greater to be renumbered downward by 1. If a cursor was positioned +to record number 4 before the deletion, it will reference the new record +number 4, if any such record exists, after the deletion. If a cursor was +positioned after record number 4 before the deletion, it will be shifted +downward 1 logical record, continuing to reference the same record as it +did before. +<p>Using the <a href="../api_c/db_put.html">DB->put</a> or <a href="../api_c/dbc_put.html">DBcursor->c_put</a> interfaces to create new +records will cause the creation of multiple records if the record number +is more than one greater than the largest record currently in the +database. For example, creating record 28, when record 25 was previously +the last record in the database, will create records 26 and 27 as well as +28. Attempts to retrieve records that were created in this manner will +result in an error return of <a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. +<p>If a created record is not at the end of the database, all records +following the new record will be automatically renumbered upward by 1. +For example, the creation of a new record numbered 8 causes records +numbered 8 and greater to be renumbered upward by 1. If a cursor was +positioned to record number 8 or greater before the insertion, it will be +shifted upward 1 logical record, continuing to reference the same record +as it did before. +<p>For these reasons, concurrent access to a Recno database with the +DB_RENUMBER flag specified may be largely meaningless, although +it is supported. +<p><dt><a name="DB_SNAPSHOT">DB_SNAPSHOT</a><dd>This flag specifies that any specified <b>re_source</b> file be read in +its entirety when <a href="../api_c/db_open.html">DB->open</a> is called. If this flag is not +specified, the <b>re_source</b> file may be read lazily. +</dl> +<p>The DB->set_flags interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_flags function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_h_ffactor.html b/bdb/docs/api_c/db_set_h_ffactor.html new file mode 100644 index 00000000000..c3bbb607ea5 --- /dev/null +++ b/bdb/docs/api_c/db_set_h_ffactor.html @@ -0,0 +1,93 @@ +<!--$Id: db_set_h_ffactor.so,v 10.15 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_h_ffactor</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_h_ffactor</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_h_ffactor(DB *db, u_int32_t h_ffactor); +</pre></h3> +<h1>Description</h1> +<p>Set the desired density within the hash table. +<p>The density is an approximation of the number of keys allowed to +accumulate in any one bucket, determining when the hash table grows or +shrinks. If you know the average sizes of the keys and data in your +dataset, setting the fill factor can enhance performance. A reasonable +rule computing fill factor is to set it to: +<p><blockquote><pre>(pagesize - 32) / (average_key_size + average_data_size + 8)</pre></blockquote> +<p>If no value is specified, the fill factor will be selected dynamically as +pages are filled. +<p>The DB->set_h_ffactor interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_h_ffactor function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_h_hash.html b/bdb/docs/api_c/db_set_h_hash.html new file mode 100644 index 00000000000..cae03fa72b3 --- /dev/null +++ b/bdb/docs/api_c/db_set_h_hash.html @@ -0,0 +1,97 @@ +<!--$Id: db_set_h_hash.so,v 10.18 2000/07/04 18:28:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_h_hash</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_h_hash</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_h_hash(DB *db, + u_int32_t (*h_hash_fcn)(DB *, const void *bytes, u_int32_t length)); +</pre></h3> +<h1>Description</h1> +<p>Set a user defined hash method; if no hash method is specified, a default +hash method is used. Since no hash method performs equally well on all +possible data, the user may find that the built-in hash method performs +poorly with a particular data set. User specified hash functions must +take a pointer to a byte string and a length as arguments and return a +value of type +<b>u_int32_t</b>. +The hash function must handle any key values used by the application +(possibly including zero-length keys). +<p>If a hash method is specified, <a href="../api_c/db_open.html">DB->open</a> will attempt to determine +if the hash method specified is the same as the one with which the database +was created, and will fail if it detects that it is not. +<p>The DB->set_h_hash interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_h_hash function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_h_nelem.html b/bdb/docs/api_c/db_set_h_nelem.html new file mode 100644 index 00000000000..d052afff7dc --- /dev/null +++ b/bdb/docs/api_c/db_set_h_nelem.html @@ -0,0 +1,88 @@ +<!--$Id: db_set_h_nelem.so,v 10.15 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_h_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> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_h_nelem</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_h_nelem(DB *db, u_int32_t h_nelem); +</pre></h3> +<h1>Description</h1> +<p>Set an estimate of the final size of the hash table. +<p>If not set or set too low, hash tables will still expand gracefully +as keys are entered, although a slight performance degradation may be +noticed. +<p>The DB->set_h_nelem interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_h_nelem function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_lorder.html b/bdb/docs/api_c/db_set_lorder.html new file mode 100644 index 00000000000..a9a3c923037 --- /dev/null +++ b/bdb/docs/api_c/db_set_lorder.html @@ -0,0 +1,94 @@ +<!--$Id: db_set_lorder.so,v 10.15 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_lorder</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_lorder</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_lorder(DB *db, int lorder); +</pre></h3> +<h1>Description</h1> +<p>Set the byte order for integers in the stored database metadata. The +number should represent the order as an integer, for example, big endian +order is the number 4,321, and little endian order is the number 1,234. +If <b>lorder</b> is not explicitly set, the host order of the machine +where the Berkeley DB library was compiled is used. +<p>The value of <b>lorder</b> is ignored except when databases are being +created. If a database already exists, the byte order it uses is +determined when the database is opened. +<p><b>The access methods provide no guarantees about the byte ordering of the +application data stored in the database, and applications are responsible +for maintaining any necessary ordering.</b> +<p>The DB->set_lorder interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_lorder function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_malloc.html b/bdb/docs/api_c/db_set_malloc.html new file mode 100644 index 00000000000..2d13196a3ad --- /dev/null +++ b/bdb/docs/api_c/db_set_malloc.html @@ -0,0 +1,98 @@ +<!--$Id: db_set_malloc.so,v 10.18 2000/05/25 13:47:07 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_malloc</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_malloc</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_malloc(DB *db, void *(*db_malloc)(size_t size)); +</pre></h3> +<h1>Description</h1> +<p>Set the allocation function used by the DB methods to allocate +memory in which to return key/data items to the application. +<p>The <a href="../api_c/dbt.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a> flag, when specified in the <a href="../api_c/dbt.html">DBT</a> object, +will cause the DB methods to allocate and re-allocate memory which +then becomes the responsibility of the calling application. See <a href="../api_c/dbt.html">DBT</a> +for more information. +<p>On systems where there may be multiple library versions of malloc (notably +Windows NT), specifying the <a href="../api_c/dbt.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a> flag will fail because +the DB library will allocate memory from a different heap than +the application will use to free it. To avoid this problem, the +DB->set_malloc function can be used to pass Berkeley DB a reference to the +application's allocation routine, in which case it will be used to +allocate the memory returned when the <a href="../api_c/dbt.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a> flag is set. +<p>The function specified must match the calling conventions of the +ANSI C X3.159-1989 (ANSI C) library routine of the same name. +<p>The DB->set_malloc interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_malloc function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_pagesize.html b/bdb/docs/api_c/db_set_pagesize.html new file mode 100644 index 00000000000..7fa4af53dbc --- /dev/null +++ b/bdb/docs/api_c/db_set_pagesize.html @@ -0,0 +1,90 @@ +<!--$Id: db_set_pagesize.so,v 10.16 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_pagesize</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_pagesize</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_pagesize(DB *db, u_int32_t pagesize); +</pre></h3> +<h1>Description</h1> +<p>Set the size of the pages used to hold items in the database, in bytes. +The minimum page size is 512 bytes and the maximum page size is 64K bytes. +If the page size is not explicitly set, one is selected based on the +underlying filesystem I/O block size. The automatically selected size +has a lower limit of 512 bytes and an upper limit of 16K bytes. +<p>For information on tuning the Berkeley DB page size, see +<a href="../ref/am_conf/pagesize.html">Selecting a page size</a>. +<p>The DB->set_pagesize interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_pagesize function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_paniccall.html b/bdb/docs/api_c/db_set_paniccall.html new file mode 100644 index 00000000000..506272c9630 --- /dev/null +++ b/bdb/docs/api_c/db_set_paniccall.html @@ -0,0 +1,70 @@ +<!--$Id: db_set_paniccall.so,v 10.11 2000/07/09 19:12:16 bostic Exp $--> +<!--$Id: m4.errset,v 10.8 2000/02/19 20:57:57 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_paniccall</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_paniccall</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_paniccall(DB *db, + void (*paniccall)(DB_ENV *, int errval)); +</pre></h3> +<h1>Description</h1> +<p>Errors can occur in the Berkeley DB library where the only solution is to shut +down the application and run recovery. (For example, if Berkeley DB is unable +to write log records to disk because there is insufficient disk space.) +In these cases, the value <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> is returned by Berkeley DB. +<p>In these cases, it is also often simpler to shut down the application when +such errors occur rather than attempting to gracefully return up the stack. +The DB->set_paniccall function is used to specify a function to be called when +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> is about to be returned from a Berkeley DB method. When +called, the <b>dbenv</b> argument will be a reference to the current +environment, and the <b>errval</b> argument is the error value that would +have been returned to the calling function. +<p>For DB handles opened inside of Berkeley DB environments, calling the +DB->set_paniccall function affects the entire environment and is equivalent to calling +the <a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a> function. +<p>The DB->set_paniccall interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The DB->set_paniccall function returns a non-zero error value on failure and 0 on success. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_q_extentsize.html b/bdb/docs/api_c/db_set_q_extentsize.html new file mode 100644 index 00000000000..7ab89bdba5d --- /dev/null +++ b/bdb/docs/api_c/db_set_q_extentsize.html @@ -0,0 +1,90 @@ +<!--$Id: db_set_q_extentsize.so,v 1.3 2000/11/21 19:25:45 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_q_extentsize</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_q_extentsize</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_q_extentsize(DB *db, u_int32_t extentsize); +</pre></h3> +<h1>Description</h1> +<p>Set the size of the extents used to hold pages in a Queue database, +specified as a number of pages. Each extent is created as a separate +physical file. If no extent size is set, the default behavior is to +create only a single underlying database file. +<p>For information on tuning the extent size, see +<a href="../ref/am_conf/extentsize.html">Selecting a extent size</a>. +<p>The DB->set_q_extentsize interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_q_extentsize function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_re_delim.html b/bdb/docs/api_c/db_set_re_delim.html new file mode 100644 index 00000000000..6101130a5e5 --- /dev/null +++ b/bdb/docs/api_c/db_set_re_delim.html @@ -0,0 +1,90 @@ +<!--$Id: db_set_re_delim.so,v 10.17 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_re_delim</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_re_delim</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_re_delim(DB *db, int re_delim); +</pre></h3> +<h1>Description</h1> +<p>Set the delimiting byte used to mark the end of a record in the backing +source file for the Recno access method. +<p>This byte is used for variable length records, if the <b>re_source</b> +file is specified. If the <b>re_source</b> file is specified and no +delimiting byte was specified, <newline> characters (i.e. +ASCII 0x0a) are interpreted as end-of-record markers. +<p>The DB->set_re_delim interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_re_delim function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_re_len.html b/bdb/docs/api_c/db_set_re_len.html new file mode 100644 index 00000000000..67b67ddfc0a --- /dev/null +++ b/bdb/docs/api_c/db_set_re_len.html @@ -0,0 +1,94 @@ +<!--$Id: db_set_re_len.so,v 10.17 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_re_len</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_re_len</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_re_len(DB *db, u_int32_t re_len); +</pre></h3> +<h1>Description</h1> +<p>For the Queue access method, specify that the records are of length +<b>re_len</b>. +<p>For the Recno access method, specify that the records are fixed-length, +not byte delimited, and are of length <b>re_len</b>. +<p>Any records added to the database that are less than <b>re_len</b> bytes +long are automatically padded (see <a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a> for more +information). +<p>Any attempt to insert records into the database that are greater than +<b>re_len</b> bytes long will cause the call to fail immediately and +return an error. +<p>The DB->set_re_len interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_re_len function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_re_pad.html b/bdb/docs/api_c/db_set_re_pad.html new file mode 100644 index 00000000000..43a6f947f5d --- /dev/null +++ b/bdb/docs/api_c/db_set_re_pad.html @@ -0,0 +1,88 @@ +<!--$Id: db_set_re_pad.so,v 10.16 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_re_pad</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_re_pad</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_re_pad(DB *db, int re_pad); +</pre></h3> +<h1>Description</h1> +<p>Set the padding character for short, fixed-length records for the Queue +and Recno access methods. +<p>If no pad character is specified, <space> characters (i.e., +ASCII 0x20) are used for padding. +<p>The DB->set_re_pad interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_re_pad function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_re_source.html b/bdb/docs/api_c/db_set_re_source.html new file mode 100644 index 00000000000..1a57cfea339 --- /dev/null +++ b/bdb/docs/api_c/db_set_re_source.html @@ -0,0 +1,130 @@ +<!--$Id: db_set_re_source.so,v 10.17 2000/05/01 21:57:43 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_re_source</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_re_source</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_re_source(DB *db, char *re_source); +</pre></h3> +<h1>Description</h1> +<p>Set the underlying source file for the Recno access method. The purpose +of the <b>re_source</b> value is to provide fast access and modification +to databases that are normally stored as flat text files. +<p>If the <b>re_source</b> field is set, it specifies an underlying flat +text database file that is read to initialize a transient record number +index. In the case of variable length records, the records are separated +as specified by <a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>. For example, standard UNIX +byte stream files can be interpreted as a sequence of variable length +records separated by <newline> characters. +<p>In addition, when cached data would normally be written back to the +underlying database file (e.g., the <a href="../api_c/db_close.html">DB->close</a> or <a href="../api_c/db_sync.html">DB->sync</a> +methods are called), the in-memory copy of the database will be written +back to the <b>re_source</b> file. +<p>By default, the backing source file is read lazily, i.e., records are not +read from the file until they are requested by the application. +<b>If multiple processes (not threads) are accessing a Recno database +concurrently and either inserting or deleting records, the backing source +file must be read in its entirety before more than a single process +accesses the database, and only that process should specify the backing +source file as part of the <a href="../api_c/db_open.html">DB->open</a> call. See the <a href="../api_c/db_set_flags.html#DB_SNAPSHOT">DB_SNAPSHOT</a> +flag for more information.</b> +<p><b>Reading and writing the backing source file specified by <b>re_source</b> +cannot be transactionally protected because it involves filesystem +operations that are not part of the Db transaction methodology.</b> +For this reason, if a temporary database is used to hold the records, +i.e., a NULL was specified as the <b>file</b> argument to <a href="../api_c/db_open.html">DB->open</a>, +it is possible to lose the contents of the <b>re_source</b> file, e.g., +if the system crashes at the right instant. +If a file is used to hold the database, i.e., a file name was specified +as the <b>file</b> argument to <a href="../api_c/db_open.html">DB->open</a>, normal database +recovery on that file can be used to prevent information loss, +although it is still possible that the contents of <b>re_source</b> +will be lost if the system crashes. +<p>The <b>re_source</b> file must already exist (but may be zero-length) when +<a href="../api_c/db_open.html">DB->open</a> is called. +<p>It is not an error to specify a read-only <b>re_source</b> file when +creating a database, nor is it an error to modify the resulting database. +However, any attempt to write the changes to the backing source file using +either the <a href="../api_c/db_sync.html">DB->sync</a> or <a href="../api_c/db_close.html">DB->close</a> functions will fail, of course. +Specify the <a href="../api_c/db_close.html#DB_NOSYNC">DB_NOSYNC</a> flag to the <a href="../api_c/db_close.html">DB->close</a> function to stop it +from attempting to write the changes to the backing file, instead, they +will be silently discarded. +<p>For all of the above reasons, the <b>re_source</b> field is generally +used to specify databases that are read-only for DB applications, +and that are either generated on the fly by software tools, or modified +using a different mechanism, e.g., a text editor. +<p>The DB->set_re_source interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_re_source function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/db_open.html">DB->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_set_realloc.html b/bdb/docs/api_c/db_set_realloc.html new file mode 100644 index 00000000000..b3d8a05f771 --- /dev/null +++ b/bdb/docs/api_c/db_set_realloc.html @@ -0,0 +1,99 @@ +<!--$Id: db_set_realloc.so,v 10.8 2000/05/25 13:47:07 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->set_realloc</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->set_realloc</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->set_realloc(DB *db, + void *(*db_realloc_fcn)(void *ptr, size_t size)); +</pre></h3> +<h1>Description</h1> +<p>Set the realloc function used by the DB methods to allocate memory +in which to return key/data items to the application. +<p>The <a href="../api_c/dbt.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> flag, when specified in the <a href="../api_c/dbt.html">DBT</a> object, +will cause the DB methods to allocate and re-allocate memory which +then becomes the responsibility of the calling application. See <a href="../api_c/dbt.html">DBT</a> +for more information. +<p>On systems where there may be multiple library versions of realloc (notably +Windows NT), specifying the <a href="../api_c/dbt.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> flag will fail because +the DB library will allocate memory from a different heap than +the application will use to free it. To avoid this problem, the +DB->set_realloc function can be used to pass Berkeley DB a reference to the +application's allocation routine, in which case it will be used to +allocate the memory returned when the <a href="../api_c/dbt.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> flag is set. +<p>The function specified must match the calling conventions of the +ANSI C X3.159-1989 (ANSI C) library routine of the same name. +<p>The DB->set_realloc interface may only be used to configure Berkeley DB before +the <a href="../api_c/db_open.html">DB->open</a> interface is called. +<p>The DB->set_realloc function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_stat.html b/bdb/docs/api_c/db_stat.html new file mode 100644 index 00000000000..92412d76d78 --- /dev/null +++ b/bdb/docs/api_c/db_stat.html @@ -0,0 +1,195 @@ +<!--$Id: db_stat.so,v 10.37 2000/10/03 21:55:45 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->stat</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->stat(DB *db, + void *sp, void *(*db_malloc)(size_t), u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->stat function creates a statistical structure and +copies a pointer to it into user-specified memory locations. +Specifically, if <b>sp</b> is non-NULL, a pointer to the statistics +for the database are copied into the memory location it references. +<p>Statistical structures are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<p>The <b>flags</b> parameter must be set to 0 or the following value: +<p><dl compact> +<p><dt><a name="DB_CACHED_COUNTS">DB_CACHED_COUNTS</a><dd>Return a cached count of the keys and records in a database. This flag +makes it possible for applications to request an possibly approximate key +and record count without incurring the performance penalty of traversing +the entire database. The statistics information described for the access +method <b>XX_nkeys</b> and <b>XX_ndata</b> fields below is filled in, +but no other information is collected. If the cached information has +never been set, the fields will be returned set to 0. +<p><dt><a name="DB_RECORDCOUNT">DB_RECORDCOUNT</a><dd>Return a count of the records in a Btree or Recno Access Method database. +This flag makes it possible for applications to request a record count +without incurring the performance penalty of traversing the entire +database. The statistics information described for the <b>bt_nkeys</b> +field below is filled in, but no other information is collected. +<p>This option is only available for Recno databases, or Btree databases +where the underlying database was created with the <a href="../api_c/db_set_flags.html#DB_RECNUM">DB_RECNUM</a> +flag. +</dl> +<p>The DB->stat function may access all of the pages in the database, +incurring a severe performance penalty as well as possibly flushing the +underlying buffer pool. +<p>In the presence of multiple threads or processes accessing an active +database, the information returned by DB->stat may be out-of-date. +<p>If the database was not opened readonly and the DB_CACHED_COUNTS +flag was not specified, the cached key and record numbers will be updated +after the statistical information has been gathered. +<p>The DB->stat function cannot be transaction protected. For this reason, +it should be called in a thread of control that has no open cursors or +active transactions. +<p>The DB->stat function returns a non-zero error value on failure and 0 on success. +<h3>Hash Statistics</h3> +<p>In the case of a Hash database, +the statistics are stored in a structure of type DB_HASH_STAT. The +following fields will be filled in: +<p><dl compact> +<p><dt>u_int32_t hash_magic;<dd>Magic number that identifies the file as a Hash file. +<dt>u_int32_t hash_version;<dd>The version of the Hash database. +<dt>u_int32_t hash_nkeys;<dd>The number of unique keys in the database. +<dt>u_int32_t hash_ndata;<dd>The number of key/data pairs in the database.] +<dt>u_int32_t hash_pagesize;<dd>The underlying Hash database page (and bucket) size. +<dt>u_int32_t hash_nelem;<dd>The estimated size of the hash table specified at database creation time. +<dt>u_int32_t hash_ffactor;<dd>The desired fill factor (number of items per bucket) specified at database +creation time. +<dt>u_int32_t hash_buckets;<dd>The number of hash buckets. +<dt>u_int32_t hash_free;<dd>The number of pages on the free list. +<dt>u_int32_t hash_bfree;<dd>The number of bytes free on bucket pages. +<dt>u_int32_t hash_bigpages;<dd>The number of big key/data pages. +<dt>u_int32_t hash_big_bfree;<dd>The number of bytes free on big item pages. +<dt>u_int32_t hash_overflows;<dd>The number of overflow pages (overflow pages are pages that contain items +that did not fit in the main bucket page). +<dt>u_int32_t hash_ovfl_free;<dd>The number of bytes free on overflow pages. +<dt>u_int32_t hash_dup;<dd>The number of duplicate pages. +<dt>u_int32_t hash_dup_free;<dd>The number of bytes free on duplicate pages. +</dl> +<h3>Btree and Recno Statistics</h3> +<p>In the case of a Btree or Recno database, +the statistics are stored in a structure of type DB_BTREE_STAT. The +following fields will be filled in: +<p><dl compact> +<p><dt>u_int32_t bt_magic;<dd>Magic number that identifies the file as a Btree database. +<dt>u_int32_t bt_version;<dd>The version of the Btree database. +<dt>u_int32_t bt_nkeys;<dd>For the Btree Access Method, the number of unique keys in the database. +<p>For the Recno Access Method, the number of records in the database. +<dt>u_int32_t bt_ndata;<dd>For the Btree Access Method, the number of key/data pairs in the database. +<p>For the Recno Access Method, the number of records in the database. If +the database has been configured to not re-number records during +deletion, the number of records will only reflect undeleted records. +<dt>u_int32_t bt_pagesize;<dd>Underlying database page size. +<dt>u_int32_t bt_minkey;<dd>The minimum keys per page. +<dt>u_int32_t bt_re_len;<dd>The length of fixed-length records. +<dt>u_int32_t bt_re_pad;<dd>The padding byte value for fixed-length records. +<dt>u_int32_t bt_levels;<dd>Number of levels in the database. +<dt>u_int32_t bt_int_pg;<dd>Number of database internal pages. +<dt>u_int32_t bt_leaf_pg;<dd>Number of database leaf pages. +<dt>u_int32_t bt_dup_pg;<dd>Number of database duplicate pages. +<dt>u_int32_t bt_over_pg;<dd>Number of database overflow pages. +<dt>u_int32_t bt_free;<dd>Number of pages on the free list. +<dt>u_int32_t bt_int_pgfree;<dd>Number of bytes free in database internal pages. +<dt>u_int32_t bt_leaf_pgfree;<dd>Number of bytes free in database leaf pages. +<dt>u_int32_t bt_dup_pgfree;<dd>Number of bytes free in database duplicate pages. +<dt>u_int32_t bt_over_pgfree;<dd>Number of bytes free in database overflow pages. +</dl> +<h3>Queue Statistics</h3> +<p>In the case of a Queue database, +the statistics are stored in a structure of type DB_QUEUE_STAT. The +following fields will be filled in: +<p><dl compact> +<p><dt>u_int32_t qs_magic;<dd>Magic number that identifies the file as a Queue file. +<dt>u_int32_t qs_version;<dd>The version of the Queue file type. +<dt>u_int32_t qs_nkeys;<dd>The number of records in the database. +<dt>u_int32_t qs_ndata;<dd>The number of records in the database. +<dt>u_int32_t qs_pagesize;<dd>Underlying database page size. +<dt>u_int32_t qs_pages;<dd>Number of pages in the database. +<dt>u_int32_t qs_re_len;<dd>The length of the records. +<dt>u_int32_t qs_re_pad;<dd>The padding byte value for the records. +<dt>u_int32_t qs_pgfree;<dd>Number of bytes free in database pages. +<dt>u_int32_t qs_start;<dd>Start offset. +<dt>u_int32_t qs_first_recno;<dd>First undeleted record in the database. +<dt>u_int32_t qs_cur_recno;<dd>Last allocated record number in the database. +</dl> +<p>The DB->stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DB->stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->stat function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_sync.html b/bdb/docs/api_c/db_sync.html new file mode 100644 index 00000000000..6af624a88f3 --- /dev/null +++ b/bdb/docs/api_c/db_sync.html @@ -0,0 +1,98 @@ +<!--$Id: db_sync.so,v 10.20 2000/09/08 15:20:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->sync</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->sync</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->sync(DB *db, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->sync function flushes any cached information to disk. +<p>If the database is in memory only, the DB->sync function has no effect and +will always succeed. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>See <a href="../api_c/db_close.html">DB->close</a> for a discussion of Berkeley DB and cached data. +<p>The DB->sync function returns a non-zero error value on failure, 0 on success, and returns <a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> if the underlying database still has +dirty pages in the cache. (The only reason to return +<a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> is if another thread of control was writing pages +in the underlying database file at the same time as the +DB->sync function was being called. For this reason, a return of +<a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> can normally be ignored, or, in cases where it is +a possible return value, there may be no reason to call +DB->sync.) +<h1>Errors</h1> +<p>The DB->sync function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The DB->sync function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->sync function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_upgrade.html b/bdb/docs/api_c/db_upgrade.html new file mode 100644 index 00000000000..e31b4d447af --- /dev/null +++ b/bdb/docs/api_c/db_upgrade.html @@ -0,0 +1,135 @@ +<!--$Id: db_upgrade.so,v 10.18 2000/05/01 15:58:04 krinsky Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->upgrade</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->upgrade</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->upgrade(DB *db, const char *file, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->upgrade function upgrades all of the databases included in the +file <b>file</b>, if necessary. If no upgrade is necessary, +DB->upgrade always returns success. +<p><b>Database upgrades are done in place and are destructive, e.g., if pages +need to be allocated and no disk space is available, the database may be +left corrupted. Backups should be made before databases are upgraded. +See <a href="../ref/am/upgrade.html">Upgrading databases</a> for more +information.</b> +<p>Unlike all other database operations, DB->upgrade may only be done +on a system with the same byte-order as the database. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_DUPSORT">DB_DUPSORT</a><dd><b>This flag is only meaningful when upgrading databases from +releases before the Berkeley DB 3.1 release.</b> +<p>As part of the upgrade from the Berkeley DB 3.0 release to the 3.1 release, the +on-disk format of duplicate data items changed. To correctly upgrade the +format requires applications specify if duplicate data items in the +database are sorted or not. Specifying the DB_DUPSORT flag +informs DB->upgrade that the duplicates are sorted, otherwise they +are assumed to be unsorted. Incorrectly specifying the value of this flag +may lead to database corruption. +<p>Further, because the DB->upgrade function upgrades a physical file +(including all of the databases it contains), it is not possible to use +DB->upgrade to upgrade files where some of the databases it +includes have sorted duplicate data items and some of the databases it +includes have unsorted duplicate data items. If the file does not have +more than a single database, or the databases do not support duplicate +data items, or all of the databases that support duplicate data items +support the same style of duplicates (either sorted or unsorted), +DB->upgrade will work correctly as long as the DB_DUPSORT +flag is correctly specified. Otherwise, the file cannot be upgraded using +DB->upgrade, and must be upgraded manually by dumping and +re-loading the databases. +</dl> +<p>The DB->upgrade function returns a non-zero error value on failure and 0 on success. +<p>The DB->upgrade function is the underlying function used by the <a href="../utility/db_upgrade.html">db_upgrade</a> utility. +See the <a href="../utility/db_upgrade.html">db_upgrade</a> utility source code for an example of using DB->upgrade +in a IEEE/ANSI Std 1003.1 (POSIX) environment. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using +<a href="../api_c/env_open.html">DBENV->open</a> the environment variable <b>DB_HOME</b> may be used +as the path of the database environment home. Specifically, DB->upgrade +is affected by the configuration value DB_DATA_DIR. +</dl> +<h1>Errors</h1> +<p>The DB->upgrade function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The database is not in the same byte-order as the system. +</dl> +<p><dl compact> +<p><dt><a name="DB_OLD_VERSION">DB_OLD_VERSION</a><dd>The database cannot be upgraded by this version of the Berkeley DB software. +</dl> +<p>The DB->upgrade function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->upgrade function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/db_verify.html b/bdb/docs/api_c/db_verify.html new file mode 100644 index 00000000000..d011d90ab8d --- /dev/null +++ b/bdb/docs/api_c/db_verify.html @@ -0,0 +1,150 @@ +<!--$Id: db_verify.so,v 10.3 2000/04/11 15:13:51 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DB->verify</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DB->verify</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DB->verify(DB *db, const char *file, + const char *database, FILE *outfile, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DB->verify function verifies the integrity of all databases in the +file specified by the file argument, and optionally outputs the databases' +key/data pairs to a file stream. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_SALVAGE">DB_SALVAGE</a><dd>Write the key/data pairs from all databases in the file to the file stream +named in +the <b>outfile</b> argument. The output format is the same as that +specified for the <a href="../utility/db_dump.html">db_dump</a> utility and can be used as input for +the <a href="../utility/db_load.html">db_load</a> utility. +<p>Because the key/data pairs are output in page order as opposed to the sort +order used by <a href="../utility/db_dump.html">db_dump</a>, using DB->verify to dump key/data +pairs normally produces less than optimal loads for Btree databases. +</dl> +<p>In addition, the following flags may be set by bitwise inclusively <b>OR</b>'ing them into the +<b>flags</b> parameter: +<p><dl compact> +<p><dt><a name="DB_AGGRESSIVE">DB_AGGRESSIVE</a><dd>Output <b>all</b> the key/data pairs in the file that can be found. +By default, DB->verify does not assume corruption. For example, +if a key/data pair on a page is marked as deleted, it is not then written +to the output file. When DB_AGGRESSIVE is specified, corruption +is assumed, and any key/data pair that can be found is written. In this +case, key/data pairs that are corrupted or have been deleted may appear +in the output (even if the file being salvaged is in no way corrupt), and +the output will almost certainly require editing before being loaded into +a database. +<p><dt><a name="DB_NOORDERCHK">DB_NOORDERCHK</a><dd>Skip the database checks for btree and duplicate sort order and for +hashing. +<p>The DB->verify function normally verifies that btree keys and duplicate +items are correctly sorted and hash keys are correctly hashed. If the +file being verified contains multiple databases using differing sorting +or hashing algorithms, some of them must necessarily fail database +verification as only one sort order or hash function can be specified +before DB->verify is called. To verify files with multiple +databases having differing sorting orders or hashing functions, first +perform verification of the file as a whole by using the +DB_NOORDERCHK flag, and then individually verify the sort order +and hashing function for each database in the file using the +DB_ORDERCHKONLY flag. +<p><dt><a name="DB_ORDERCHKONLY">DB_ORDERCHKONLY</a><dd>Perform the database checks for btree and duplicate sort order and for +hashing, skipped by DB_NOORDERCHK. +<p>When this flag is specified, a <b>database</b> argument should also be +specified, indicating the database in the physical file which is to be +checked. This flag is only safe to use on databases that have already +successfully been verified using DB->verify with the +DB_NOORDERCHK flag set. +</dl> +<p>The database argument must be set to NULL except when the +DB_ORDERCHKONLY flag is set. +<p>The DB->verify function returns a non-zero error value on failure, 0 on success, and <a href="../ref/program/errorret.html#DB_VERIFY_BAD">DB_VERIFY_BAD</a> if a database is corrupted. When the +DB_SALVAGE flag is specified, the <a href="../ref/program/errorret.html#DB_VERIFY_BAD">DB_VERIFY_BAD</a> return +means that all key/data pairs in the file may not have been successfully +output. +<p>The DB->verify function is the underlying function used by the <a href="../utility/db_verify.html">db_verify</a> utility. +See the <a href="../utility/db_verify.html">db_verify</a> utility source code for an example of using DB->verify +in a IEEE/ANSI Std 1003.1 (POSIX) environment. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>If the <b>dbenv</b> argument to <a href="../api_c/db_create.html">db_create</a> was initialized using +<a href="../api_c/env_open.html">DBENV->open</a> the environment variable <b>DB_HOME</b> may be used +as the path of the database environment home. Specifically, DB->verify +is affected by the configuration value DB_DATA_DIR. +</dl> +<h1>Errors</h1> +<p>The DB->verify function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The DB->verify function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DB->verify function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/db_create.html">db_create</a>, +<a href="../api_c/db_close.html">DB->close</a>, +<a href="../api_c/db_cursor.html">DB->cursor</a>, +<a href="../api_c/db_del.html">DB->del</a>, +<a href="../api_c/db_err.html">DB->err</a>, +<a href="../api_c/db_fd.html">DB->fd</a>, +<a href="../api_c/db_get.html">DB->get</a>, +<a href="../api_c/db_get_byteswapped.html">DB->get_byteswapped</a>, +<a href="../api_c/db_get_type.html">DB->get_type</a>, +<a href="../api_c/db_join.html">DB->join</a>, +<a href="../api_c/db_key_range.html">DB->key_range</a>, +<a href="../api_c/db_open.html">DB->open</a>, +<a href="../api_c/db_put.html">DB->put</a>, +<a href="../api_c/db_remove.html">DB->remove</a>, +<a href="../api_c/db_set_bt_compare.html">DB->set_bt_compare</a>, +<a href="../api_c/db_set_bt_minkey.html">DB->set_bt_minkey</a>, +<a href="../api_c/db_set_bt_prefix.html">DB->set_bt_prefix</a>, +<a href="../api_c/db_set_cachesize.html">DB->set_cachesize</a>, +<a href="../api_c/db_set_dup_compare.html">DB->set_dup_compare</a>, +<a href="../api_c/db_set_errcall.html">DB->set_errcall</a>, +<a href="../api_c/db_set_errfile.html">DB->set_errfile</a>, +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a>, +<a href="../api_c/db_set_flags.html">DB->set_flags</a>, +<a href="../api_c/db_set_h_ffactor.html">DB->set_h_ffactor</a>, +<a href="../api_c/db_set_h_hash.html">DB->set_h_hash</a>, +<a href="../api_c/db_set_h_nelem.html">DB->set_h_nelem</a>, +<a href="../api_c/db_set_lorder.html">DB->set_lorder</a>, +<a href="../api_c/db_set_malloc.html">DB->set_malloc</a>, +<a href="../api_c/db_set_pagesize.html">DB->set_pagesize</a>, +<a href="../api_c/db_set_paniccall.html">DB->set_paniccall</a>, +<a href="../api_c/db_set_q_extentsize.html">DB->set_q_extentsize</a>, +<a href="../api_c/db_set_realloc.html">DB->set_realloc</a>, +<a href="../api_c/db_set_re_delim.html">DB->set_re_delim</a>, +<a href="../api_c/db_set_re_len.html">DB->set_re_len</a>, +<a href="../api_c/db_set_re_pad.html">DB->set_re_pad</a>, +<a href="../api_c/db_set_re_source.html">DB->set_re_source</a>, +<a href="../api_c/db_stat.html">DB->stat</a>, +<a href="../api_c/db_sync.html">DB->sync</a>, +<a href="../api_c/db_upgrade.html">DB->upgrade</a> +and +<a href="../api_c/db_verify.html">DB->verify</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbc_close.html b/bdb/docs/api_c/dbc_close.html new file mode 100644 index 00000000000..20eb28d953d --- /dev/null +++ b/bdb/docs/api_c/dbc_close.html @@ -0,0 +1,64 @@ +<!--$Id: dbc_close.so,v 10.20 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBcursor->c_close</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBcursor->c_close</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBcursor->c_close(DBC *cursor); +</pre></h3> +<h1>Description</h1> +<p>The DBcursor->c_close function discards the cursor. +<p>It is possible for the DBcursor->c_close function to return +<a href="../ref/program/errorret.html#DB_LOCK_DEADLOCK">DB_LOCK_DEADLOCK</a>, signaling that any enclosing transaction should +be aborted. If the application is already intending to abort the +transaction, this error should be ignored, and the application should +proceed. +<p>Once DBcursor->c_close has been called, regardless of its return, the +cursor handle may not be used again. +<p>The DBcursor->c_close function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DBcursor->c_close function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The cursor was previously closed. +</dl> +<p>The DBcursor->c_close function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBcursor->c_close function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/dbc_close.html">DBcursor->c_close</a>, +<a href="../api_c/dbc_count.html">DBcursor->c_count</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>, +<a href="../api_c/dbc_dup.html">DBcursor->c_dup</a>, +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> +and +<a href="../api_c/dbc_put.html">DBcursor->c_put</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbc_count.html b/bdb/docs/api_c/dbc_count.html new file mode 100644 index 00000000000..434a0ce8cbb --- /dev/null +++ b/bdb/docs/api_c/dbc_count.html @@ -0,0 +1,55 @@ +<!--$Id: dbc_count.so,v 10.4 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBcursor->c_count</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBcursor->c_count</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBC->c_count(DBC *cursor, db_recno_t *countp, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBcursor->c_count function returns a count of the number of duplicate data +items for the key referenced by the +cursor into the memory location referenced by <b>countp</b>. +If the underlying database does not support duplicate data items the call +will still succeed and a count of 1 will be returned. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>If the <b>cursor</b> argument is not yet initialized, the DBcursor->c_count function will return EINVAL. +<p>Otherwise, the DBcursor->c_count function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DBcursor->c_count function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBcursor->c_count function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/dbc_close.html">DBcursor->c_close</a>, +<a href="../api_c/dbc_count.html">DBcursor->c_count</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>, +<a href="../api_c/dbc_dup.html">DBcursor->c_dup</a>, +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> +and +<a href="../api_c/dbc_put.html">DBcursor->c_put</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbc_del.html b/bdb/docs/api_c/dbc_del.html new file mode 100644 index 00000000000..110d97471c8 --- /dev/null +++ b/bdb/docs/api_c/dbc_del.html @@ -0,0 +1,68 @@ +<!--$Id: dbc_del.so,v 10.23 2000/05/22 20:51:46 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBcursor->c_del</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBcursor->c_del</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBcursor->c_del(DBC *cursor, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBcursor->c_del function deletes the key/data pair currently referenced by +the cursor. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>The cursor position is unchanged after a delete, and subsequent calls to +cursor functions expecting the cursor to reference an existing key will +fail. +<p>If the element has already been deleted, DBcursor->c_del will return +<a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. +<p>If the cursor is not yet initialized, the DBcursor->c_del function will return EINVAL. +<p>Otherwise, the DBcursor->c_del function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DBcursor->c_del function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p><dl compact> +<p><dt>EPERM <dd>Write attempted on read-only cursor when the <a href="../api_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was +specified to <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<p>The DBcursor->c_del function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBcursor->c_del function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/dbc_close.html">DBcursor->c_close</a>, +<a href="../api_c/dbc_count.html">DBcursor->c_count</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>, +<a href="../api_c/dbc_dup.html">DBcursor->c_dup</a>, +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> +and +<a href="../api_c/dbc_put.html">DBcursor->c_put</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbc_dup.html b/bdb/docs/api_c/dbc_dup.html new file mode 100644 index 00000000000..42e3531ca04 --- /dev/null +++ b/bdb/docs/api_c/dbc_dup.html @@ -0,0 +1,72 @@ +<!--$Id: dbc_dup.so,v 10.8 2000/03/17 01:53:58 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBcursor->c_dup</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBcursor->c_dup</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBC->c_dup(DBC *cursor, DBC **cursorp, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBcursor->c_dup function creates a new cursor that uses the same transaction +and locker ID as the original cursor. This is useful when an application +is using locking and requires two or more cursors in the same thread of +control. +<p>The <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_POSITION">DB_POSITION</a><dd>The newly created cursor is initialized to reference the same position +in the database as the original cursor and hold the same locks. If the +DB_POSITION flag is not specified, then the created cursor is +uninitialized and will behave like a cursor newly created using +<a href="../api_c/db_cursor.html">DB->cursor</a>. +</dl> +<p>When using the Berkeley DB Concurrent Data Store product, there can be only one active write cursor +at a time. For this reason, attempting to duplicate a cursor for which +the <a href="../api_c/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> flag was specified during creation will return +an error. +<p>If the <b>cursor</b> argument is not yet initialized, the DBcursor->c_dup function will return EINVAL. +<p>Otherwise, the DBcursor->c_dup function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DBcursor->c_dup function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The <b>cursor</b> argument was created using the +<a href="../api_c/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> flag in the Berkeley DB Concurrent Data Store product. +</dl> +<p>The DBcursor->c_dup function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBcursor->c_dup function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/dbc_close.html">DBcursor->c_close</a>, +<a href="../api_c/dbc_count.html">DBcursor->c_count</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>, +<a href="../api_c/dbc_dup.html">DBcursor->c_dup</a>, +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> +and +<a href="../api_c/dbc_put.html">DBcursor->c_put</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbc_get.html b/bdb/docs/api_c/dbc_get.html new file mode 100644 index 00000000000..014661f33e7 --- /dev/null +++ b/bdb/docs/api_c/dbc_get.html @@ -0,0 +1,167 @@ +<!--$Id: dbc_get.so,v 10.46 2001/01/19 17:29:46 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBcursor->c_get</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBcursor->c_get</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBcursor->c_get(DBC *cursor, + DBT *key, DBT *data, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBcursor->c_get function retrieves key/data pairs from the database. The +address and length of the key +are returned in the object referenced by <b>key</b> (except for the case +of the DB_SET flag where the <b>key</b> object is unchanged), +and the address and length of +the data are returned in the object referenced by <b>data</b>. +<p>Modifications to the database during a sequential scan will be reflected +in the scan, i.e. records inserted behind a cursor will not be returned +while records inserted in front of a cursor will be returned. +<p>In Queue and Recno databases, missing entries (i.e., entries that were +never explicitly created or that were created and then deleted), will be +skipped during a sequential scan. +<p>If multiple threads or processes insert items into the same database file +without using locking, the results are undefined. +For more detail, +see <a href="../ref/am/stability.html">Cursor stability</a>. +<p>The <b>flags</b> parameter must be set to one of the following values: +<p><dl compact> +<p><dt><a name="DB_CURRENT">DB_CURRENT</a><dd>Return the key/data pair currently referenced by the cursor. +<p>If the cursor key/data pair was deleted, DBcursor->c_get will return +<a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. +<p>If the cursor is not yet initialized, the DBcursor->c_get function will return EINVAL. +<p><dt><a name="DB_FIRST">DB_FIRST</a>, <a name="DB_LAST">DB_LAST</a><dd>The cursor is set to reference the first (last) key/data pair of the +database, and that pair is returned. In the presence of duplicate key +values, the first (last) data item in the set of duplicates is returned. +<p>If the database is a Queue or Recno database, DBcursor->c_get using the +DB_FIRST (DB_LAST) flags will ignore any keys that exist +but were never explicitly created by the application or were created and +later deleted. +<p>If the database is empty, DBcursor->c_get will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_GET_BOTH">DB_GET_BOTH</a><dd>The DB_GET_BOTH flag is identical to the DB_SET flag, +except that both the key and the data arguments must be matched by the +key and data item in the database. +<p><dt><a name="DB_GET_RECNO">DB_GET_RECNO</a><dd>Return the record number associated with the cursor. The record number +will be returned in <b>data</b> as described in <a href="../api_c/dbt.html">DBT</a>. The +<b>key</b> parameter is ignored. +<p>For DB_GET_RECNO to be specified, the underlying database must be +of type Btree and it must have been created with the <a href="../api_c/db_set_flags.html#DB_RECNUM">DB_RECNUM</a> +flag. +<p><dt><a name="DB_JOIN_ITEM">DB_JOIN_ITEM</a><dd>Do not use the data value found in all of the cursors as a lookup key for +the primary database, but simply return it in the key parameter instead. +The data parameter is left unchanged. +<p>For DB_JOIN_ITEM to be specified, the underlying cursor must have +been returned from the <a href="../api_c/db_join.html">DB->join</a> function. +<p><dt><a name="DB_NEXT">DB_NEXT</a>, <a name="DB_PREV">DB_PREV</a><dd>If the cursor is not yet initialized, DB_NEXT (DB_PREV) +is identical to DB_FIRST (DB_LAST). Otherwise, the cursor +is moved to the next (previous) key/data pair of the database, and that +pair is returned. In the presence of duplicate key values, the value of +the key may not change. +<p>If the database is a Queue or Recno database, DBcursor->c_get using the +DB_NEXT (DB_PREV) flag will skip any keys that exist but +were never explicitly created by the application or were created and later +deleted. +<p>If the cursor is already on the last (first) record in the database, +DBcursor->c_get will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_NEXT_DUP">DB_NEXT_DUP</a><dd>If the next key/data pair of the database is a duplicate record for the +current key/data pair, the cursor is moved to the next key/data pair of +the database, and that pair is returned. Otherwise, DBcursor->c_get will +return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p>If the cursor is not yet initialized, the DBcursor->c_get function will return EINVAL. +<p><dt><a name="DB_NEXT_NODUP">DB_NEXT_NODUP</a>, <a name="DB_PREV_NODUP">DB_PREV_NODUP</a><dd>If the cursor is not yet initialized, DB_NEXT_NODUP +(DB_PREV_NODUP) is identical to DB_FIRST +(DB_LAST). Otherwise, the cursor is moved to the next (previous) +non-duplicate key/data pair of the database, and that pair is returned. +<p>If the database is a Queue or Recno database, DBcursor->c_get using the +DB_NEXT_NODUP (DB_PREV_NODUP) flags will ignore any keys +that exist but were never explicitly created by the application or were +created and later deleted. +<p>If no non-duplicate key/data pairs occur after (before) the cursor +position in the database, DBcursor->c_get will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_SET">DB_SET</a><dd>Move the cursor to the specified key/data pair of the database, and +return the datum associated with the given key. +<p>In the presence of duplicate key values, DBcursor->c_get will return the +first data item for the given key. +<p>If the database is a Queue or Recno database and the requested key exists, +but was never explicitly created by the application or was later deleted, +DBcursor->c_get will return <a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. +<p>If no matching keys are found, DBcursor->c_get will return +<a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_SET_RANGE">DB_SET_RANGE</a><dd>The DB_SET_RANGE flag is identical to the DB_SET flag, +except that the key is returned as well as the data item, and, in the case +of the Btree access method, the returned key/data pair is the smallest +key greater than or equal to the specified key (as determined by the +comparison function), permitting partial key matches and range +searches. +<p><dt><a name="DB_SET_RECNO">DB_SET_RECNO</a><dd>Move the cursor to the specific numbered record of the database, and +return the associated key/data pair. The <b>data</b> field of the +specified <b>key</b> +must be a pointer to a memory location from which a <a href="../api_c/dbt.html#db_recno_t">db_recno_t</a> +may be read, as described in <a href="../api_c/dbt.html">DBT</a>. This memory location will be +read to determine the record to be retrieved. +<p>For DB_SET_RECNO to be specified, the underlying database must be +of type Btree and it must have been created with the <a href="../api_c/db_set_flags.html#DB_RECNUM">DB_RECNUM</a> +flag. +</dl> +<p>In addition, the following flag may be set by bitwise inclusively <b>OR</b>'ing it into the +<b>flags</b> parameter: +<p><dl compact> +<p><dt><a name="DB_RMW">DB_RMW</a><dd>Acquire write locks instead of read locks when doing the retrieval. +Setting this flag may decrease the likelihood of deadlock during a +read-modify-write cycle by immediately acquiring the write lock during +the read part of the cycle so that another thread of control acquiring +a read lock for the same item, in its own read-modify-write cycle, will +not result in deadlock. +</dl> +<p>Otherwise, the DBcursor->c_get function returns a non-zero error value on failure and 0 on success. +<p>If DBcursor->c_get fails for any reason, the state of the cursor will be +unchanged. +<h1>Errors</h1> +<p>The DBcursor->c_get function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>There was insufficient memory to return the requested item. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The specified cursor was not currently initialized. +</dl> +<p>The DBcursor->c_get function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBcursor->c_get function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/dbc_close.html">DBcursor->c_close</a>, +<a href="../api_c/dbc_count.html">DBcursor->c_count</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>, +<a href="../api_c/dbc_dup.html">DBcursor->c_dup</a>, +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> +and +<a href="../api_c/dbc_put.html">DBcursor->c_put</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbc_put.html b/bdb/docs/api_c/dbc_put.html new file mode 100644 index 00000000000..9a8a0e8950a --- /dev/null +++ b/bdb/docs/api_c/dbc_put.html @@ -0,0 +1,154 @@ +<!--$Id: dbc_put.so,v 10.33 2000/12/04 17:02:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBcursor->c_put</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBcursor->c_put</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBcursor->c_put(DBC *, DBT *key, DBT *data, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBcursor->c_put function stores key/data pairs into the database. +<p>The <b>flags</b> parameter must be set to one of the following values: +<p><dl compact> +<p><dt><a name="DB_AFTER">DB_AFTER</a><dd>In the case of the Btree and Hash access methods, insert the data +element as a duplicate element of the key referenced by the cursor. +The new element appears immediately after the current cursor position. +It is an error to specify DB_AFTER if the underlying Btree or +Hash database does not support duplicate data items. The <b>key</b> +parameter is ignored. +<p>In the case of the Recno access method, it is an error to specify +DB_AFTER if the underlying Recno database was not created with +the <a href="../api_c/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag. If the <a href="../api_c/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag was +specified, a new key is created, all records after the inserted item +are automatically renumbered, and the key of the new record is returned +in the structure referenced by the parameter <b>key</b>. The initial +value of the <b>key</b> parameter is ignored. See <a href="../api_c/db_open.html">DB->open</a> +for more information. +<p>The DB_AFTER flag may not be specified to the Queue access method. +<p>If the current cursor record has already been deleted and the underlying +access method is Hash, DBcursor->c_put will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +If the underlying access method is Btree or Recno, the operation will +succeed. +<p>If the cursor is not yet initialized or a duplicate sort function has been +specified, the DBcursor->c_put function will return EINVAL. +<p><dt><a name="DB_BEFORE">DB_BEFORE</a><dd>In the case of the Btree and Hash access methods, insert the data element +as a duplicate element of the key referenced by the cursor. The new +element appears immediately before the current cursor position. It is +an error to specify DB_BEFORE if the underlying Btree or Hash +database does not support duplicate data items. The <b>key</b> +parameter is ignored. +<p>In the case of the Recno access method, it is an error to specify +DB_BEFORE if the underlying Recno database was not created with +the <a href="../api_c/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag. If the <a href="../api_c/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag was +specified, a new key is created, the current record and all records +after it are automatically renumbered, and the key of the new record is +returned in the structure referenced by the parameter <b>key</b>. The +initial value of the <b>key</b> parameter is ignored. See +<a href="../api_c/db_open.html">DB->open</a> for more information. +<p>The DB_BEFORE flag may not be specified to the Queue access method. +<p>If the current cursor record has already been deleted and the underlying +access method is Hash, DBcursor->c_put will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +If the underlying access method is Btree or Recno, the operation will +succeed. +<p>If the cursor is not yet initialized or a duplicate sort function has been +specified, DBcursor->c_put will return EINVAL. +<p><dt><a name="DB_CURRENT">DB_CURRENT</a><dd>Overwrite the data of the key/data pair referenced by the cursor with the +specified data item. The <b>key</b> parameter is ignored. +<p>If a duplicate sort function has been specified and the data item of the +current referenced key/data pair does not compare equally to the <b>data</b> +parameter, DBcursor->c_put will return EINVAL. +<p>If the current cursor record has already been deleted and the underlying +access method is Hash, DBcursor->c_put will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +If the underlying access method is Btree, Queue or Recno, the operation +will succeed. +<p>If the cursor is not yet initialized, DBcursor->c_put will return EINVAL. +<p><dt><a name="DB_KEYFIRST">DB_KEYFIRST</a><dd>In the case of the Btree and Hash access methods, insert the specified +key/data pair into the database. +<p>If the underlying database supports duplicate data items, and if the +key already exists in the database and a duplicate sort function has +been specified, the inserted data item is added in its sorted location. +If the key already exists in the database and no duplicate sort function +has been specified, the inserted data item is added as the first of the +data items for that key. +<p>The DB_KEYFIRST flag may not be specified to the Queue or Recno +access methods. +<p><dt><a name="DB_KEYLAST">DB_KEYLAST</a><dd>In the case of the Btree and Hash access methods, insert the specified +key/data pair into the database. +<p>If the underlying database supports duplicate data items, and if the +key already exists in the database and a duplicate sort function has +been specified, the inserted data item is added in its sorted location. +If the key already exists in the database, and no duplicate sort +function has been specified, the inserted data item is added as the last +of the data items for that key. +<p>The DB_KEYLAST flag may not be specified to the Queue or Recno +access methods. +<p><dt><a name="DB_NODUPDATA">DB_NODUPDATA</a><dd>In the case of the Btree and Hash access methods, insert the specified +key/data pair into the database unless it already exists in the database. +If the key/data pair already appears in the database, <a href="../api_c/dbc_put.html#DB_KEYEXIST">DB_KEYEXIST</a> +is returned. The DB_NODUPDATA flag may only be specified if +the underlying database has been configured to support sorted duplicate +data items. +<p>The DB_NODUPDATA flag may not be specified to the Queue or Recno +access methods. +</dl> +<p>Otherwise, the DBcursor->c_put function returns a non-zero error value on failure and 0 on success. +<p>If DBcursor->c_put fails for any reason, the state of the cursor will be +unchanged. If DBcursor->c_put succeeds and an item is inserted into the +database, the cursor is always positioned to reference the newly inserted +item. +<h1>Errors</h1> +<p>The DBcursor->c_put function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EACCES<dd>An attempt was made to modify a read-only database. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The DB_BEFORE or DB_AFTER flags were specified, and the +underlying access method is Queue. +<p>An attempt was made to add a record to a fixed-length database that was too +large to fit. +</dl> +<p><dl compact> +<p><dt>EPERM <dd>Write attempted on read-only cursor when the <a href="../api_c/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was +specified to <a href="../api_c/env_open.html">DBENV->open</a>. +</dl> +<p>The DBcursor->c_put function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBcursor->c_put function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/dbc_close.html">DBcursor->c_close</a>, +<a href="../api_c/dbc_count.html">DBcursor->c_count</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>, +<a href="../api_c/dbc_dup.html">DBcursor->c_dup</a>, +<a href="../api_c/dbc_get.html">DBcursor->c_get</a> +and +<a href="../api_c/dbc_put.html">DBcursor->c_put</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbm.html b/bdb/docs/api_c/dbm.html new file mode 100644 index 00000000000..783d59e6271 --- /dev/null +++ b/bdb/docs/api_c/dbm.html @@ -0,0 +1,220 @@ +<!--$Id: dbm.so,v 10.18 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: dbm/ndbm</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>dbm/ndbm</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#define DB_DBM_HSEARCH 1 +#include <db.h> +<p> +typedef struct { + char *dptr; + int dsize; +} datum; +<hr size=1 noshade> +<h3>Dbm Functions</h3> +int +dbminit(char *file); +<p> +int +dbmclose(); +<p> +datum +fetch(datum key); +<p> +int +store(datum key, datum content); +<p> +int +delete(datum key); +<p> +datum +firstkey(void); +<p> +datum +nextkey(datum key); +<hr size=1 noshade> +<h3>Ndbm Functions</h3> +DBM * +dbm_open(char *file, int flags, int mode); +<p> +void +dbm_close(DBM *db); +<p> +datum +dbm_fetch(DBM *db, datum key); +<p> +int +dbm_store(DBM *db, datum key, datum content, int flags); +<p> +int +dbm_delete(DBM *db, datum key); +<p> +datum +dbm_firstkey(DBM *db); +<p> +datum +dbm_nextkey(DBM *db); +<p> +int +dbm_error(DBM *db); +<p> +int +dbm_clearerr(DBM *db); +</pre></h3> +<h1>Description</h1> +<p>The dbm interfaces to the Berkeley DB library are intended to provide +high-performance implementations and source code compatibility for +applications written to historic interfaces. They are not recommended +for any other purpose. The historic dbm database format +<b>is not supported</b>, and databases previously built using the real +dbm libraries cannot be read by the Berkeley DB functions. +<p>To compile dbm applications, replace the application's +<b>#include</b> of the dbm or ndbm include file (e.g., +<b>#include <dbm.h></b> or <b>#include <ndbm.h></b>) +with the following two lines: +<p><blockquote><pre>#define DB_DBM_HSEARCH 1 +#include <db.h></pre></blockquote> +<p>and recompile. If the application attempts to load against a dbm library +(e.g., <b>-ldbm</b>), remove the library from the load line. +<p><b>Key</b> and <b>content</b> arguments are objects described by the +<b>datum</b> typedef. A <b>datum</b> specifies a string of +<b>dsize</b> bytes pointed to by <b>dptr</b>. Arbitrary binary data, +as well as normal text strings, is allowed. +<h3>Dbm Functions</h3> +<p>Before a database can be accessed, it must be opened by dbminit. +This will open and/or create the database <b>file</b>.db. If created, +the database file is created read/write by owner only (as described in +<b>chmod</b>(2) and modified by the process' umask value at the time +of creation (see <b>umask</b>(2)). The group ownership of created +files is based on the system and directory defaults, and is not further +specified by Berkeley DB. +<p>A database may be closed, and any held resources released, by calling +dbmclose. +<p>Once open, the data stored under a key is accessed by fetch and +data is placed under a key by store. A key (and its associated +contents) is deleted by delete. A linear pass through all keys +in a database may be made, in an (apparently) random order, by use of +firstkey and nextkey. The firstkey function will return +the first key in the database. The nextkey function will return the next +key in the database. +<p>The following code will traverse the data base: +<p><blockquote><pre>for (key = firstkey(); + key.dptr != NULL; key = nextkey(key)) { + ... +}</pre></blockquote> +<h3>Ndbm Functions</h3> +<p>Before a database can be accessed, it must be opened by dbm_open. +This will open and/or create the database file <b>file.db</b> depending +on the flags parameter (see <b>open</b>(2)). If created, the database +file is created with mode <b>mode</b> (as described in <b>chmod</b>(2)) and modified by the process' umask value at the time of creation (see +<b>umask</b>(2)). The group ownership of created files is based on +the system and directory defaults, and is not further specified by +Berkeley DB. +<p>Once open, the data stored under a key is accessed by dbm_fetch +and data is placed under a key by dbm_store. The <b>flags</b> +field can be either <b>DBM_INSERT</b> or <b>DBM_REPLACE</b>. +<b>DBM_INSERT</b> will only insert new entries into the database and will +not change an existing entry with the same key. <b>DBM_REPLACE</b> will +replace an existing entry if it has the same key. A key (and its +associated contents) is deleted by dbm_delete. A linear pass +through all keys in a database may be made, in an (apparently) random +order, by use of dbm_firstkey and dbm_nextkey. The +dbm_firstkey function will return the first key in the database. The +dbm_nextkey function will return the next key in the database. +<p>The following code will traverse the data base: +<p><blockquote><pre>for (key = dbm_firstkey(db); + key.dptr != NULL; key = dbm_nextkey(db)) { + ... +}</pre></blockquote> +<h3>Compatibility Notes</h3> +<p>The historic dbm library created two underlying database files, +traditionally named <b>file.dir</b> and <b>file.pag</b>. The Berkeley DB +library creates a single database file named <b>file.db</b>. +Applications that are aware of the underlying database file names may +require additional source code modifications. +<p>The historic dbminit interface required that the underlying +<b>.dir</b> and <b>.pag</b> files already exist (empty databases were +created by first manually creating zero-length <b>.dir</b> and +<b>.pag</b> files). Applications that expect to create databases using +this method may require additional source code modifications. +<p>The historic dbm_dirfno and dbm_pagfno macros are +supported, but will return identical file descriptors as there is only a +single underlying file used by the Berkeley DB hashing access method. +Applications using both file descriptors for locking may require +additional source code modifications. +<p>If applications using the dbm interface exits without first +closing the database, it may lose updates because the Berkeley DB library +buffers writes to underlying databases. Such applications will require +additional source code modifications to work correctly with the Berkeley DB +library. +<h3>Dbm Diagnostics</h3> +<p>The dbminit function returns -1 on failure, setting <b>errno</b>, +and 0 on success. +<p>The fetch function sets the <b>dptr</b> field of the returned +<b>datum</b> to NULL on failure, setting <b>errno</b>, +and returns a non-NULL <b>dptr</b> on success. +<p>The store function returns -1 on failure, setting <b>errno</b>, +and 0 on success. +<p>The delete function returns -1 on failure, setting <b>errno</b>, +and 0 on success. +<p>The firstkey function sets the <b>dptr</b> field of the returned +<b>datum</b> to NULL on failure, setting <b>errno</b>, +and returns a non-NULL <b>dptr</b> on success. +<p>The nextkey function sets the <b>dptr</b> field of the returned +<b>datum</b> to NULL on failure, setting <b>errno</b>, +and returns a non-NULL <b>dptr</b> on success. +<h1>Errors</h1> +<p>The dbminit, fetch, store, delete, firstkey and nextkey functions may fail +and return a non-zero error for errors specified for other Berkeley DB and C +library or system functions. +<h3>Ndbm Diagnostics</h3> +<p>The dbm_close function returns non-zero when an error has occurred reading or +writing the database. +<p>The dbm_close function resets the error condition on the named database. +<p>The dbm_open function returns NULL on failure, setting <b>errno</b>, +and 0 on success. +<p>The dbm_fetch function sets the <b>dptr</b> field of the returned +<b>datum</b> to NULL on failure, setting <b>errno</b>, +and returns a non-NULL <b>dptr</b> on success. +<p>The dbm_store function returns -1 on failure, setting <b>errno</b>, +0 on success, and 1 if DBM_INSERT was set and the specified key already +existed in the database. +<p>The dbm_delete function returns -1 on failure, setting <b>errno</b>, +and 0 on success. +<p>The dbm_firstkey function sets the <b>dptr</b> field of the returned +<b>datum</b> to NULL on failure, setting <b>errno</b>, +and returns a non-NULL <b>dptr</b> on success. +<p>The dbm_nextkey function sets the <b>dptr</b> field of the returned +<b>datum</b> to NULL on failure, setting <b>errno</b>, +and returns a non-NULL <b>dptr</b> on success. +<p>The dbm_close function returns -1 on failure, setting <b>errno</b>, +and 0 on success. +<p>The dbm_close function returns -1 on failure, setting <b>errno</b>, +and 0 on success. +<h1>Errors</h1> +<p>The dbm_open, dbm_close, dbm_fetch, dbm_store, dbm_delete, dbm_firstkey +and dbm_nextkey functions may fail and return a non-zero error for errors +specified for other Berkeley DB and C library or system functions. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/dbt.html b/bdb/docs/api_c/dbt.html new file mode 100644 index 00000000000..a0c3e76db8d --- /dev/null +++ b/bdb/docs/api_c/dbt.html @@ -0,0 +1,158 @@ +<!--$Id: dbt.so,v 10.37 2000/12/18 21:05:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<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> +<tt> + <a name="2"><!--meow--></a> +<h3>Key/Data Pairs</h3> +<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 DBT 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 reference strings of +zero length up to strings of essentially unlimited length. See +<a href="../ref/program/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 +0 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 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 referenced by the pointer 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 (referenced by <b>data</b>), 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. As any allocated memory becomes the +responsibility of the calling application, the caller must be able to +determine if memory was allocated. +<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. As any allocated memory becomes the +responsibility of the calling application, the caller must be able to +determine if memory was allocated. +<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 reference +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 referenced by the <b>data</b> field. +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 the existing bytes +or nul 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 reference 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, +and 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> + <a name="3"><!--meow--></a> <a name="4"><!--meow--></a> +<h3>Retrieved key/data permanence</h3> +<p>When using the non-cursor Berkeley DB calls to retrieve key/data items (e.g., +<a href="../api_c/db_get.html">DB->get</a>), the memory referenced by the pointer stored into the +Dbt is only valid until the next call to Berkeley DB using the Db +handle returned by <a href="../api_c/db_open.html">DB->open</a>. (This includes <b>any</b> use of +the returned Db handle, including by another thread of control +within the process. For this reason, when multiple threads are using the +returned Db handle concurrently, one of the DB_DBT_MALLOC, +DB_DBT_REALLOC or DB_DBT_USERMEM flags must be specified +with any non-cursor Dbt used for key or data retrieval.) +<p>When using the cursor Berkeley DB calls to retrieve key/data items (e.g., +<a href="../api_c/dbc_get.html">DBcursor->c_get</a>), the memory referenced by the pointer into the +Dbt is only valid until the next call to Berkeley DB using the +DBC handle returned by <a href="../api_c/db_cursor.html">DB->cursor</a>. + <a name="5"><!--meow--></a> +<h3>Data alignment</h3> +<p>The Berkeley DB access methods provide no guarantees about key/data byte string +alignment, and applications are responsible for arranging any necessary +alignment. The DB_DBT_MALLOC, DB_DBT_REALLOC and +DB_DBT_USERMEM flags may be used to store returned items in memory +of arbitrary alignment. + <a name="6"><!--meow--></a> +<h3>Logical Record Numbers</h3> +<p>In all cases for the Queue and Recno access methods, and when calling the +<a href="../api_c/db_get.html">DB->get</a> and <a href="../api_c/dbc_get.html">DBcursor->c_get</a> functions with the +<a href="../api_c/db_get.html#DB_SET_RECNO">DB_SET_RECNO</a> flag specified, the <b>data</b> field of the key +must be a pointer to a memory location of type <b>db_recno_t</b>, as +typedef'd in the #include <db.h> include file. This type is a 32-bit +unsigned type, (which limits the number of logical records in a Queue or +Recno database, and the maximum logical record which may be directly +retrieved from a Btree database, to 4,294,967,296). The <b>size</b> +field of the key should be the size of that type, i.e., in the C +programming language, <b>sizeof(db_recno_t)</b>. +<p>Logical record numbers are 1-based, not 0-based, i.e., the first record +in the database is record number 1. +</tt> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_close.html b/bdb/docs/api_c/env_close.html new file mode 100644 index 00000000000..fdb11e2e18c --- /dev/null +++ b/bdb/docs/api_c/env_close.html @@ -0,0 +1,84 @@ +<!--$Id: env_close.so,v 10.21 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->close</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->close</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->close(DB_ENV *dbenv, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBENV->close function closes the Berkeley DB environment, freeing any +allocated resources and closing any underlying subsystems. +<p>Calling DBENV->close does not imply closing any databases that were +opened in the environment. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>Where the environment was initialized with the <a href="../api_c/env_open.html#DB_INIT_LOCK">DB_INIT_LOCK</a> flag, +calling DBENV->close does not release any locks still held by the +closing process, providing functionality for long-lived locks. +Processes that wish to have all their locks +released can do so by issuing the appropriate <a href="../api_c/lock_vec.html">lock_vec</a> call. +<p>Where the environment was initialized with the <a href="../api_c/env_open.html#DB_INIT_MPOOL">DB_INIT_MPOOL</a> +flag, calling DBENV->close implies calls to <a href="../api_c/memp_fclose.html">memp_fclose</a> for +any remaining open files in the memory pool that were returned to this +process by calls to <a href="../api_c/memp_fopen.html">memp_fopen</a>. It does not imply a call to +<a href="../api_c/memp_fsync.html">memp_fsync</a> for those files. +<p>Where the environment was initialized with the <a href="../api_c/env_open.html#DB_INIT_TXN">DB_INIT_TXN</a> flag, +calling DBENV->close aborts any uncommitted transactions. +(Applications are should not depend on this behavior. If the process' has +already closed a database handle which is necessary to abort an +uncommitted transaction, the Berkeley DB environment must then require that +recovery be run before further operations are done, since once a +transaction exists that cannot be committed or aborted, no future +checkpoint can ever succeed.) +<p>In multi-threaded applications, only a single thread may call +DBENV->close. +<p>Once DBENV->close has been called, regardless of its return, +the Berkeley DB environment handle may not be accessed again. +<p>The DBENV->close function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The DBENV->close function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBENV->close function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_create.html b/bdb/docs/api_c/env_create.html new file mode 100644 index 00000000000..26ffb204ef2 --- /dev/null +++ b/bdb/docs/api_c/env_create.html @@ -0,0 +1,74 @@ +<!--$Id: env_create.so,v 10.12 2000/10/25 18:51:08 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_create</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_create</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_create(DB_ENV **dbenvp, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The db_env_create function creates a DB_ENV structure which is +the handle for a Berkeley DB environment. A pointer to this structure is +returned in the memory referenced by <b>dbenvp</b>. +<p>The <b>flags</b> parameter must be set to 0 or the following value: +<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_c/env_set_server.html">DBENV->set_server</a> function to establish the +connection to the server. +</dl> +<p>The DB_ENV handle contains a special field, "app_private", which +is declared as type "void *". This field is provided for the use of +the application program. It is initialized to NULL and is not further +used by Berkeley DB in any way. +<p>The db_env_create function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The db_env_create function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the db_env_create function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_open.html b/bdb/docs/api_c/env_open.html new file mode 100644 index 00000000000..677f40c1591 --- /dev/null +++ b/bdb/docs/api_c/env_open.html @@ -0,0 +1,205 @@ +<!--$Id: env_open.so,v 10.61 2000/12/01 15:50:31 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->open</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->open</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->open(DB_ENV *, char *db_home, u_int32_t flags, int mode); +</pre></h3> +<h1>Description</h1> +<p>The DBENV->open function is the interface for opening the Berkeley DB +environment. It provides a structure for creating a consistent +environment for processes using one or more of the features of Berkeley DB. +<p>The <b>db_home</b> argument to DBENV->open (and file name +resolution in general) is described in +<a href="../ref/env/naming.html">Berkeley DB File Naming</a>. +<p>The <b>flags</b> argument specifies the subsystems that are initialized +and how the application's environment affects Berkeley DB file naming, among +other things. +<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>As there are a large number of flags that can be specified, they have been +grouped together by functionality. The first group of flags indicate +which of the Berkeley DB subsystems should be initialized: +<p><dl compact> +<p><dt><a name="DB_JOINENV">DB_JOINENV</a><dd>Join an existing environment. This option allows applications to +join an existing environment without knowing which Berkeley DB subsystems +the environment supports. +<p><dt><a name="DB_INIT_CDB">DB_INIT_CDB</a><dd>Initialize locking for the <a href="../ref/cam/intro.html">Berkeley DB Concurrent Data Store</a> +product. In this mode, Berkeley DB provides multiple reader/single writer +access. The only other subsystem that should be specified with the +DB_INIT_CDB flag is DB_INIT_MPOOL. +<p>Access method calls are largely unchanged when using this flag, although +any cursors through which update operations (e.g., <a href="../api_c/dbc_put.html">DBcursor->c_put</a>, +<a href="../api_c/dbc_del.html">DBcursor->c_del</a>) will be made must have the <a href="../api_c/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> value +set in the flags parameter to the cursor call that creates the cursor. +See <a href="../api_c/db_cursor.html">DB->cursor</a> for more information. +<p><dt><a name="DB_INIT_LOCK">DB_INIT_LOCK</a><dd>Initialize the locking subsystem. This subsystem should be used when +multiple processes or threads are going to be reading and writing a Berkeley DB +database, so that they do not interfere with each other. If all threads +are accessing the database(s) read-only, then locking is unnecessary. +When the DB_INIT_LOCK flag is specified, it is usually necessary to run +the deadlock detector, as well. See <a href="../utility/db_deadlock.html">db_deadlock</a> and +<a href="../api_c/lock_detect.html">lock_detect</a> for more information. +<p><dt><a name="DB_INIT_LOG">DB_INIT_LOG</a><dd>Initialize the logging subsystem. This subsystem is used when recovery +from application or system failure is necessary. +<p>The log is stored in one or more files in the environment directory. +Each file is named using the format <i>log.NNNNNNNNNN</i>, where +<i>NNNNNNNNNN</i> is the sequence number of the file within the log. +For further information, see +<a href="../ref/log/limits.html">Log File Limits</a>. +<p>If the log region is being created and log files are already present, the +log files are reviewed and subsequent log writes are appended +to the end of the log, rather than overwriting current log entries. +<p><dt><a name="DB_INIT_MPOOL">DB_INIT_MPOOL</a><dd>Initialize the shared memory buffer pool subsystem. This subsystem is +used whenever the application is using any Berkeley DB access method. +<p><dt><a name="DB_INIT_TXN">DB_INIT_TXN</a><dd>Initialize the transaction subsystem. This subsystem is used when +recovery and atomicity of multiple operations and recovery are important. +The DB_INIT_TXN flag implies the DB_INIT_LOG flag. +</dl> +<p>The second group of flags govern what recovery, if any, is performed when +the environment is initialized: +<p><dl compact> +<p><dt><a name="DB_RECOVER">DB_RECOVER</a><dd>Run normal recovery on this environment before opening it for normal use. +If this flag is set, the DB_CREATE flag must also be set since the regions +will be removed and recreated. +<p><dt><a name="DB_RECOVER_FATAL">DB_RECOVER_FATAL</a><dd>Run catastrophic recovery on this environment before opening it for normal +use. If this flag is set, the DB_CREATE flag must also be set since the +regions will be removed and recreated. +</dl> +<p>A standard part of the recovery process is to remove the existing Berkeley DB +environment and create a new one in which to perform recovery. If the +thread of control performing recovery does not specify the correct region +initialization information (e.g., the correct memory pool cache size), +the result can be an application running in an environment with incorrect +cache and other subsystem sizes. For this reason, the thread of control +performing recovery should either specify correct configuration +information before calling the DBENV->open function, or it should remove +the environment after recovery is completed, leaving creation of the +correctly sized environment to a subsequent call to DBENV->open. +<p>All Berkeley DB recovery processing must be single-threaded, that is, only a +single thread of control may perform recovery or access a Berkeley DB +environment while recovery is being performed. As it is not an error to +specify DB_RECOVER for an environment for which no recovery is +required, it is reasonable programming practice for the thread of control +responsible for performing recovery and creating the environment to always +specify the DB_RECOVER flag during startup. +<p>The DBENV->open function returns successfully if DB_RECOVER +or DB_RECOVER_FATAL is specified and no log files exist, so it is +necessary to ensure all necessary log files are present before running +recovery. For further information, consult <a href="../utility/db_archive.html">db_archive</a> and +<a href="../utility/db_recover.html">db_recover</a>. +<p>The third group of flags govern file naming extensions in the environment: +<p><dl compact> +<!--$Id: m4.env_flags,v 10.9 2000/06/29 22:54:10 bostic Exp $--> +<p><dt><a name="DB_USE_ENVIRON">DB_USE_ENVIRON</a><dd>The Berkeley DB process' environment may be permitted to specify information to +be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB +File Naming</a>. As permitting users to specify which files are used can +create security problems, environment information will be used in file +naming for all users only if the DB_USE_ENVIRON flag is set. +<p><dt><a name="DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a><dd>The Berkeley DB process' environment may be permitted to specify information to +be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB +File Naming</a>. As permitting users to specify which files are used can +create security problems, if the DB_USE_ENVIRON_ROOT flag is set, +environment information will be used for file naming only for users with +appropriate permissions (e.g., on UNIX systems, users with a user-ID of 0). +</dl> +<p>Finally, there are a few additional, unrelated flags: +<p><dl compact> +<p><dt><a name="DB_CREATE">DB_CREATE</a><dd>Cause Berkeley DB subsystems to create any underlying files, as necessary. +<p><dt><a name="DB_LOCKDOWN">DB_LOCKDOWN</a><dd>Lock shared Berkeley DB environment files and memory mapped databases into memory. +<p><dt><a name="DB_PRIVATE">DB_PRIVATE</a><dd>Specify that the environment will only be accessed by a single process +(although that process may be multi-threaded). This flag has two effects +on the Berkeley DB environment. First, all underlying data structures are +allocated from per-process memory instead of from shared memory that is +potentially accessible to more than a single process. Second, mutexes +are only configured to work between threads. +<p>This flag should not be specified if more than a single process is +accessing the environment, as it is likely to cause database corruption +and unpredictable behavior, e.g., if both a server application and the +Berkeley DB utility <a href="../utility/db_stat.html">db_stat</a> will access the environment, the +DB_PRIVATE flag should not be specified. +<p><dt><a name="DB_SYSTEM_MEM">DB_SYSTEM_MEM</a><dd>Allocate memory from system shared memory instead of from memory backed +by the filesystem. See <a href="../ref/env/region.html">Shared Memory +Regions</a> for more information. +<p><dt><a name="DB_THREAD">DB_THREAD</a><dd>Cause the DB_ENV handle returned by DBENV->open to be +<i>free-threaded</i>, that is, useable by multiple threads within a +single address space. +</dl> +<p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by Berkeley DB +are created with mode <b>mode</b> (as described in <b>chmod</b>(2)) and +modified by the process' umask value at the time of creation (see +<b>umask</b>(2)). The group ownership of created files is based on +the system and directory defaults, and is not further specified by Berkeley DB. +If <b>mode</b> is 0, files are created readable and writeable by both +owner and group. On Windows systems, the mode argument is ignored. +<p>The DBENV->open function returns a non-zero error value on failure and 0 on success. +<h1>Environment Variables</h1> +<p><dl compact> +<p><dt>DB_HOME<dd>The environment variable <b>DB_HOME</b> may be used as the path of +the database home as described in +<a href="../ref/env/naming.html">Berkeley DB File Naming</a>. +</dl> +<h1>Errors</h1> +<p>The DBENV->open function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EAGAIN<dd>The shared memory region was locked and (repeatedly) unavailable. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p> +The DB_THREAD flag was specified and spinlocks are not +implemented for this architecture. +<p>The DB_HOME or TMPDIR environment variables were set but empty. +<p>An incorrectly formatted <b>NAME VALUE</b> entry or line was found. +</dl> +<p><dl compact> +<p><dt>ENOSPC<dd>HP-UX only: a previously created Berkeley DB environment for this process still +exists. +</dl> +<p>The DBENV->open function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBENV->open function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_remove.html b/bdb/docs/api_c/env_remove.html new file mode 100644 index 00000000000..2d7279d79ab --- /dev/null +++ b/bdb/docs/api_c/env_remove.html @@ -0,0 +1,125 @@ +<!--$Id: env_remove.so,v 10.24 2000/12/06 14:40:11 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->remove</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->remove</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->remove(DB_ENV *, char *db_home, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The DBENV->remove function destroys a Berkeley DB environment, if it is not +currently in use. The environment regions, including any backing files, +are removed. Any log or database files and the environment directory are +not removed. +<p>The <b>db_home</b> argument to DBENV->remove is described in +<a href="../ref/env/naming.html">Berkeley DB File Naming</a>. +<p>If there are processes that have called <a href="../api_c/env_open.html">DBENV->open</a> without +calling <a href="../api_c/env_close.html">DBENV->close</a> (i.e., there are processes currently using +the environment), DBENV->remove will fail without further action, +unless the <a href="../api_c/env_remove.html#DB_FORCE">DB_FORCE</a> flag is set, in which case +DBENV->remove will attempt to remove the environment regardless +of any processes still using it. +<p>The result of attempting to forcibly destroy the environment when it is +in use is unspecified. Processes using an environment often maintain open +file descriptors for shared regions within it. On UNIX systems, the +environment removal will usually succeed and processes that have already +joined the region will continue to run in that region without change, +however processes attempting to join the environment will either fail or +create new regions. On other systems (e.g., Windows/NT), where the +<b>unlink</b>(2) system call will fail if any process has an open +file descriptor for the file, the region removal will fail. +<p>Calling DBENV->remove should not be necessary for most applications, +as the Berkeley DB environment is cleaned up as part of normal database recovery +procedures, however, applications may wish to call DBENV->remove +as part of application shutdown to free up system resources. +Specifically, when the <a href="../api_c/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a> flag was specified to +<a href="../api_c/env_open.html">DBENV->open</a>, it may be useful to call DBENV->remove in order +to release system shared memory segments that have been allocated. +<p>In the case of catastrophic or system failure, database recovery must be +performed (see <a href="../utility/db_recover.html">db_recover</a>), or the <a href="../api_c/env_open.html#DB_RECOVER">DB_RECOVER</a> and +<a href="../api_c/env_open.html#DB_RECOVER_FATAL">DB_RECOVER_FATAL</a> flags to <a href="../api_c/env_open.html">DBENV->open</a> must be specified +when the environment is re-opened. Alternatively, if recovery is not +required because no database state is maintained across failures, and +the <a href="../api_c/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a> flag was not specified when the environment +was created, it is possible to clean up an environment by removing all +of the files in the environment directory that begin with the string +prefix "__db", as no backing files are created in any other directory. +<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_FORCE">DB_FORCE</a><dd>If the <a href="../api_c/env_remove.html#DB_FORCE">DB_FORCE</a> flag is set, the environment is removed regardless +of any processes that may still using it, and, no locks are acquired +during this process. (Generally, the <a href="../api_c/env_remove.html#DB_FORCE">DB_FORCE</a> flag is only +specified when applications were unable to shut down cleanly, and there +is a risk that an application may have died holding a Berkeley DB lock.) +<!--$Id: m4.env_flags,v 10.9 2000/06/29 22:54:10 bostic Exp $--> +<p><dt><a name="DB_USE_ENVIRON">DB_USE_ENVIRON</a><dd>The Berkeley DB process' environment may be permitted to specify information to +be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB +File Naming</a>. As permitting users to specify which files are used can +create security problems, environment information will be used in file +naming for all users only if the DB_USE_ENVIRON flag is set. +<p><dt><a name="DB_USE_ENVIRON_ROOT">DB_USE_ENVIRON_ROOT</a><dd>The Berkeley DB process' environment may be permitted to specify information to +be used when naming files; see <a href="../ref/env/naming.html">Berkeley DB +File Naming</a>. As permitting users to specify which files are used can +create security problems, if the DB_USE_ENVIRON_ROOT flag is set, +environment information will be used for file naming only for users with +appropriate permissions (e.g., on UNIX systems, users with a user-ID of 0). +</dl> +<p>In multi-threaded applications, only a single thread may call +DBENV->remove. +<p>A DB_ENV handle which has already been used to open an +environment should not be used to call the DBENV->remove function, a new +DB_ENV handle should be created for that purpose. +<p>Once DBENV->remove has been called, regardless of its return, +the Berkeley DB environment handle may not be accessed again. +<p>The DBENV->remove function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EBUSY<dd>The shared memory region was in use and the force flag was not set. +</dl> +<p>The DBENV->remove function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the DBENV->remove function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_cachesize.html b/bdb/docs/api_c/env_set_cachesize.html new file mode 100644 index 00000000000..ba7980bb77a --- /dev/null +++ b/bdb/docs/api_c/env_set_cachesize.html @@ -0,0 +1,87 @@ +<!--$Id: env_set_cachesize.so,v 10.19 2000/05/20 16:29:11 bostic Exp $--> +<!--$Id: m4.cachesize,v 10.7 2000/02/11 18:54:45 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_cachesize</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_cachesize</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_cachesize(DB_ENV *dbenv, + u_int32_t gbytes, u_int32_t bytes, int ncache); +</pre></h3> +<h1>Description</h1> +<p>Set the size of the database's shared memory buffer pool, i.e., the cache, +to <b>gbytes</b> gigabytes plus <b>bytes</b>. The cache should be the +size of the normal working data set of the application, with some small +amount of additional memory for unusual situations. (Note, the working +set is not the same as the number of simultaneously referenced pages, and +should be quite a bit larger!) +<p>The default cache size is 256KB, and may not be specified as less than +20KB. Any cache size less than 500MB is automatically increased by 25% +to account for buffer pool overhead, cache sizes larger than 500MB are +used as specified. For information on tuning the Berkeley DB cache size, see +<a href="../ref/am_conf/cachesize.html">Selecting a cache size</a>. +<p>It is possible to specify caches to Berkeley DB that are large enough so that +they cannot be allocated contiguously on some architectures, e.g., some +releases of Solaris limit the amount of memory that may be allocated +contiguously by a process. If <b>ncache</b> is 0 or 1, the cache will +be allocated contiguously in memory. If it is greater than 1, the cache +will be broken up into <b>ncache</b> equally sized separate pieces of +memory. +<p>The DBENV->set_cachesize interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_cachesize function returns a non-zero error value on failure and 0 on success. +<p>The database environment's cache size may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_cachesize", one or more whitespace characters, +and the three arguments specified to this interface, separated by whitespace +characters, for example, "set_cachesize 1 500 2". Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +<p>The specified cache size was impossibly small. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_data_dir.html b/bdb/docs/api_c/env_set_data_dir.html new file mode 100644 index 00000000000..68db6dc4725 --- /dev/null +++ b/bdb/docs/api_c/env_set_data_dir.html @@ -0,0 +1,77 @@ +<!--$Id: env_set_data_dir.so,v 10.3 2000/05/20 16:29:11 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_data_dir</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_data_dir</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_data_dir(DB_ENV *dbenv, const char *dir); +</pre></h3> +<h1>Description</h1> +<p>Set the path of a directory to be used as the location of the access +method database files. Paths specified to the <a href="../api_c/db_open.html">DB->open</a> function +will be searched relative to this path. Paths set using this interface +are additive, and specifying more than one will result in each specified +directory being searched for database files. If any directories are +specified, created database files will always be created in the first path +specified. +<p>If no database directories are specified, database files can only exist +in the environment home directory. See <a href="../ref/env/naming.html">Berkeley DB File Naming</a> for more information. +<p>For the greatest degree of recoverability from system or application +failure, database files and log files should be located on separate +physical devices. +<p>The DBENV->set_data_dir interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_data_dir function returns a non-zero error value on failure and 0 on success. +<p>The database environment's data directory may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_data_dir", one or more whitespace characters, +and the directory name. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_errcall.html b/bdb/docs/api_c/env_set_errcall.html new file mode 100644 index 00000000000..660943070ed --- /dev/null +++ b/bdb/docs/api_c/env_set_errcall.html @@ -0,0 +1,73 @@ +<!--$Id: env_set_errcall.so,v 10.16 1999/12/20 08:52:29 bostic Exp $--> +<!--$Id: m4.errset,v 10.8 2000/02/19 20:57:57 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_errcall</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_errcall</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DBENV->set_errcall(DB_ENV *dbenv, + void (*db_errcall_fcn)(const char *errpfx, char *msg)); +</pre></h3> +<h1>Description</h1> +When an error occurs in the Berkeley DB library, a Berkeley DB error or an error +return value is returned by the function. In some cases, however, +the <b>errno</b> value may be insufficient to completely describe +the cause of the error especially during initial application debugging. +<p>The DBENV->set_errcall function is used to enhance the mechanism for reporting error +messages to the application. In some cases, when an error occurs, Berkeley DB +will call <b>db_errcall_fcn</b> with additional error information. The +function must be declared with two arguments; the first will be the prefix +string (as previously set by <a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> or +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>), the second will be the error message string. +It is up to the <b>db_errcall_fcn</b> function to display the error +message in an appropriate manner. +<p>Alternatively, you can use the <a href="../api_c/db_set_errfile.html">DB->set_errfile</a> or +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a> functions to display the additional information +via a C library FILE *. +<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>The DBENV->set_errcall interface may be used to configure Berkeley DB at any time +during the life of the application. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_errfile.html b/bdb/docs/api_c/env_set_errfile.html new file mode 100644 index 00000000000..ba1dd75f2cc --- /dev/null +++ b/bdb/docs/api_c/env_set_errfile.html @@ -0,0 +1,70 @@ +<!--$Id: env_set_errfile.so,v 10.17 1999/12/20 08:52:29 bostic Exp $--> +<!--$Id: m4.errset,v 10.8 2000/02/19 20:57:57 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_errfile</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_errfile</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DBENV->set_errfile(DB_ENV *dbenv, FILE *errfile); +</pre></h3> +<h1>Description</h1> +When an error occurs in the Berkeley DB library, a Berkeley DB error or an error +return value is returned by the function. In some cases, however, +the <b>errno</b> value may be insufficient to completely describe +the cause of the error especially during initial application debugging. +<p>The DBENV->set_errfile function is used to enhance the mechanism for reporting error +messages to the application by setting a C library FILE * to be used for +displaying additional Berkeley DB error messages. In some cases, when an error +occurs, Berkeley DB will output an additional error message to the specified +file reference. +<p>The error message will consist of the prefix string and a colon +("<b>:</b>") (if a prefix string was previously specified using +<a href="../api_c/db_set_errpfx.html">DB->set_errpfx</a> or <a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>), an error string, and +a trailing <newline> character. +<p>This error logging enhancement does not slow performance or significantly +increase application size, and may be run during normal operation as well +as during application debugging. +<p>The DBENV->set_errfile interface may be used to configure Berkeley DB at any time +during the life of the application. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_errpfx.html b/bdb/docs/api_c/env_set_errpfx.html new file mode 100644 index 00000000000..be803070cce --- /dev/null +++ b/bdb/docs/api_c/env_set_errpfx.html @@ -0,0 +1,59 @@ +<!--$Id: env_set_errpfx.so,v 10.12 1999/12/20 08:52:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_errpfx</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_errpfx</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +void +DBENV->set_errpfx(DB_ENV *dbenv, const char *errpfx); +</pre></h3> +<h1>Description</h1> +<p>Set the prefix string that appears before error messages issued by Berkeley DB. +<p>The DBENV->set_errpfx function does not copy the memory referenced by the +<b>errpfx</b> argument, rather, it maintains a reference to it. This +allows applications to modify the error message prefix at any time, +without repeatedly calling DBENV->set_errpfx, but means that the +memory must be maintained until the handle is closed. +<p>The DBENV->set_errpfx interface may be used to configure Berkeley DB at any time +during the life of the application. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_feedback.html b/bdb/docs/api_c/env_set_feedback.html new file mode 100644 index 00000000000..743f7772ff9 --- /dev/null +++ b/bdb/docs/api_c/env_set_feedback.html @@ -0,0 +1,69 @@ +<!--$Id: env_set_feedback.so,v 10.19 2000/07/09 19:12:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_feedback</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_feedback</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_feedback(DB_ENV *, + void (*db_feedback_fcn)(DB_ENV *, int opcode, int pct)); +</pre></h3> +<h1>Description</h1> +<p>Some operations performed by the Berkeley DB library can take non-trivial +amounts of time. The DBENV->set_feedback function can be used by +applications to monitor progress within these operations. +<p>When an operation is likely to take a long time, Berkeley DB will call the +specified callback function. This function must be declared with +three arguments: the first will be a reference to the enclosing +environment, the second a flag value, and the third the percent of the +operation that has been completed, specified as an integer value between +0 and 100. It is up to the callback function to display this +information in an appropriate manner. +<p>The <b>opcode</b> argument may take on any of the following values: +<p><dl compact> +<p><dt><a name="DB_RECOVER">DB_RECOVER</a><dd>The environment is being recovered. +</dl> +<p>The DBENV->set_feedback interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The DBENV->set_feedback function returns a non-zero error value on failure and 0 on success. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_flags.html b/bdb/docs/api_c/env_set_flags.html new file mode 100644 index 00000000000..6dfc0950819 --- /dev/null +++ b/bdb/docs/api_c/env_set_flags.html @@ -0,0 +1,84 @@ +<!--$Id--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_flags</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_flags</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_flags(DB_ENV *dbenv, u_int32_t flags, int onoff); +</pre></h3> +<h1>Description</h1> +<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. +If <b>onoff</b> is zero, the specified flags are cleared, otherwise they +are set. +<p><dl compact> +<p><dt><a name="DB_CDB_ALLDB">DB_CDB_ALLDB</a><dd>For Berkeley DB Concurrent Data Store applications, perform locking on an environment-wide basis +rather than per-database. This flag may only be used to configure Berkeley DB +before the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p><dt><a name="DB_NOMMAP">DB_NOMMAP</a><dd>Copy read-only database files in this environment into the local cache +instead of potentially mapping them into process memory (see the +description of the <a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a> function for further information). +<p><dt><a name="DB_TXN_NOSYNC">DB_TXN_NOSYNC</a><dd>Do not synchronously flush the log on transaction commit or prepare. +This means that transactions exhibit the ACI (atomicity, consistency and +isolation) properties, but not D (durability), i.e., database integrity +will be maintained but it is possible that some number of the most +recently committed transactions may be undone during recovery instead of +being redone. +<p>The number of transactions that are potentially at risk is governed by +how often the log is checkpointed (see <a href="../utility/db_checkpoint.html">db_checkpoint</a> for more +information) and how many log updates can fit on a single log page. +</dl> +<p>The DBENV->set_flags function returns a non-zero error value on failure and 0 on success. +<p>The database environment's flag values may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_flags", one or more whitespace characters, +and the interface flag argument as a string, for example, "set_flags +DB_TXN_NOSYNC". Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lg_bsize.html b/bdb/docs/api_c/env_set_lg_bsize.html new file mode 100644 index 00000000000..85e6dc12118 --- /dev/null +++ b/bdb/docs/api_c/env_set_lg_bsize.html @@ -0,0 +1,68 @@ +<!--$Id: env_set_lg_bsize.so,v 10.10 2000/05/20 16:29:11 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lg_bsize</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lg_bsize</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lg_bsize(DB_ENV *dbenv, u_int32_t lg_bsize); +</pre></h3> +<h1>Description</h1> +<p>Set the size of the in-memory log buffer, in bytes. By default, or if +the value is set to 0, a size of 32K is used. +<p>Log information is stored in-memory until the storage space fills up +or transaction commit forces the information to be flushed to stable +storage. In the presence of long-running transactions or transactions +producing large amounts of data, larger buffer sizes can increase +throughput. +<p>The DBENV->set_lg_bsize interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lg_bsize function returns a non-zero error value on failure and 0 on success. +<p>The database environment's log buffer size may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lg_bsize", one or more whitespace characters, +and the size in bytes. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lg_dir.html b/bdb/docs/api_c/env_set_lg_dir.html new file mode 100644 index 00000000000..a8d5c861421 --- /dev/null +++ b/bdb/docs/api_c/env_set_lg_dir.html @@ -0,0 +1,73 @@ +<!--$Id: env_set_lg_dir.so,v 10.3 2000/05/20 16:29:11 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lg_dir</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lg_dir</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lg_dir(DB_ENV *dbenv, const char *dir); +</pre></h3> +<h1>Description</h1> +<p>The path of a directory to be used as the location of logging files. +Log files created by the Log Manager subsystem will be created in this +directory. +<p>If no logging directory is specified, log files are created in the +environment home directory. See <a href="../ref/env/naming.html">Berkeley DB File Naming</a> for more information. +<p>For the greatest degree of recoverability from system or application +failure, database files and log files should be located on separate +physical devices. +<p>The DBENV->set_lg_dir interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lg_dir function returns a non-zero error value on failure and 0 on success. +<p>The database environment's logging directory may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lg_dir", one or more whitespace characters, +and the directory name. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lg_max.html b/bdb/docs/api_c/env_set_lg_max.html new file mode 100644 index 00000000000..4625db4346b --- /dev/null +++ b/bdb/docs/api_c/env_set_lg_max.html @@ -0,0 +1,68 @@ +<!--$Id: env_set_lg_max.so,v 10.20 2000/05/20 16:29:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lg_max</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lg_max</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lg_max(DB_ENV *dbenv, u_int32_t lg_max); +</pre></h3> +<h1>Description</h1> +<p>Set the maximum size of a single file in the log, in bytes. Because +<a href="../api_c/db_lsn.html">DB_LSN</a> file offsets are unsigned 4-byte values, the set value may +not be larger than the maximum unsigned 4-byte value. By default, or if +the value is set to 0, a size of 10MB is used. +<p>See <a href="../ref/log/limits.html">Log File Limits</a> +for more information. +<p>The DBENV->set_lg_max interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lg_max function returns a non-zero error value on failure and 0 on success. +<p>The database environment's log file size may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lg_max", one or more whitespace characters, +and the size in bytes. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +<p>The specified log file size was too large. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lk_conflicts.html b/bdb/docs/api_c/env_set_lk_conflicts.html new file mode 100644 index 00000000000..689464736ef --- /dev/null +++ b/bdb/docs/api_c/env_set_lk_conflicts.html @@ -0,0 +1,69 @@ +<!--$Id: env_set_lk_conflicts.so,v 10.22 2000/12/08 20:43:15 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lk_conflicts</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lk_conflicts</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lk_conflicts(DB_ENV *dbenv, + u_int8_t *conflicts, int nmodes); +</pre></h3> +<h1>Description</h1> +<p>Set the locking conflicts matrix. +The <b>conflicts</b> argument +is an <b>nmodes</b> by <b>nmodes</b> array. +A non-0 value for the array element: +<p><blockquote><pre>conflicts[requested_mode][held_mode]</pre></blockquote> +<p>indicates that requested_mode and held_mode conflict. The +<i>not-granted</i> mode must be represented by 0. +<p>If no <b>conflicts</b> value is specified, the conflicts array +<b>db_rw_conflicts</b> is used; see <a href="../ref/lock/stdmode.html">Standard Lock Modes</a> for a description of that array. +<p>The DBENV->set_lk_conflicts interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lk_conflicts function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>No memory was available to copy the conflicts array. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lk_detect.html b/bdb/docs/api_c/env_set_lk_detect.html new file mode 100644 index 00000000000..460651a0dab --- /dev/null +++ b/bdb/docs/api_c/env_set_lk_detect.html @@ -0,0 +1,72 @@ +<!--$Id: env_set_lk_detect.so,v 10.19 2000/12/08 20:43:15 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lk_detect</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lk_detect</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lk_detect(DB_ENV *dbenv, u_int32_t detect); +</pre></h3> +<h1>Description</h1> +<p>Set if the deadlock detector is to be run whenever a lock conflict occurs, +and specify which transaction should be aborted in the case of a deadlock. +The specified value must be one of the following list: +<p><dl compact> +<p><dt><a name="DB_LOCK_DEFAULT">DB_LOCK_DEFAULT</a><dd>Use the default policy as specified by <a href="../utility/db_deadlock.html">db_deadlock</a>. +<dt><a name="DB_LOCK_OLDEST">DB_LOCK_OLDEST</a><dd>Abort the oldest transaction. +<dt><a name="DB_LOCK_RANDOM">DB_LOCK_RANDOM</a><dd>Abort a random transaction involved in the deadlock. +<dt><a name="DB_LOCK_YOUNGEST">DB_LOCK_YOUNGEST</a><dd>Abort the youngest transaction. +</dl> +<p>The DBENV->set_lk_detect interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lk_detect function returns a non-zero error value on failure and 0 on success. +<p>The database environment's deadlock detector configuration may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lk_detect", one or more whitespace characters, +and the interface <b>detect</b> argument as a string, for example, +"set_lk_detect DB_LOCK_OLDEST". Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lk_max.html b/bdb/docs/api_c/env_set_lk_max.html new file mode 100644 index 00000000000..1e9832b59d9 --- /dev/null +++ b/bdb/docs/api_c/env_set_lk_max.html @@ -0,0 +1,72 @@ +<!--$Id: env_set_lk_max.so,v 10.21 2000/12/21 19:11:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lk_max</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lk_max</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lk_max(DB_ENV *dbenv, u_int32_t max); +</pre></h3> +<h1>Description</h1> +<p><b>The DBENV->set_lk_max function interface has been deprecated in favor of +the <a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, <a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +and <a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a> functions. Please update your applications.</b> +<p>Set each of the maximum number of locks, lockers and lock objects +supported by the Berkeley DB lock subsystem to <b>max</b>. This value is +used by <a href="../api_c/env_open.html">DBENV->open</a> to estimate how much space to allocate for +various lock-table data structures. For specific information on +configuring the size of the lock subsystem, see +<a href="../ref/lock/max.html">Configuring locking: sizing the +system</a>. +<p>The DBENV->set_lk_max interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lk_max function returns a non-zero error value on failure and 0 on success. +<p>The database environment's maximum number of locks may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lk_max", one or more whitespace characters, +and the number of locks. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lk_max_lockers.html b/bdb/docs/api_c/env_set_lk_max_lockers.html new file mode 100644 index 00000000000..e41a943fd56 --- /dev/null +++ b/bdb/docs/api_c/env_set_lk_max_lockers.html @@ -0,0 +1,68 @@ +<!--$Id: env_set_lk_max_lockers.so,v 1.2 2000/12/08 22:03:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lk_max_lockers</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lk_max_lockers</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lk_max_lockers(DB_ENV *dbenv, u_int32_t max); +</pre></h3> +<h1>Description</h1> +<p>Set the maximum number of simultaneous locking entities supported by +the Berkeley DB lock subsystem. This value is used by <a href="../api_c/env_open.html">DBENV->open</a> to +estimate how much space to allocate for various lock-table data +structures. For specific information on configuring the size of the +lock subsystem, see +<a href="../ref/lock/max.html">Configuring locking: sizing the system</a>. +<p>The DBENV->set_lk_max_lockers interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lk_max_lockers function returns a non-zero error value on failure and 0 on success. +<p>The database environment's maximum number of lockers may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lk_max_lockers", one or more whitespace characters, +and the number of lockers. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lk_max_locks.html b/bdb/docs/api_c/env_set_lk_max_locks.html new file mode 100644 index 00000000000..a908b288f97 --- /dev/null +++ b/bdb/docs/api_c/env_set_lk_max_locks.html @@ -0,0 +1,67 @@ +<!--$Id: env_set_lk_max_locks.so,v 10.1 2000/12/21 19:11:27 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lk_max_locks</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lk_max_locks</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lk_max_locks(DB_ENV *dbenv, u_int32_t max); +</pre></h3> +<h1>Description</h1> +<p>Set the maximum number of locks supported by the Berkeley DB lock subsystem. +This value is used by <a href="../api_c/env_open.html">DBENV->open</a> to estimate how much space to +allocate for various lock-table data structures. For specific +information on configuring the size of the lock subsystem, see +<a href="../ref/lock/max.html">Configuring locking: sizing the system</a>. +<p>The DBENV->set_lk_max_locks interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lk_max_locks function returns a non-zero error value on failure and 0 on success. +<p>The database environment's maximum number of locks may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lk_max_locks", one or more whitespace characters, +and the number of locks. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_lk_max_objects.html b/bdb/docs/api_c/env_set_lk_max_objects.html new file mode 100644 index 00000000000..8fba15876cf --- /dev/null +++ b/bdb/docs/api_c/env_set_lk_max_objects.html @@ -0,0 +1,68 @@ +<!--$Id: env_set_lk_max_objects.so,v 1.2 2000/12/08 22:03:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_lk_max_objects</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_lk_max_objects</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_lk_max_objects(DB_ENV *dbenv, u_int32_t max); +</pre></h3> +<h1>Description</h1> +<p>Set the maximum number of simultaneously locked objects supported by +the Berkeley DB lock subsystem. This value is used by <a href="../api_c/env_open.html">DBENV->open</a> to +estimate how much space to allocate for various lock-table data +structures. For specific information on configuring the size of the +lock subsystem, see +<a href="../ref/lock/max.html">Configuring locking: sizing the system</a>. +<p>The DBENV->set_lk_max_objects interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_lk_max_objects function returns a non-zero error value on failure and 0 on success. +<p>The database environment's maximum number of objects may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_lk_max_objects", one or more whitespace characters, +and the number of objects. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_mp_mmapsize.html b/bdb/docs/api_c/env_set_mp_mmapsize.html new file mode 100644 index 00000000000..3f87a140a15 --- /dev/null +++ b/bdb/docs/api_c/env_set_mp_mmapsize.html @@ -0,0 +1,71 @@ +<!--$Id: env_set_mp_mmapsize.so,v 10.18 2000/05/20 16:29:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_mp_mmapsize</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_mp_mmapsize</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_mp_mmapsize(DB_ENV *dbenv, size_t mp_mmapsize); +</pre></h3> +<h1>Description</h1> +<p>Files that are opened read-only in the pool (and that satisfy a few other +criteria) are, by default, mapped into the process address space instead +of being copied into the local cache. This can result in better-than-usual +performance, as available virtual memory is normally much larger than the +local cache, and page faults are faster than page copying on many systems. +However, in the presence of limited virtual memory it can cause resource +starvation, and in the presence of large databases, it can result in immense +process sizes. +<p>Set the maximum file size, in bytes, for a file to be mapped into the +process address space. If no value is specified, it defaults to 10MB. +<p>The DBENV->set_mp_mmapsize interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_mp_mmapsize function returns a non-zero error value on failure and 0 on success. +<p>The database environment's maximum mapped file size may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_mp_mmapsize", one or more whitespace characters, +and the size in bytes. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_mutexlocks.html b/bdb/docs/api_c/env_set_mutexlocks.html new file mode 100644 index 00000000000..a5fa2aa34c6 --- /dev/null +++ b/bdb/docs/api_c/env_set_mutexlocks.html @@ -0,0 +1,59 @@ +<!--$Id: env_set_mutexlocks.so,v 10.9 2000/11/17 19:56:52 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_mutexlocks</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_mutexlocks</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_mutexlocks(DB_ENV *dbenv, int do_lock); +</pre></h3> +<h1>Description</h1> +<p>Toggle mutex locks. Setting <b>do_lock</b> to a zero value causes +Berkeley DB to grant all requested mutual exclusion mutexes without regard +for their availability. +<p>This functionality should never be used for any other purpose than +debugging. +<p>The DBENV->set_mutexlocks interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The DBENV->set_mutexlocks function returns a non-zero error value on failure and 0 on success. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_pageyield.html b/bdb/docs/api_c/env_set_pageyield.html new file mode 100644 index 00000000000..95372408525 --- /dev/null +++ b/bdb/docs/api_c/env_set_pageyield.html @@ -0,0 +1,68 @@ +<!--$Id: env_set_pageyield.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_pageyield</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_pageyield</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_pageyield(int pageyield); +</pre></h3> +<h1>Description</h1> +<p>Yield the processor whenever requesting a page from the cache. Setting +<b>pageyield</b> to a non-zero value causes Berkeley DB to yield the processor +any time a thread requests a page from the cache. +<p>The db_env_set_pageyield interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_pageyield interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>This functionality should never be used for any other purpose than stress +testing. +<p>The db_env_set_pageyield interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The db_env_set_pageyield function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_paniccall.html b/bdb/docs/api_c/env_set_paniccall.html new file mode 100644 index 00000000000..a9d58a80b83 --- /dev/null +++ b/bdb/docs/api_c/env_set_paniccall.html @@ -0,0 +1,67 @@ +<!--$Id: env_set_paniccall.so,v 10.14 2000/07/09 19:12:56 bostic Exp $--> +<!--$Id: m4.errset,v 10.8 2000/02/19 20:57:57 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_paniccall</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_paniccall</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_paniccall(DB_ENV *dbenv, + void (*paniccall)(DB_ENV *, int errval)); +</pre></h3> +<h1>Description</h1> +<p>Errors can occur in the Berkeley DB library where the only solution is to shut +down the application and run recovery. (For example, if Berkeley DB is unable +to write log records to disk because there is insufficient disk space.) +In these cases, the value <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> is returned by Berkeley DB. +<p>In these cases, it is also often simpler to shut down the application when +such errors occur rather than attempting to gracefully return up the stack. +The DBENV->set_paniccall function is used to specify a function to be called when +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> is about to be returned from a Berkeley DB method. When +called, the <b>dbenv</b> argument will be a reference to the current +environment, and the <b>errval</b> argument is the error value that would +have been returned to the calling function. +<p>The DBENV->set_paniccall interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The DBENV->set_paniccall function returns a non-zero error value on failure and 0 on success. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_panicstate.html b/bdb/docs/api_c/env_set_panicstate.html new file mode 100644 index 00000000000..6168ad9af7e --- /dev/null +++ b/bdb/docs/api_c/env_set_panicstate.html @@ -0,0 +1,64 @@ +<!--$Id: env_set_panicstate.so,v 10.2 2001/01/17 15:32:34 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_panicstate</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_panicstate</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_panicstate(int panic); +</pre></h3> +<h1>Description</h1> +<p>Toggle the Berkeley DB panic state. Setting <b>panic</b> to a non-zero value +causes Berkeley DB to refuse attempts to call Berkeley DB functions with the +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> error return. +<p>The db_env_set_panicstate interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_panicstate interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_panicstate function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_rec_init.html b/bdb/docs/api_c/env_set_rec_init.html new file mode 100644 index 00000000000..056ec9b717c --- /dev/null +++ b/bdb/docs/api_c/env_set_rec_init.html @@ -0,0 +1,71 @@ +<!--$Id: env_set_rec_init.so,v 10.9 2000/05/01 21:57:44 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_recovery_init</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_recovery_init</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_recovery_init(DB_ENV *, + int (*db_recovery_init_fcn)(DB_ENV *)); +</pre></h3> +<h1>Description</h1> +<p>Applications installing application-specific recovery functions need +to be called before Berkeley DB performs recovery so they may add their recovery +functions to Berkeley DB's. +<p>The DBENV->set_recovery_init function supports this functionality. The +<b>db_recovery_init_fcn</b> function must be declared with one +argument, a reference to the enclosing Berkeley DB environment. This +function will be called after the <a href="../api_c/env_open.html">DBENV->open</a> has been called, +but before recovery is started. +<p>If the <b>db_recovery_init_fcn</b> function returns a non-zero value, +no recovery will be performed and <a href="../api_c/env_open.html">DBENV->open</a> will return the same +value to its caller. +<p>The DBENV->set_recovery_init interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_recovery_init function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_region_init.html b/bdb/docs/api_c/env_set_region_init.html new file mode 100644 index 00000000000..3c83680ada9 --- /dev/null +++ b/bdb/docs/api_c/env_set_region_init.html @@ -0,0 +1,77 @@ +<!--$Id: env_set_region_init.so,v 10.10 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_region_init</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_region_init</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_region_init(int region_init); +</pre></h3> +<h1>Description</h1> +<p>Page-fault shared regions into memory when initially creating or joining +a Berkeley DB environment. In some applications, the expense of page-faulting +the shared memory regions can affect performance, e.g., when the +page-fault occurs while holding a lock, other lock requests can convoy +and overall throughput may decrease. Setting <b>region_init</b> to a +non-zero value specifies that shared regions be read or written, as +appropriate, when the region is joined by the application. This forces +the underlying virtual memory and file systems to instantiate both the +necessary memory and the necessary disk space. This can also avoid +out-of-disk space failures later on. +<p>The db_env_set_region_init interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_region_init interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_region_init function returns a non-zero error value on failure and 0 on success. +<p>The database environment's initial behavior with respect to shared memory regions may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_region_init", one or more whitespace characters, +and the string "1". Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_server.html b/bdb/docs/api_c/env_set_server.html new file mode 100644 index 00000000000..586887bfc96 --- /dev/null +++ b/bdb/docs/api_c/env_set_server.html @@ -0,0 +1,77 @@ +<!--"@(#)env_set_server.so 10.13 (Sleepycat) 8/25/99"--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_server</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_server</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_server(DB_ENV *dbenv, char *host, + long cl_timeout, long sv_timeout, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>Connects to the DB server on the indicated hostname and sets up a channel +for communication. +<p>The <b>cl_timeout</b> argument specifies the number of seconds the client +should wait for results to come back from the server. Once the timeout +has expired on any communication with the server, DB_NOSERVER will +be returned. If this value is zero, a default timeout is used. +<p>The <b>sv_timeout</b> argument specifies the number of seconds the server +should allow a client connection to remain idle before assuming that +client is gone. Once that timeout has been reached, the server releases +all resources associated with that client connection. Subsequent attempts +by that client to communicate with the server result in +DB_NOSERVER_ID indicating that an invalid identifier has been +given to the server. This value can be considered a hint to the server. +The server may alter this value based on its own policies or allowed +values. If this value is zero, a default timeout is used. +<p>The <b>flags</b> parameter is currently unused, and must be set to 0. +<p>When the DBENV->set_server function has been called, any subsequent calls +to Berkeley DB library interfaces may return either <a name="DB_NOSERVER">DB_NOSERVER</a> or +<a name="DB_NOSERVER_ID">DB_NOSERVER_ID</a>. +<p>The DBENV->set_server function returns a non-zero error value on failure and 0 on success. +<h3>Errors</h3> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>dbenv_set_server +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_shm_key.html b/bdb/docs/api_c/env_set_shm_key.html new file mode 100644 index 00000000000..8de32ed842a --- /dev/null +++ b/bdb/docs/api_c/env_set_shm_key.html @@ -0,0 +1,87 @@ +<!--$Id: env_set_shm_key.so,v 10.5 2000/08/09 15:45:52 sue Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_shm_key</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_shm_key</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_shm_key(DB_ENV *dbenv, long shm_key); +</pre></h3> +<h1>Description</h1> +<p>Specify a base segment ID for Berkeley DB environment shared memory regions +created in system memory on VxWorks or systems supporting X/Open-style +shared memory interfaces, e.g., UNIX systems supporting +<b>shmget</b>(2) and related System V IPC interfaces. +<p>This base segment ID will be used when Berkeley DB shared memory regions are +first created. It will be incremented a small integer value each time +a new shared memory region is created, that is, if the base ID is 35, +the first shared memory region created will have a segment ID of 35 and +the next one a segment ID between 36 and 40 or so. A Berkeley DB environment +always creates a master shared memory region, plus an additional shared +memory region for each of the subsystems supported by the environment +(locking, logging, memory pool and transaction), plus an additional +shared memory region for each additional memory pool cache that is +supported. Already existing regions with the same segment IDs will be +removed. See <a href="../ref/env/region.html">Shared Memory Regions</a> +for more information. +<p>The intent behind this interface is two-fold: without it, applications +have no way to ensure that two Berkeley DB applications don't attempt to use +the same segment IDs when creating different Berkeley DB environments. In +addition, by using the same segment IDs each time the environment is +created, previously created segments will be removed, and the set of +segments on the system will not grow without bound. +<p>The DBENV->set_shm_key interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_shm_key function returns a non-zero error value on failure and 0 on success. +<p>The database environment's base segment ID may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_shm_key", one or more whitespace characters, +and the ID. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_tas_spins.html b/bdb/docs/api_c/env_set_tas_spins.html new file mode 100644 index 00000000000..633dcda077e --- /dev/null +++ b/bdb/docs/api_c/env_set_tas_spins.html @@ -0,0 +1,70 @@ +<!--$Id: env_set_tas_spins.so,v 10.9 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_tas_spins</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_tas_spins</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_tas_spins(u_int32_t tas_spins); +</pre></h3> +<h1>Description</h1> +<p>Specify that test-and-set mutexes should spin <b>tas_spins</b> times +without blocking. The value defaults to 1 on uniprocessor systems and +to 50 times the number of processors on multiprocessor systems. +<p>The db_env_set_tas_spins interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_tas_spins interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_tas_spins function returns a non-zero error value on failure and 0 on success. +<p>The database environment's test-and-set spin count may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_tas_spins", one or more whitespace characters, +and the number of spins. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_tmp_dir.html b/bdb/docs/api_c/env_set_tmp_dir.html new file mode 100644 index 00000000000..05f3bed5da0 --- /dev/null +++ b/bdb/docs/api_c/env_set_tmp_dir.html @@ -0,0 +1,89 @@ +<!--$Id: env_set_tmp_dir.so,v 10.3 2000/05/20 16:29:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_tmp_dir</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_tmp_dir</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_tmp_dir(DB_ENV *dbenv, const char *dir); +</pre></h3> +<h1>Description</h1> +<p>The path of a directory to be used as the location of temporary files. +The files created to back in-memory access method databases will be +created relative to this path. These temporary files can be quite large, +depending on the size of the database. +<p>If no directories are specified, the following alternatives are checked +in the specified order. The first existing directory path is used for +all temporary files. +<p><ol> +<p><li>The value of the environment variable <b>TMPDIR</b>. +<li>The value of the environment variable <b>TEMP</b>. +<li>The value of the environment variable <b>TMP</b>. +<li>The value of the environment variable <b>TempFolder</b>. +<li>The value returned by the GetTempPath interface. +<li>The directory <b>/var/tmp</b>. +<li>The directory <b>/usr/tmp</b>. +<li>The directory <b>/temp</b>. +<li>The directory <b>/tmp</b>. +<li>The directory <b>C:/temp</b>. +<li>The directory <b>C:/tmp</b>. +</ol> +<p>Note: environment variables are only checked if one of 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 were +specified. +<p>Note: the GetTempPath interface is only checked on Win/32 platforms. +<p>The DBENV->set_tmp_dir interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_tmp_dir function returns a non-zero error value on failure and 0 on success. +<p>The database environment's temporary file directory may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_tmp_dir", one or more whitespace characters, +and the directory name. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_tx_max.html b/bdb/docs/api_c/env_set_tx_max.html new file mode 100644 index 00000000000..82328955237 --- /dev/null +++ b/bdb/docs/api_c/env_set_tx_max.html @@ -0,0 +1,67 @@ +<!--$Id: env_set_tx_max.so,v 10.21 2000/05/20 16:29:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_tx_max</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_tx_max</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_tx_max(DB_ENV *dbenv, u_int32_t tx_max); +</pre></h3> +<h1>Description</h1> +<p>Set the maximum number of active transactions that are supported by the +environment. This value bounds the size of backing shared memory regions. +Note that child transactions must be counted as active until their +ultimate parent commits or aborts. +<p>When there are more than the specified number of concurrent transactions, +calls to <a href="../api_c/txn_begin.html">txn_begin</a> will fail (until some active transactions +complete). If no value is specified, a default value of 20 is used. +<p>The DBENV->set_tx_max interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_tx_max function returns a non-zero error value on failure and 0 on success. +<p>The database environment's maximum number of active transactions may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_tx_max", one or more whitespace characters, +and the number of transactions. Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_tx_recover.html b/bdb/docs/api_c/env_set_tx_recover.html new file mode 100644 index 00000000000..9295537b5f5 --- /dev/null +++ b/bdb/docs/api_c/env_set_tx_recover.html @@ -0,0 +1,75 @@ +<!--$Id: env_set_tx_recover.so,v 10.26 2000/07/09 19:13:19 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_tx_recover</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_tx_recover</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_tx_recover(DB_ENV *dbenv, + int (*tx_recover)(DB_ENV *dbenv, + DBT *log_rec, DB_LSN *lsn, db_recops op)); +</pre></h3> +<h1>Description</h1> +<p>Set the application's function to be called during transaction abort +and recovery. This function must return 0 on success and either +<b>errno</b> or a value outside of the Berkeley DB error name space on +failure. It takes four arguments: +<p><dl compact> +<p><dt>dbenv <dd>A Berkeley DB environment. +<p><dt>log_rec<dd>A log record. +<p><dt>lsn<dd>A log sequence number. +<p><dt>op<dd>One of the following values: +<p><dl compact> +<p><dt><a name="DB_TXN_BACKWARD_ROLL">DB_TXN_BACKWARD_ROLL</a><dd>The log is being read backward to determine which transactions have been +committed and to abort those operations that were not, undo the operation +described by the log record. +<p><dt><a name="DB_TXN_FORWARD_ROLL">DB_TXN_FORWARD_ROLL</a><dd>The log is being played forward, redo the operation described by the log +record. +<p><dt><a name="DB_TXN_ABORT">DB_TXN_ABORT</a><dd>The log is being read backwards during a transaction abort, undo the +operation described by the log record. +</dl> +</dl> +<p>The DBENV->set_tx_recover interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_tx_recover function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>Called after <a href="../api_c/env_open.html">DBENV->open</a> was called. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_tx_timestamp.html b/bdb/docs/api_c/env_set_tx_timestamp.html new file mode 100644 index 00000000000..68cd0d15723 --- /dev/null +++ b/bdb/docs/api_c/env_set_tx_timestamp.html @@ -0,0 +1,63 @@ +<!--$Id: env_set_tx_timestamp.so,v 10.6 2000/12/21 18:33:42 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_tx_timestamp</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_tx_timestamp</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_tx_timestamp(DB_ENV *dbenv, time_t *timestamp); +</pre></h3> +<h1>Description</h1> +<p>Recover to the time specified by <b>timestamp</b> rather than to the most +current possible date. +The <b>timestamp</b> argument should be the number of seconds since 0 +hours, 0 minutes, 0 seconds, January 1, 1970, Coordinated Universal Time, +i.e., the Epoch. +<p>Once a database environment has been upgraded to a new version of Berkeley DB +involving a log format change (see <a href="../ref/upgrade/process.html">Upgrading Berkeley DB installations</a>, it is no longer possible to recover +to a specific time before that upgrade. +<p>The DBENV->set_tx_timestamp interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The DBENV->set_tx_timestamp function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>It is not possible to recover to the specified time using the +log files currently present in the environment. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_set_verbose.html b/bdb/docs/api_c/env_set_verbose.html new file mode 100644 index 00000000000..605fd577cca --- /dev/null +++ b/bdb/docs/api_c/env_set_verbose.html @@ -0,0 +1,78 @@ +<!--$Id: env_set_verbose.so,v 10.23 2000/05/20 16:29:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: DBENV->set_verbose</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>DBENV->set_verbose</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +DBENV->set_verbose(DB_ENV *dbenv, u_int32_t which, int onoff); +</pre></h3> +<h1>Description</h1> +<p>The DBENV->set_verbose function turns additional informational and +debugging messages in the Berkeley DB message output on and off. If +<b>onoff</b> is set to +non-zero, +the additional messages are output. +<p>The <b>which</b> parameter must be set to one of the following values: +<p><dl compact> +<p><dt><a name="DB_VERB_CHKPOINT">DB_VERB_CHKPOINT</a><dd>Display checkpoint location information when searching the log for +checkpoints. +<p><dt><a name="DB_VERB_DEADLOCK">DB_VERB_DEADLOCK</a><dd>Display additional information when doing deadlock detection. +<p><dt><a name="DB_VERB_RECOVERY">DB_VERB_RECOVERY</a><dd>Display additional information when performing recovery. +<p><dt><a name="DB_VERB_WAITSFOR">DB_VERB_WAITSFOR</a><dd>Display the waits-for table when doing deadlock detection. +</dl> +<p>The DBENV->set_verbose interface may be used to configure Berkeley DB at any time +during the life of the application. +<p>The DBENV->set_verbose function returns a non-zero error value on failure and 0 on success. +<p>The database environment's verbosity may also be set using the environment's +<b>DB_CONFIG</b> file. The syntax of the entry in that file is a +single line with the string "set_verbose", one or more whitespace characters, +and the interface <b>which</b> argument as a string, for example, +"set_verbose DB_VERB_CHKPOINT". Because the <b>DB_CONFIG</b> file is read when the database +environment is opened, it will silently overrule configuration done +before that time. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_strerror.html b/bdb/docs/api_c/env_strerror.html new file mode 100644 index 00000000000..e6bd190a2ea --- /dev/null +++ b/bdb/docs/api_c/env_strerror.html @@ -0,0 +1,60 @@ +<!--$Id: env_strerror.so,v 8.4 2000/07/30 17:59:25 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_strerror</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_strerror</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +char * +db_strerror(int error); +</pre></h3> +<h1>Description</h1> +<p>The db_strerror function returns an error message string corresponding +to the error number <b>error</b>. This interface is a superset of the +ANSI C X3.159-1989 (ANSI C) <b>strerror</b>(3) interface. If the error number +<b>error</b> is greater than or equal to 0, then the string returned by +the system interface <b>strerror</b>(3) is returned. If the error +number is less than 0, an error string appropriate to the corresponding +Berkeley DB library error is returned. See +<a href="../ref/program/errorret.html">Error returns to applications</a> +for more information. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/env_version.html b/bdb/docs/api_c/env_version.html new file mode 100644 index 00000000000..fa7704aaea2 --- /dev/null +++ b/bdb/docs/api_c/env_version.html @@ -0,0 +1,57 @@ +<!--$Id: env_version.so,v 10.13 1999/12/20 08:52:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_version</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_version</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +char * +db_version(int *major, int *minor, int *patch); +</pre></h3> +<h1>Description</h1> +<p>The db_version function returns a pointer to a string containing Berkeley DB +version information. If <b>major</b> is non-NULL, the major version +of the Berkeley DB release is stored in the memory it references. If +<b>minor</b> is non-NULL, the minor version of the Berkeley DB release is +stored in the memory it references. If <b>patch</b> is non-NULL, the +patch version of the Berkeley DB release is stored in the memory it references. +<h1>See Also</h1> +<a href="../api_c/env_close.html">DBENV->close</a>, +<a href="../api_c/env_create.html">db_env_create</a>, +<a href="../api_c/env_open.html">DBENV->open</a>, +<a href="../api_c/env_remove.html">DBENV->remove</a>, +<a href="../api_c/db_err.html">DBENV->err</a>, +<a href="../api_c/env_strerror.html">db_strerror</a>, +<a href="../api_c/env_version.html">db_version</a>, +<a href="../api_c/env_set_cachesize.html">DBENV->set_cachesize</a>, +<a href="../api_c/env_set_errcall.html">DBENV->set_errcall</a>, +<a href="../api_c/env_set_errfile.html">DBENV->set_errfile</a>, +<a href="../api_c/env_set_errpfx.html">DBENV->set_errpfx</a>, +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a>, +<a href="../api_c/env_set_mutexlocks.html">DBENV->set_mutexlocks</a>, +<a href="../api_c/env_set_paniccall.html">DBENV->set_paniccall</a>, +and +<a href="../api_c/env_set_verbose.html">DBENV->set_verbose</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/hsearch.html b/bdb/docs/api_c/hsearch.html new file mode 100644 index 00000000000..0d6d6ce51ed --- /dev/null +++ b/bdb/docs/api_c/hsearch.html @@ -0,0 +1,107 @@ +<!--$Id: hsearch.so,v 10.18 2000/09/21 20:40:54 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: hsearch</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>hsearch</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#define DB_DBM_HSEARCH 1 +#include <db.h> +<p> +typedef enum { + FIND, ENTER +} ACTION; +<p> +typedef struct entry { + char *key; + void *data; +} ENTRY; +<p> +ENTRY * +hsearch(ENTRY item, ACTION action); +<p> +int +hcreate(size_t nelem); +<p> +void +hdestroy(void); +</pre></h3> +<h1>Description</h1> +<p>The hsearch interface to the Berkeley DB library is intended to +provide a high-performance implementation and source code compatibility +for applications written to the historic hsearch interface. +It is not recommended for any other purpose. +<p>To compile hsearch applications, replace the application's +<b>#include</b> of the hsearch include +file (e.g., <b>#include <search.h></b>) +with the following two lines: +<p><blockquote><pre> +#define DB_DBM_HSEARCH 1 +#include <db.h></pre></blockquote> +<p>and recompile. +<p>The hcreate function creates an in-memory database. The +<b>nelem</b> argument is an estimation of the maximum number of key/data +pairs that will be stored in the database. +<p>The <b>hdestroy</b> function discards the database. +<p>Database elements are structures of type <b>ENTRY</b>, which contain at +least two fields: <b>key</b> and <b>data</b>. The field <b>key</b> is +declared to be of type <b>char *</b> and is the key used for storage +and retrieval. The field <b>data</b> is declared to be of type +<b>void *</b> and is its associated data. +<p>The hsearch function retrieves key/data pairs from, and stores +key/data pairs into the database. +<p>The <b>action</b> argument must be set to one of two values: +<p><dl compact> +<p><dt>ENTER<dd>If the key does not already appear in the database, +insert the key/data pair into the database. +If the key already appears in the database, +return a reference to an <b>ENTRY</b> +structure referencing the existing key and its associated data element. +<p><dt>FIND<dd>Retrieve the specified key/data pair from the database. +</dl> +<h3>Compatibility Notes</h3> +<p>Historically, hsearch required applications to maintain the keys +and data in the application's memory for as long as the <b>hsearch</b> +database existed. As Berkeley DB handles key and data management internally, +there is no requirement that applications maintain local copies of key +and data items, although the only effect of doing so should be the +allocation of additional memory. +<h3>Hsearch Diagnostics</h3> +<p>The <b>hcreate</b> function returns 0 on failure, setting <b>errno</b> +and non-zero on success. +<p>The <b>hsearch</b> function returns a pointer to an ENTRY structure on +success, and NULL, setting <b>errno</b>, if the <b>action</b> +specified was FIND and the item did not appear in the database. +<h1>Errors</h1> +<p>The hcreate function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the hcreate function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<p>The hsearch function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the hsearch function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<p>In addition, the <b>hsearch</b> function will fail, setting <b>errno</b> +to 0, if the <b>action</b> specified was FIND and the item did not appear in +the database. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/lock_detect.html b/bdb/docs/api_c/lock_detect.html new file mode 100644 index 00000000000..7b95e98e9d0 --- /dev/null +++ b/bdb/docs/api_c/lock_detect.html @@ -0,0 +1,73 @@ +<!--$Id: lock_detect.so,v 10.26 2000/03/17 01:53:59 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: lock_detect</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>lock_detect</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +lock_detect(DB_ENV *env, + u_int32_t flags, u_int32_t atype, int *aborted); +</pre></h3> +<h1>Description</h1> +<p>The lock_detect function runs one iteration of the deadlock detector. +The deadlock detector traverses the lock table, and for each deadlock +it finds, marks one of the participating transactions for abort. +<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_LOCK_CONFLICT">DB_LOCK_CONFLICT</a><dd>Only run the deadlock detector if a lock conflict has occurred since +the last time that the deadlock detector was run. +</dl> +<p>The <b>atype</b> parameter specifies which transaction to abort in the +case of deadlock. It must be set to one of possible arguments listed for +the <a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a> interface. +<p>If the <b>aborted</b> parameter is non-NULL, the memory location it +references will be set to the number of transactions aborted by the +lock_detect function. +<p>The lock_detect function is the underlying function used by the <a href="../utility/db_deadlock.html">db_deadlock</a> utility. +See the <a href="../utility/db_deadlock.html">db_deadlock</a> utility source code for an example of using lock_detect +in a IEEE/ANSI Std 1003.1 (POSIX) environment. +<p>The lock_detect function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The lock_detect function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the lock_detect function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/lock_get.html b/bdb/docs/api_c/lock_get.html new file mode 100644 index 00000000000..8d68ba54cb9 --- /dev/null +++ b/bdb/docs/api_c/lock_get.html @@ -0,0 +1,91 @@ +<!--$Id: lock_get.so,v 10.28 2000/04/24 16:33:54 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: lock_get</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>lock_get</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +lock_get(DB_ENV *env, u_int32_t locker, + u_int32_t flags, const DBT *obj, + const db_lockmode_t lock_mode, DB_LOCK *lock); +</pre></h3> +<h1>Description</h1> +<p>The lock_get function acquires a lock from the lock table, returning +information about it in +the <b>lock</b> argument. +<p>The <b>locker</b> argument specified to lock_get is an unsigned +32-bit integer quantity. It represents the entity requesting or releasing +the lock. +<p>The <b>flags</b> value must be set to 0 or the following value: +<p><dl compact> +<p><dt><a name="DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a><dd>If a lock cannot be granted because the requested lock conflicts with an +existing lock, return immediately instead of waiting for the lock to +become available. +</dl> +<p>The <b>obj</b> argument is an untyped byte string that specifies the +object to be locked or released. +<p>The <b>mode</b> argument is an index into the environment's lock conflict +array. See <a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a> and +<a href="../ref/lock/stdmode.html">Standard Lock Modes</a> +for a description of that array. +<p>The lock_get function may +return +one of the following values: +<p><dl compact> +<p><dt><a name="DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a><dd>A lock was requested that could not be immediately granted and the +<b>flags</b> parameter was set to DB_LOCK_NOWAIT. +</dl> +<p>Otherwise, the lock_get function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The lock_get function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>The maximum number of locks has been reached. +</dl> +<p>The lock_get function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the lock_get function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/lock_id.html b/bdb/docs/api_c/lock_id.html new file mode 100644 index 00000000000..bd720cdb00e --- /dev/null +++ b/bdb/docs/api_c/lock_id.html @@ -0,0 +1,57 @@ +<!--$Id: lock_id.so,v 10.19 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: lock_id</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>lock_id</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +lock_id(DB_ENV *env, u_int32_t *idp); +</pre></h3> +<h1>Description</h1> +<p>The lock_id function +copies a locker ID, which is guaranteed to be unique in the specified lock +table, into the memory location referenced by <b>idp</b>. +<p>The lock_id function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The lock_id function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the lock_id function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/lock_put.html b/bdb/docs/api_c/lock_put.html new file mode 100644 index 00000000000..777f4bdd09b --- /dev/null +++ b/bdb/docs/api_c/lock_put.html @@ -0,0 +1,59 @@ +<!--$Id: lock_put.so,v 10.21 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: lock_put</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>lock_put</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +lock_put(DB_ENV *env, DB_LOCK *lock); +</pre></h3> +<h1>Description</h1> +<p>The lock_put function releases <b>lock</b> from the lock table. +<p>The lock_put function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The lock_put function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The lock_put function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the lock_put function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/lock_stat.html b/bdb/docs/api_c/lock_stat.html new file mode 100644 index 00000000000..c86024de7f9 --- /dev/null +++ b/bdb/docs/api_c/lock_stat.html @@ -0,0 +1,92 @@ +<!--$Id: lock_stat.so,v 10.30 2000/12/08 20:43:15 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: lock_stat</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>lock_stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +lock_stat(DB_ENV *env, + DB_LOCK_STAT **statp, void *(*db_malloc)(size_t)); +</pre></h3> +<h1>Description</h1> +<p>The lock_stat function +creates a statistical structure and copies a pointer to it into a +user-specified memory location. +<p>Statistical structures are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<p>The lock region statistics are stored in a structure of type +DB_LOCK_STAT. The following DB_LOCK_STAT fields will be filled in: +<p><dl compact> +<dt>u_int32_t st_lastid;<dd>The last allocated lock ID. +<dt>u_int32_t st_nmodes;<dd>The number of lock modes. +<dt>u_int32_t st_maxlocks;<dd>The maximum number of locks possible. +<dt>u_int32_t st_maxlockers;<dd>The maximum number of lockers possible. +<dt>u_int32_t st_maxobjects;<dd>The maximum number of objects possible. +<dt>u_int32_t st_nlocks;<dd>The number of current locks. +<dt>u_int32_t st_maxnlocks;<dd>The maximum number of locks at any one time. +<dt>u_int32_t st_nlockers;<dd>The number of current lockers. +<dt>u_int32_t st_maxnlockers;<dd>The maximum number of lockers at any one time. +<dt>u_int32_t st_nobjects;<dd>The number of current objects. +<dt>u_int32_t st_maxnobjects;<dd>The maximum number of objects at any one time. +<dt>u_int32_t st_nrequests;<dd>The total number of locks requested. +<dt>u_int32_t st_nreleases;<dd>The total number of locks released. +<dt>u_int32_t st_nnowaits;<dd>The total number of lock requests that failed because +<a href="../api_c/lock_vec.html#DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a> was set. +<dt>u_int32_t st_nconflicts;<dd>The total number of locks not immediately available due to conflicts. +<dt>u_int32_t st_ndeadlocks;<dd>The number of deadlocks detected. +<dt>u_int32_t st_regsize;<dd>The size of the region. +<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before +obtaining the region lock. +<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain +the region lock without waiting. +</dl> +<p>The lock_stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The lock_stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the lock_stat function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/lock_vec.html b/bdb/docs/api_c/lock_vec.html new file mode 100644 index 00000000000..56d3fa96a98 --- /dev/null +++ b/bdb/docs/api_c/lock_vec.html @@ -0,0 +1,123 @@ +<!--$Id: lock_vec.so,v 10.31 2000/12/04 18:05:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: lock_vec</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>lock_vec</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +lock_vec(DB_ENV *env, u_int32_t locker, u_int32_t flags, + DB_LOCKREQ list[], int nlist, DB_LOCKREQ **elistp); +</pre></h3> +<h1>Description</h1> +<p>The lock_vec function atomically obtains and releases one or more locks +from the lock table. The lock_vec function is intended to support +acquisition or trading of multiple locks under one lock table semaphore, +as is needed for lock coupling or in multigranularity locking for lock +escalation. +<p>The <b>locker</b> argument specified to lock_vec is an unsigned +32-bit integer quantity. It represents the entity requesting or releasing +the lock. +<p>The <b>flags</b> value must be set to 0 or the following value: +<p><dl compact> +<p><dt><a name="DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a><dd>If a lock cannot be immediately granted because the requested lock +conflicts with an existing lock, return instead of waiting for the lock +to become available. +</dl> +<p>The <b>list</b> array provided to lock_vec is typedef'd as +DB_LOCKREQ. A DB_LOCKREQ structure has at least the following fields, +which must be initialized before calling lock_vec: +<p><dl compact> +<p><dt>lockop_t <a name="op">op</a>;<dd>The operation to be performed, which must be set to one of the +following values: +<p><dl compact> +<p><dt><a name="DB_LOCK_GET">DB_LOCK_GET</a><dd>Get a lock, as defined by the values of <b>locker</b>, <b>obj</b>, +and <b>mode</b>. Upon return from lock_vec, if the +<b>lock</b> field is non-NULL, a reference to the acquired lock is +stored there. (This reference is invalidated by any call to +lock_vec or <a href="../api_c/lock_put.html">lock_put</a> that releases the lock.) +<p><dt><a name="DB_LOCK_PUT">DB_LOCK_PUT</a><dd>The lock referenced by the contents of the <b>lock</b> field is released. +<p><dt><a name="DB_LOCK_PUT_ALL">DB_LOCK_PUT_ALL</a><dd>All locks held by the <b>locker</b> are released. (Any locks acquired +as a part of the current call to lock_vec that appear after the +DB_LOCK_PUT_ALL entry are not considered for this +operation). +<p><dt><a name="DB_LOCK_PUT_OBJ">DB_LOCK_PUT_OBJ</a><dd>All locks held on the object <b>obj</b> are released. The <b>mode</b> +and <b>locker</b> parameters are ignored. Note that any locks acquired +as a part of the current call to lock_vec that occur before the +DB_LOCK_PUT_OBJ will also be released; those acquired afterwards +will not be released. +</dl> +<p><dt>const DBT <a name="obj">obj</a>;<dd>An untyped byte string that specifies the object to be locked or released. +<p><dt>const lockmode_t <a name="mode">mode</a>;<dd>The lock mode, used as an index into the environment's lock conflict array. +See <a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a> and <a href="../ref/lock/stdmode.html">Standard Lock Modes</a> for a description of that array. +<p><dt>DB_LOCK <a name="lock">lock</a>;<dd>A lock reference. +</dl> +<p>The <b>nlist</b> argument specifies the number of elements in the +<b>list</b> array. +<p>If any of the requested locks cannot be acquired, or any of the locks to +be released cannot be released, the operations before the failing +operation are guaranteed to have completed successfully, and +lock_vec returns a non-zero value. In addition, if <b>elistp</b> +is not NULL, it is set to point to the DB_LOCKREQ entry that was being +processed when the error occurred. +<p>The lock_vec function may +return +one of the following values: +<p><dl compact> +<p><dt><a name="DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a><dd>A lock was requested that could not be immediately granted and the +<b>flag</b> parameter was set to DB_LOCK_NOWAIT. In this case, if +non-NULL, <b>elistp</b> identifies the request that was not granted. +</dl> +<p>Otherwise, the lock_vec function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The lock_vec function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>DB_LOCK_DEADLOCK<dd>The operation was selected to resolve a deadlock. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>The maximum number of locks has been reached. +</dl> +<p>The lock_vec function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the lock_vec function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lk_conflicts.html">DBENV->set_lk_conflicts</a>, +<a href="../api_c/env_set_lk_detect.html">DBENV->set_lk_detect</a>, +<a href="../api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a>, +<a href="../api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a>, +<a href="../api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a>, +<a href="../api_c/env_set_lk_max.html">DBENV->set_lk_max</a>, +<a href="../api_c/lock_detect.html">lock_detect</a>, +<a href="../api_c/lock_get.html">lock_get</a>, +<a href="../api_c/lock_id.html">lock_id</a>, +<a href="../api_c/lock_put.html">lock_put</a>, +<a href="../api_c/lock_stat.html">lock_stat</a> +and +<a href="../api_c/lock_vec.html">lock_vec</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_archive.html b/bdb/docs/api_c/log_archive.html new file mode 100644 index 00000000000..6c9aea26b8d --- /dev/null +++ b/bdb/docs/api_c/log_archive.html @@ -0,0 +1,102 @@ +<!--$Id: log_archive.so,v 10.26 2000/05/25 13:47:07 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_archive</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_archive</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_archive(DB_ENV *env, char *(*listp)[], + u_int32_t flags, void *(*db_malloc)(size_t)); +</pre></h3> +<h1>Description</h1> +<p>The log_archive function +creates a NULL-terminated array of log or database file names and copies +a pointer to them into the user-specified memory location <b>listp</b>. +<p>By default, log_archive returns the names of all of the log files +that are no longer in use (e.g., no longer involved in active transactions), +and that may safely be archived for catastrophic recovery and then removed +from the system. If there were no file names to return, the memory location +referenced by <b>listp</b> will be set to NULL. +<p>Arrays of log file names are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<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_ARCH_ABS">DB_ARCH_ABS</a><dd>All pathnames are returned as absolute pathnames, +instead of relative to the database home directory. +<p><dt><a name="DB_ARCH_DATA">DB_ARCH_DATA</a><dd>Return the database files that need to be archived in order to recover +the database from catastrophic failure. If any of the database files +have not been accessed during the lifetime of the current log files, +log_archive will not include them in this list. It is also +possible that some of the files referenced in the log have since been +deleted from the system. +<p><dt><a name="DB_ARCH_LOG">DB_ARCH_LOG</a><dd>Return all the log file names regardless of whether or not they are in +use. +</dl> +<p>The DB_ARCH_DATA and DB_ARCH_LOG flags are mutually +exclusive. +<p>See the <a href="../utility/db_archive.html">db_archive</a> manual page for more information on database +archival procedures. +<p>The log_archive function is the underlying function used by the <a href="../utility/db_archive.html">db_archive</a> utility. +See the <a href="../utility/db_archive.html">db_archive</a> utility source code for an example of using log_archive +in a IEEE/ANSI Std 1003.1 (POSIX) environment. +<p>The log_archive function returns a non-zero error value on failure and 0 on success. +<h1>Bugs</h1> +<p>In a threaded application (i.e., one where the environment was created +with the DB_THREAD flag specified), calling log_archive with the +DB_ARCH_DATA flag will fail, returning EINVAL. To work around this +problem, re-open the log explicitly without specifying DB_THREAD. This +restriction is expected to be removed in a future version of Berkeley DB. +<h1>Errors</h1> +<p>The log_archive function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The log was corrupted. +</dl> +<p>The log_archive function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_archive function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_compare.html b/bdb/docs/api_c/log_compare.html new file mode 100644 index 00000000000..c6e7743beb1 --- /dev/null +++ b/bdb/docs/api_c/log_compare.html @@ -0,0 +1,51 @@ +<!--$Id: log_compare.so,v 10.12 1999/12/20 08:52:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_compare</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_compare</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_compare(const DB_LSN *lsn0, const DB_LSN *lsn1); +</pre></h3> +<h1>Description</h1> +<p>The log_compare function allows the caller to compare two +DB_LSN structures, +returning 0 if they are equal, 1 if <b>lsn0</b> is greater than +<b>lsn1</b>, and -1 if <b>lsn0</b> is less than <b>lsn1</b>. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_file.html b/bdb/docs/api_c/log_file.html new file mode 100644 index 00000000000..434380cccb0 --- /dev/null +++ b/bdb/docs/api_c/log_file.html @@ -0,0 +1,76 @@ +<!--$Id: log_file.so,v 10.18 2000/03/01 21:41:29 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_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> +<table><tr valign=top> +<td> +<h1>log_file</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_file(DB_ENV *env, + const DB_LSN *lsn, char *namep, size_t len); +</pre></h3> +<h1>Description</h1> +<p>The log_file function maps +DB_LSN structures +to file names, +copying the name of the file containing the record named by <b>lsn</b> +into the memory location referenced by <b>namep</b>. +<p>The <b>len</b> argument is the length of the <b>namep</b> buffer in bytes. +If <b>namep</b> is too short to hold the file name, log_file will +return ENOMEM. +(Log file names are normally quite short, on the order of 10 characters.) +<p>This mapping of +DB_LSN structures +to files is needed for database administration. For example, a +transaction manager typically records the earliest +DB_LSN +needed for restart, and the database administrator may want to archive +log files to tape when they contain only +DB_LSN +entries before the earliest one needed for restart. +<p>The log_file function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_file function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>ENOMEM<dd>The supplied buffer was too small to hold the log file name. +</dl> +<p>The log_file function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_file function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_flush.html b/bdb/docs/api_c/log_flush.html new file mode 100644 index 00000000000..1315fc10670 --- /dev/null +++ b/bdb/docs/api_c/log_flush.html @@ -0,0 +1,62 @@ +<!--$Id: log_flush.so,v 10.18 2000/03/01 21:41:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_flush</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_flush</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_flush(DB_ENV *env, const DB_LSN *lsn); +</pre></h3> +<h1>Description</h1> +<p>The log_flush function guarantees that all log records whose +DB_LSN values +are less than or equal to the <b>lsn</b> argument have been +written to disk. If <b>lsn</b> is NULL, all records in the +log are flushed. +<p>The log_flush function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_flush function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The log_flush function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_flush function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_get.html b/bdb/docs/api_c/log_get.html new file mode 100644 index 00000000000..05761e1ea30 --- /dev/null +++ b/bdb/docs/api_c/log_get.html @@ -0,0 +1,114 @@ +<!--$Id: log_get.so,v 10.22 2000/03/17 01:53:59 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_get</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_get</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_get(DB_ENV *env, DB_LSN *lsn, DBT *data, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The log_get function implements a cursor inside of the log, +retrieving records from the log according to the <b>lsn</b> and +<b>flags</b> arguments. +<p>The data field of the <b>data</b> structure is set to the record +retrieved and the size field indicates the number of bytes in the record. +See <a href="../api_c/dbt.html">DBT</a> for a description of other fields in the <b>data</b> +structure. When multiple threads are using the returned log handle +concurrently, one of the <a href="../api_c/dbt.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, <a href="../api_c/dbt.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> or +<a href="../api_c/dbt.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags must be specified for any <a href="../api_c/dbt.html">DBT</a> used +for data retrieval. +<p>The <b>flags</b> argument must be set to exactly one of the following values: +<p><dl compact> +<p><dt><a name="DB_CHECKPOINT">DB_CHECKPOINT</a><dd>The last record written with the DB_CHECKPOINT flag specified to the +<a href="../api_c/log_put.html">log_put</a> function is returned in the <b>data</b> argument. The +<b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the record +returned. If no record has been previously written with the DB_CHECKPOINT +flag specified, the first record in the log is returned. +<p>If the log is empty, the log_get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_FIRST">DB_FIRST</a><dd>The first record from any of the log files found in the log directory +is returned in the <b>data</b> argument. +The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the +record returned. +<p>If the log is empty, the log_get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_LAST">DB_LAST</a><dd>The last record in the log is returned in the <b>data</b> argument. +The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the +record returned. +<p>If the log is empty, the log_get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p><dt><a name="DB_NEXT">DB_NEXT</a><dd>The current log position is advanced to the next record in the log and that +record is returned in the <b>data</b> argument. +The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the +record returned. +<p>If the pointer has not been initialized via DB_FIRST, DB_LAST, DB_SET, +DB_NEXT, or DB_PREV, log_get will return the first record in the log. +If the last log record has already been returned or the log is empty, the +log_get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p>If the log was opened with the DB_THREAD flag set, calls to +log_get with the DB_NEXT flag set will return EINVAL. +<p><dt><a name="DB_PREV">DB_PREV</a><dd>The current log position is moved to the previous record in the log and that +record is returned in the <b>data</b> argument. +The <b>lsn</b> argument is overwritten with the <a href="../api_c/db_lsn.html">DB_LSN</a> of the +record returned. +<p>If the pointer has not been initialized via DB_FIRST, DB_LAST, DB_SET, +DB_NEXT, or DB_PREV, +log_get will return the last record in the log. +If the first log record has already been returned or the log is empty, the +log_get function will return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. +<p>If the log was opened with the DB_THREAD flag set, calls to +log_get with the DB_PREV flag set will return EINVAL. +<p><dt><a name="DB_CURRENT">DB_CURRENT</a><dd>Return the log record currently referenced by the log. +<p>If the log pointer has not been initialized via DB_FIRST, DB_LAST, DB_SET, +DB_NEXT, or DB_PREV, or if the log was opened with the DB_THREAD flag set, +log_get will return EINVAL. +<p><dt><a name="DB_SET">DB_SET</a><dd>Retrieve the record specified by the <b>lsn</b> argument. If the +specified <a href="../api_c/db_lsn.html">DB_LSN</a> is invalid (e.g., does not appear in the log) +log_get will return EINVAL. +</dl> +<p>Otherwise, the log_get function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_get function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The DB_FIRST flag was specified and no log files were found. +</dl> +<p>The log_get function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_get function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_put.html b/bdb/docs/api_c/log_put.html new file mode 100644 index 00000000000..9455296986e --- /dev/null +++ b/bdb/docs/api_c/log_put.html @@ -0,0 +1,81 @@ +<!--$Id: log_put.so,v 10.21 2000/03/17 01:53:59 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_put</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_put</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_put(DB_ENV *env, + DB_LSN *lsn, const DBT *data, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The log_put function appends records to the log. The <a href="../api_c/db_lsn.html">DB_LSN</a> of +the put record is returned in the <b>lsn</b> argument. The <b>flags</b> +argument may be set to one of the following values: +<p><dl compact> +<p><dt><a name="DB_CHECKPOINT">DB_CHECKPOINT</a><dd>The log should write a checkpoint record, recording any information +necessary to make the log structures recoverable after a crash. +<p><dt><a name="DB_CURLSN">DB_CURLSN</a><dd>The <a href="../api_c/db_lsn.html">DB_LSN</a> of the next record to be put is returned in the +<b>lsn</b> argument. +<p><dt><a name="DB_FLUSH">DB_FLUSH</a><dd>The log is forced to disk after this record is written, guaranteeing +that all records with <a href="../api_c/db_lsn.html">DB_LSN</a> values less than or equal to the +one being put are on disk before this function returns (this function +is most often used for a transaction commit, see <a href="../api_c/txn_commit.html">txn_commit</a> for +more information). +<p>The caller is responsible for providing any necessary structure to +<b>data</b>. (For example, in a write-ahead logging protocol, the +application must understand what part of <b>data</b> is an operation +code, what part is redo information, and what part is undo information. +In addition, most transaction managers will store in <b>data</b> the +<a href="../api_c/db_lsn.html">DB_LSN</a> of the previous log record for the same transaction, to +support chaining back through the transaction's log records during +undo.) +</dl> +<p>The log_put function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The <a href="../api_c/log_flush.html">log_flush</a> function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The record to be logged is larger than the maximum log record. +</dl> +<p>The log_put function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_put function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_register.html b/bdb/docs/api_c/log_register.html new file mode 100644 index 00000000000..e993feabed2 --- /dev/null +++ b/bdb/docs/api_c/log_register.html @@ -0,0 +1,64 @@ +<!--$Id: log_register.so,v 10.27 2000/05/09 14:46:45 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_register</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_register</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_register(DB_ENV *env, DB *dbp, const char *name); +</pre></h3> +<h1>Description</h1> +<p>The log_register function registers a file name with the specified Berkeley DB +environment's log manager. The log manager records all file name mappings +at each checkpoint so that a recovery process can identify the file to +which a record in the log refers. +<p>The <b>dbp</b> argument should be a reference to the DB structure being +registered. The <b>name</b> argument should be a file name appropriate +for opening the file in the environment, during recovery. +<p>The log_register function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_register function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The log_register function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_register function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_stat.html b/bdb/docs/api_c/log_stat.html new file mode 100644 index 00000000000..819c603d318 --- /dev/null +++ b/bdb/docs/api_c/log_stat.html @@ -0,0 +1,90 @@ +<!--$Id: log_stat.so,v 10.23 2000/05/25 13:47:08 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_stat</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_stat(DB_ENV *env, + DB_LOG_STAT **spp, void *(*db_malloc)(size_t)); +</pre></h3> +<h1>Description</h1> +<p>The log_stat function +creates a statistical structure and copies a pointer to it into a +user-specified memory location. +<p>Statistical structures are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<p>The log region statistics are stored in a structure of type DB_LOG_STAT. +The following DB_LOG_STAT fields will be filled in: +<p><dl compact> +<dt>u_int32_t st_magic;<dd>The magic number that identifies a file as a log file. +<dt>u_int32_t st_version;<dd>The version of the log file type. +<dt>u_int32_t st_regsize;<dd>The size of the region. +<dt>int st_mode;<dd>The mode of any created log files. +<dt>u_int32_t st_lg_bsize;<dd>The in-memory log record cache size. +<dt>u_int32_t st_lg_max;<dd>The maximum size of any individual file comprising the log. +<dt>u_int32_t st_w_mbytes;<dd>The number of megabytes written to this log. +<dt>u_int32_t st_w_bytes;<dd>The number of bytes over and above <b>st_w_mbytes</b> written to this log. +<dt>u_int32_t st_wc_mbytes;<dd>The number of megabytes written to this log since the last checkpoint. +<dt>u_int32_t st_wc_bytes;<dd>The number of bytes over and above <b>st_wc_mbytes</b> written to this log +since the last checkpoint. +<dt>u_int32_t st_wcount;<dd>The number of times the log has been written to disk. +<dt>u_int32_t st_wcount_fill;<dd>The number of times the log has been written to disk because the +in-memory log record cache filled up. +<dt>u_int32_t st_scount;<dd>The number of times the log has been flushed to disk. +<dt>u_int32_t st_cur_file;<dd>The current log file number. +<dt>u_int32_t st_cur_offset;<dd>The byte offset in the current log file. +<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before +obtaining the region lock. +<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain +the region lock without waiting. +</dl> +<p>The log_stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_stat function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/log_unregister.html b/bdb/docs/api_c/log_unregister.html new file mode 100644 index 00000000000..cfc1e6f2e5d --- /dev/null +++ b/bdb/docs/api_c/log_unregister.html @@ -0,0 +1,59 @@ +<!--$Id: log_unregister.so,v 10.21 2000/05/03 22:39:10 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: log_unregister</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>log_unregister</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +log_unregister(DB_ENV *env, DB *dbp); +</pre></h3> +<h1>Description</h1> +<p>The log_unregister function function unregisters the file represented by +the <b>dbp</b> parameter from the Berkeley DB environment's log manager. +<p>The log_unregister function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The log_unregister function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The log_unregister function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the log_unregister function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a>, +<a href="../api_c/env_set_lg_max.html">DBENV->set_lg_max</a>, +<a href="../api_c/log_archive.html">log_archive</a>, +<a href="../api_c/log_compare.html">log_compare</a>, +<a href="../api_c/log_file.html">log_file</a>, +<a href="../api_c/log_flush.html">log_flush</a>, +<a href="../api_c/log_get.html">log_get</a>, +<a href="../api_c/log_put.html">log_put</a>, +<a href="../api_c/log_register.html">log_register</a>, +<a href="../api_c/log_stat.html">log_stat</a> +and +<a href="../api_c/log_unregister.html">log_unregister</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_fclose.html b/bdb/docs/api_c/memp_fclose.html new file mode 100644 index 00000000000..ae8ce3c5647 --- /dev/null +++ b/bdb/docs/api_c/memp_fclose.html @@ -0,0 +1,61 @@ +<!--$Id: memp_fclose.so,v 10.20 2000/06/13 13:55:49 sue Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_fclose</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_fclose</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_fclose(DB_MPOOLFILE *mpf); +</pre></h3> +<h1>Description</h1> +<p>The memp_fclose function closes the source file indicated by the +DB_MPOOLFILE structure. Calling memp_fclose does not imply +a call to <a href="../api_c/memp_fsync.html">memp_fsync</a>, i.e. no pages are written to the source +file as as a result of calling memp_fclose. +<p>In addition, if the <b>file</b> argument to <a href="../api_c/memp_fopen.html">memp_fopen</a> was NULL, +any underlying files created for this DB_MPOOLFILE will be removed. +<p>Once memp_fclose has been called, regardless of its return, the +DB_MPOOLFILE handle may not be accessed again. +<p>The memp_fclose function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_fclose function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_fclose function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_fget.html b/bdb/docs/api_c/memp_fget.html new file mode 100644 index 00000000000..84b39e53ee1 --- /dev/null +++ b/bdb/docs/api_c/memp_fget.html @@ -0,0 +1,98 @@ +<!--$Id: memp_fget.so,v 10.23 2000/12/04 18:05:39 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_fget</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_fget</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_fget(DB_MPOOLFILE *mpf, + db_pgno_t *pgnoaddr, u_int32_t flags, void **pagep); +</pre></h3> +<h1>Description</h1> +<p>The memp_fget function copies a pointer to the page with the page +number specified by <b>pgnoaddr</b>, from the source file in the +DB_MPOOLFILE, into the memory location referenced by <b>pagep</b>. +If the page does not exist or cannot be retrieved, memp_fget will +fail. +<p><b>Page numbers begin at 0, i.e., the first page in the file is page number +0, not page number 1.</b> +<p>The returned page is <b>size_t</b> type aligned. +<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_MPOOL_CREATE">DB_MPOOL_CREATE</a><dd>If the specified page does not exist, create it. In this case, the +<a href="memp_register.html#pgin">pgin</a> function, if specified, is +called. +<p><dt><a name="DB_MPOOL_LAST">DB_MPOOL_LAST</a><dd>Return the last page of the source file and copy its page number +to the location referenced by <b>pgnoaddr</b>. +<p><dt><a name="DB_MPOOL_NEW">DB_MPOOL_NEW</a><dd>Create a new page in the file and copy its page number to the location +referenced by <b>pgnoaddr</b>. In this case, the +<a href="memp_register.html#pgin">pgin</a> function, if specified, is +<b>not</b> called. +</dl> +<p>The DB_MPOOL_CREATE, DB_MPOOL_LAST and +DB_MPOOL_NEW flags are mutually exclusive. +<p>Created pages have all their bytes set to 0, unless otherwise specified +when the file was opened. +<p>All pages returned by memp_fget will be retained (i.e. +<i>pinned</i>), in the pool until a subsequent call to +<a href="../api_c/memp_fput.html">memp_fput</a>. +<p>The memp_fget function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_fget function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EAGAIN<dd>The page reference count has overflowed. (This should never happen unless +there's a bug in the application.) +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The DB_MPOOL_NEW flag was set and the source file was not opened for writing. +<p>More than one of DB_MPOOL_CREATE, DB_MPOOL_LAST and DB_MPOOL_NEW was set. +</dl> +<p><dl compact> +<p><dt>EIO<dd>The requested page does not exist and DB_MPOOL_CREATE was not set. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>The cache is full and no more pages will fit in the pool. +</dl> +<p>The memp_fget function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_fget function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_fopen.html b/bdb/docs/api_c/memp_fopen.html new file mode 100644 index 00000000000..ea0250246cb --- /dev/null +++ b/bdb/docs/api_c/memp_fopen.html @@ -0,0 +1,157 @@ +<!--$Id: memp_fopen.so,v 10.28 2000/12/18 21:05:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_fopen</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_fopen</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_fopen(DB_ENV *env, char *file, u_int32_t flags, + int mode, size_t pagesize, DB_MPOOL_FINFO *finfop, + DB_MPOOLFILE **mpf); +</pre></h3> +<h1>Description</h1> +<p>The memp_fopen function opens a file in the pool specified by the +DB_ENV <b>env</b>, copying the DB_MPOOLFILE pointer +representing it into the memory location referenced by <b>mpf</b>. +<p>The <b>file</b> argument is the name of the file to be opened. +If <b>file</b> is NULL, a private file is created that cannot be +shared with any other process (although it may be shared with +other threads). +<p>The <b>flags</b> and <b>mode</b> arguments specify how files will be opened +and/or created if they do not already exist. +<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_CREATE">DB_CREATE</a><dd>Create any underlying files, as necessary. If the files do not already +exist and the DB_CREATE flag is not specified, the call will fail. +<p><dt><a name="DB_NOMMAP">DB_NOMMAP</a><dd>Always copy this file into the local cache instead of potentially mapping +it into process memory (see the description of the +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a> function for further information). +<p><dt><a name="DB_RDONLY">DB_RDONLY</a><dd>Open any underlying files for reading only. Any attempt to write the file +using the pool functions will fail, regardless of the actual permissions +of the file. +</dl> +<p>On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by function memp_fopen +are created with mode <b>mode</b> (as described in <b>chmod</b>(2)) and +modified by the process' umask value at the time of creation (see +<b>umask</b>(2)). The group ownership of created files is based on +the system and directory defaults, and is not further specified by Berkeley DB. +If <b>mode</b> is 0, files are created readable and writeable by both +owner and group. On Windows systems, the mode argument is ignored. +<p>The <b>pagesize</b> argument is the size, in bytes, of the unit of transfer +between the application and the pool, although it is not necessarily the +unit of transfer between the pool and the source file. +<p>Files opened in the pool may be further configured based on the +<b>finfop</b> argument to memp_fopen (which is a pointer to a +structure of type DB_MPOOL_FINFO). No references to the <b>finfop</b> +structure are maintained by Berkeley DB, so it may be discarded when the +memp_fopen function returns. In order to ensure compatibility +with future releases of Berkeley DB, all fields of the DB_MPOOL_FINFO structure +that are not explicitly set should be initialized to 0 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>The fields of the DB_MPOOL_FINFO structure used by memp_fopen are +described below. If <b>finfop</b> is NULL or any of its fields are +set to their default value, defaults appropriate for the system are used. +<p><dl compact> +<p><dt>int <a name="ftype">ftype</a>;<dd>The <b>ftype</b> field should be the same as a <b>ftype</b> argument +previously specified to the <a href="../api_c/memp_register.html">memp_register</a> function, unless no +input or output processing of the file's pages are necessary, in which +case it should be 0. (See the description of the <a href="../api_c/memp_register.html">memp_register</a> +function for more information.) +<p><dt>DBT *<a name="pgcookie">pgcookie</a>;<dd>The <b>pgcookie</b> field contains the byte string that is passed to the +<b>pgin</b> and <b>pgout</b> functions for this file, if any. If no +<b>pgin</b> or <b>pgout</b> functions are specified, the +<b>pgcookie</b> field should be NULL. (See the description of the +<a href="../api_c/memp_register.html">memp_register</a> function for more information.) +<p><dt>u_int8_t *<a name="fileid">fileid</a>;<dd>The <b>fileid</b> field is a unique identifier for the file. If the +<b>fileid</b> field is non-NULL, it must reference a DB_FILE_ID_LEN +length array of bytes that will be used to uniquely identify the file. +<p>The mpool functions must be able to uniquely identify files in order that +multiple processes wanting to share a file will correctly identify it in +the pool. +<p>On most UNIX/POSIX systems, the <b>fileid</b> field will not need to be +set and the mpool functions will simply use the file's device and inode +numbers for this purpose. On Windows systems, the mpool functions use +the values returned by GetFileInformationByHandle() by default -- these +values are known to be constant between processes and over reboot in the +case of NTFS (where they are the NTFS MFT indexes). +<p>On other filesystems, (e.g., FAT or NFS) these default values are not +necessarily unique between processes or across system reboots. +<b>Applications wanting to maintain a shared memory buffer pool +between processes or across system reboots, where the pool contains pages +from files stored on such filesystems, must specify a unique file +identifier to the memp_fopen call and each process opening or +registering the file must provide the same unique identifier.</b> +<p>This should not be necessary for most applications. Specifically, it is +not necessary if the memory pool is not shared between processes and is +re-instantiated after each system reboot, or the application is using the +Berkeley DB access methods instead of calling the pool functions explicitly, or +the files in the memory pool are stored on filesystems where the default +values as described above are invariant between process and across system +reboots. +<p><dt>int32_t <a name="lsn_offset">lsn_offset</a>;<dd>The <b>lsn_offset</b> field is the zero-based byte offset in the page of +the page's log sequence number (LSN), or -1 if no LSN offset is specified. +(See the description of the <a href="../api_c/memp_sync.html">memp_sync</a> function for more +information.) +<p><dt>u_int32_t <a name="clear_len">clear_len</a>;<dd>The <b>clear_len</b> field is the number of initial bytes in a page +that should be set to zero when the page is created as a result of the +DB_MPOOL_CREATE or DB_MPOOL_NEW flags being specified to <a href="../api_c/memp_fget.html">memp_fget</a>. +If <b>finfop</b> is NULL or <b>clear_len</b> is 0, the entire page is +cleared. +</dl> +<p>The memp_fopen function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_fopen function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The file has already been entered into the pool, and the <b>pagesize</b> +value is not the same as when the file was entered into the pool, or the +length of the file is not zero or a multiple of the <b>pagesize</b>. +<p>The DB_RDONLY flag was specified for an in-memory pool. +</dl> +<p><dl compact> +<p><dt>ENOMEM<dd>The maximum number of open files has been reached. +</dl> +<p>The memp_fopen function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_fopen function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_fput.html b/bdb/docs/api_c/memp_fput.html new file mode 100644 index 00000000000..ce382b4d034 --- /dev/null +++ b/bdb/docs/api_c/memp_fput.html @@ -0,0 +1,79 @@ +<!--$Id: memp_fput.so,v 10.18 2000/03/01 21:41:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_fput</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_fput</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_fput(DB_MPOOLFILE *mpf, void *pgaddr, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The memp_fput function indicates that the page referenced by +<b>pgaddr</b> can be evicted from the pool. The <b>pgaddr</b> +argument must be an address previously returned by <a href="../api_c/memp_fget.html">memp_fget</a>. +<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_MPOOL_CLEAN">DB_MPOOL_CLEAN</a><dd>Clear any previously set modification information (i.e., don't bother +writing the page back to the source file). +<p><dt><a name="DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a><dd>The page has been modified and must be written to the source file +before being evicted from the pool. +<p><dt><a name="DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a><dd>The page is unlikely to be useful in the near future, +and should be discarded before other pages in the pool. +</dl> +<p>The DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags are +mutually exclusive. +<p>The memp_fput function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_fput function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EACCES<dd>The DB_MPOOL_DIRTY flag was set and the source file was not opened for +writing. +</dl> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The <b>pgaddr</b> parameter does not reference a page returned by +<a href="../api_c/memp_fget.html">memp_fget</a>. +<p>More than one of DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags was set. +</dl> +<p>The memp_fput function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_fput function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_fset.html b/bdb/docs/api_c/memp_fset.html new file mode 100644 index 00000000000..73acd322c4e --- /dev/null +++ b/bdb/docs/api_c/memp_fset.html @@ -0,0 +1,72 @@ +<!--$Id: memp_fset.so,v 10.18 2000/03/01 21:41:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_fset</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_fset</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_fset(DB_MPOOLFILE *mpf, void *pgaddr, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The memp_fset function sets the flags associated with the page referenced +by <b>pgaddr</b> without unpinning it from the pool. The <b>pgaddr</b> +argument must be an address previously returned by <a href="../api_c/memp_fget.html">memp_fget</a>. +<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_MPOOL_CLEAN">DB_MPOOL_CLEAN</a><dd>Clear any previously set modification information (i.e., don't bother +writing the page back to the source file). +<p><dt><a name="DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a><dd>The page has been modified and must be written to the source file +before being evicted from the pool. +<p><dt><a name="DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a><dd>The page is unlikely to be useful in the near future, +and should be discarded before other pages in the pool. +</dl> +<p>The DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags are +mutually exclusive. +<p>The memp_fset function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_fset function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The memp_fset function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_fset function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_fsync.html b/bdb/docs/api_c/memp_fsync.html new file mode 100644 index 00000000000..ad429ccf390 --- /dev/null +++ b/bdb/docs/api_c/memp_fsync.html @@ -0,0 +1,59 @@ +<!--$Id: memp_fsync.so,v 10.22 2000/09/08 15:20:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_fsync</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_fsync</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_fsync(DB_MPOOLFILE *mpf); +</pre></h3> +<h1>Description</h1> +<p>The memp_fsync function writes all pages associated with the +DB_MPOOLFILE, that were marked as modified using <a href="../api_c/memp_fput.html">memp_fput</a> +or <a href="../api_c/memp_fset.html">memp_fset</a>, back to the source file. If any of the modified +pages are also <i>pinned</i> (i.e., currently referenced by this or +another process) memp_fsync will ignore them. +<p>The memp_fsync function returns a non-zero error value on failure, 0 on success, and returns <a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> if there were pages which were +modified but which memp_fsync was unable to write immediately. +<h1>Errors</h1> +<p>The memp_fsync function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_fsync function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_register.html b/bdb/docs/api_c/memp_register.html new file mode 100644 index 00000000000..7c50a89ed2b --- /dev/null +++ b/bdb/docs/api_c/memp_register.html @@ -0,0 +1,93 @@ +<!--$Id: memp_register.so,v 10.23 2000/05/25 13:47:08 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_register</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_register</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_register(DB_ENV *env, int ftype, + int (*pgin_fcn)(DB_ENV *, db_pgno_t pgno, void *pgaddr, DBT *pgcookie), + int (*pgout_fcn)(DB_ENV *, db_pgno_t pgno, void *pgaddr, DBT *pgcookie)); +</pre></h3> +<h1>Description</h1> +<p>The memp_register function registers page-in and page-out +functions for files of type <b>ftype</b> in the specified pool. +<p>If the <b>pgin_fcn</b> function is non-NULL, it is called each time +a page is read into the memory pool from a file of type <b>ftype</b>, or +a page is created for a file of type <b>ftype</b> (see the +DB_MPOOL_CREATE flag for the <a href="../api_c/memp_fget.html">memp_fget</a> function). +<p>If the <b>pgout_fcn</b> function is non-NULL, it is called each time +a page is written to a file of type <b>ftype</b>. +<p>Both the <b>pgin_fcn</b> and <b>pgout_fcn</b> functions are called with +a reference to the current environment, the page number, a pointer to the +page being read or written, and any argument <b>pgcookie</b> that was +specified to the <a href="../api_c/memp_fopen.html">memp_fopen</a> function when the file was opened. +The <b>pgin_fcn</b> and <b>pgout_fcn</b> functions should return 0 on +success, and an applicable non-zero <b>errno</b> value on failure, in +which case the shared memory pool interface routine (and, by extension, +any Berkeley DB library function) calling it will also fail, returning that +<b>errno</b> value. +<p>The purpose of the memp_register function is to support processing +when pages are entered into, or flushed from, the pool. A file type must +be specified to make it possible for unrelated threads or processes, that +are sharing a pool, to evict each other's pages from the pool. +Applications should call memp_register, during initialization, +for each type of file requiring input or output processing that will be +sharing the underlying pool. (No registry is necessary for the standard +Berkeley DB access method types, as <a href="../api_c/db_open.html">DB->open</a> registers them +separately.) +<p>If a thread or process does not call memp_register for a file +type, it is impossible for it to evict pages for any file requiring input +or output processing from the pool. For this reason, +memp_register should always be called by each application sharing +a pool for each type of file included in the pool, regardless of whether +or not the application itself uses files of that type. +<p>There are no standard values for <b>ftype</b>, <b>pgin_fcn</b>, +<b>pgout_fcn</b> and <b>pgcookie</b>, except that the <b>ftype</b> +value for a file must be a non-zero positive number, as negative numbers +are reserved for internal use by the Berkeley DB library. For this reason, +applications sharing a pool must coordinate their values amongst +themselves. +<p>The memp_register function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_register function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_register function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_stat.html b/bdb/docs/api_c/memp_stat.html new file mode 100644 index 00000000000..8e9d136a90b --- /dev/null +++ b/bdb/docs/api_c/memp_stat.html @@ -0,0 +1,118 @@ +<!--$Id: memp_stat.so,v 10.28 2000/05/25 13:47:08 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_stat</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_stat(DB_ENV *env, DB_MPOOL_STAT **gsp, + DB_MPOOL_FSTAT *(*fsp)[], void *(*db_malloc)(size_t)); +</pre></h3> +<h1>Description</h1> +<p>The memp_stat function method creates statistical structures and copies +pointers to them into user-specified memory locations. The statistics +include the number of files participating in the pool, the active pages +in the pool, and information as to how effective the cache has been. +<p>Statistical structures are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<p>If <b>gsp</b> is non-NULL, the global statistics for the memory pool +<b>mp</b> are copied into the memory location it references. The +global statistics are stored in a structure of type DB_MPOOL_STAT. +<p>The following DB_MPOOL_STAT fields will be filled in: +<p><dl compact> +<dt>size_t st_gbytes;<dd>Gigabytes of cache (total cache size is st_gbytes + st_bytes) +<dt>size_t st_bytes;<dd>Bytes of cache (total cache size is st_gbytes + st_bytes) +<dt>u_int32_t st_ncache;<dd>Number of caches. +<dt>u_int32_t st_regsize;<dd>Individual cache size. +<dt>u_int32_t st_cache_hit;<dd>Requested pages found in the cache. +<dt>u_int32_t st_cache_miss;<dd>Requested pages not found in the cache. +<dt>u_int32_t st_map;<dd>Requested pages mapped into the process' address space (there is no +available information as to whether or not this request caused disk I/O, +although examining the application page fault rate may be helpful). +<dt>u_int32_t st_page_create;<dd>Pages created in the cache. +<dt>u_int32_t st_page_in;<dd>Pages read into the cache. +<dt>u_int32_t st_page_out;<dd>Pages written from the cache to the backing file. +<dt>u_int32_t st_ro_evict;<dd>Clean pages forced from the cache. +<dt>u_int32_t st_rw_evict;<dd>Dirty pages forced from the cache. +<dt>u_int32_t st_hash_buckets;<dd>Number of hash buckets in buffer hash table. +<dt>u_int32_t st_hash_searches;<dd>Total number of buffer hash table lookups. +<dt>u_int32_t st_hash_longest;<dd>The longest chain ever encountered in buffer hash table lookups. +<dt>u_int32_t st_hash_examined;<dd>Total number of hash elements traversed during hash table lookups. +<dt>u_int32_t st_page_clean;<dd>Clean pages currently in the cache. +<dt>u_int32_t st_page_dirty;<dd>Dirty pages currently in the cache. +<dt>u_int32_t st_page_trickle;<dd>Dirty pages written using the <a href="../api_c/memp_trickle.html">memp_trickle</a> interface. +<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before +obtaining the region lock. +<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain +the region lock without waiting. +</dl> +<p>If <b>fsp</b> is non-NULL, a pointer to a NULL-terminated variable +length array of statistics for individual files, in the memory pool <b>mp</b>, +is copied into the memory location it references. If no individual files +currently exist in the memory pool, <b>fsp</b> will be set to NULL. +<p>The per-file statistics are stored in structures of type DB_MPOOL_FSTAT. +The following DB_MPOOL_FSTAT fields will be filled in for each file in +the pool, i.e., each element of the array: +<p><dl compact> +<dt>char *file_name;<dd>The name of the file. +<dt>size_t st_pagesize;<dd>Page size in bytes. +<dt>u_int32_t st_cache_hit;<dd>Requested pages found in the cache. +<dt>u_int32_t st_cache_miss;<dd>Requested pages not found in the cache. +<dt>u_int32_t st_map;<dd>Requested pages mapped into the process' address space. +<dt>u_int32_t st_page_create;<dd>Pages created in the cache. +<dt>u_int32_t st_page_in;<dd>Pages read into the cache. +<dt>u_int32_t st_page_out;<dd>Pages written from the cache to the backing file. +</dl> +<p>The memp_stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_stat function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The memp_stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_stat function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_sync.html b/bdb/docs/api_c/memp_sync.html new file mode 100644 index 00000000000..fc693d47eff --- /dev/null +++ b/bdb/docs/api_c/memp_sync.html @@ -0,0 +1,83 @@ +<!--$Id: memp_sync.so,v 10.25 2000/09/08 15:20:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_sync</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_sync</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_sync(DB_ENV *env, DB_LSN *lsn); +</pre></h3> +<h1>Description</h1> +<p>The memp_sync function ensures that any modified pages in the pool with +log sequence numbers less than the <b>lsn</b> argument are written to +disk. If <b>lsn</b> is NULL all modified pages in the pool are +flushed. +<p>The primary purpose of the memp_sync function is to enable a +transaction manager to ensure, as part of a checkpoint, that all pages +modified by a certain time have been written to disk. Pages in the pool +that cannot be written back to disk immediately (e.g., that are currently +pinned) are written to disk as soon as it is possible to do so. The +expected behavior of the Berkeley DB or other transaction subsystem is to call +the memp_sync function and then, if the return indicates that some +pages could not be written immediately, to wait briefly and retry again +with the same log sequence number until the memp_sync function +returns that all pages have been written. +<p>To support the memp_sync functionality, it is necessary that the +pool functions know the location of the log sequence number on the page +for each file type. This location should be specified when the file is +opened using the <a href="../api_c/memp_fopen.html">memp_fopen</a> function. It is not required that +the log sequence number be aligned on the page in any way. +<p>The memp_sync function returns a non-zero error value on failure, 0 on success, and returns <a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> if there were pages which need to be +written but which memp_sync was unable to write immediately. +In addition, if memp_sync returns success, the value of +<b>lsn</b> will be overwritten with the largest log sequence number +from any page which was written by memp_sync to satisfy this +request. +<h1>Errors</h1> +<p>The memp_sync function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +<p>The memp_sync function was called without logging having been +initialized in the environment. +</dl> +<p>The memp_sync function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_sync function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/memp_trickle.html b/bdb/docs/api_c/memp_trickle.html new file mode 100644 index 00000000000..d7cfd723020 --- /dev/null +++ b/bdb/docs/api_c/memp_trickle.html @@ -0,0 +1,66 @@ +<!--$Id: memp_trickle.so,v 10.21 2000/03/01 21:41:30 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: memp_trickle</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>memp_trickle</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +memp_trickle(DB_ENV *env, int pct, int *nwrotep); +</pre></h3> +<h1>Description</h1> +<p>The memp_trickle function ensures that at least <b>pct</b> percent of +the pages in the shared memory pool are clean by writing dirty pages to +their backing files. +If the <b>nwrotep</b> argument is non-NULL, the number of pages that +were written to reach the correct percentage is returned in the memory +location it references. +<p>The purpose of the memp_trickle function is to enable a memory +pool manager to ensure that a page is always available for reading in new +information without having to wait for a write. +<p>The memp_trickle function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The memp_trickle function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The memp_trickle function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the memp_trickle function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a>, +<a href="../api_c/memp_fclose.html">memp_fclose</a>, +<a href="../api_c/memp_fget.html">memp_fget</a>, +<a href="../api_c/memp_fopen.html">memp_fopen</a>, +<a href="../api_c/memp_fput.html">memp_fput</a>, +<a href="../api_c/memp_fset.html">memp_fset</a>, +<a href="../api_c/memp_fsync.html">memp_fsync</a>, +<a href="../api_c/memp_register.html">memp_register</a>, +<a href="../api_c/memp_stat.html">memp_stat</a>, +<a href="../api_c/memp_sync.html">memp_sync</a> +and +<a href="../api_c/memp_trickle.html">memp_trickle</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/pindex.src b/bdb/docs/api_c/pindex.src new file mode 100644 index 00000000000..1818c50a6d1 --- /dev/null +++ b/bdb/docs/api_c/pindex.src @@ -0,0 +1,301 @@ +__APIREL__/api_c/db_create.html#2 @db_create +__APIREL__/api_c/db_create.html#DB_XA_CREATE db_create@DB_XA_CREATE +__APIREL__/api_c/db_err.html#2 @DBENV-__GT__err +__APIREL__/api_c/db_lsn.html#2 @DB_LSN +__APIREL__/api_c/db_set_errfile.html#2 @DB-__GT__set_errfile +__APIREL__/api_c/db_set_malloc.html#2 @DB-__GT__set_malloc +__APIREL__/api_c/db_set_paniccall.html#2 @DB-__GT__set_paniccall +__APIREL__/api_c/db_set_realloc.html#2 @DB-__GT__set_realloc +__APIREL__/api_c/dbm.html#2 @dbm/ndbm +__APIREL__/api_c/dbt.html#2 @key/data pairs +__APIREL__/api_c/dbt.html#data DBT@data +__APIREL__/api_c/dbt.html#size DBT@size +__APIREL__/api_c/dbt.html#ulen DBT@ulen +__APIREL__/api_c/dbt.html#dlen DBT@dlen +__APIREL__/api_c/dbt.html#doff DBT@doff +__APIREL__/api_c/dbt.html#DB_DBT_MALLOC DBT@DB_DBT_MALLOC +__APIREL__/api_c/dbt.html#DB_DBT_REALLOC DBT@DB_DBT_REALLOC +__APIREL__/api_c/dbt.html#DB_DBT_USERMEM DBT@DB_DBT_USERMEM +__APIREL__/api_c/dbt.html#DB_DBT_PARTIAL DBT@DB_DBT_PARTIAL +__APIREL__/api_c/dbt.html#3 retrieved key/data @permanence +__APIREL__/api_c/dbt.html#4 retrieved @key/data permanence +__APIREL__/api_c/dbt.html#5 data @alignment +__APIREL__/api_c/dbt.html#6 logical @record number format +__APIREL__/api_c/env_create.html#2 @db_env_create +__APIREL__/api_c/env_create.html#DB_CLIENT db_env_create@DB_CLIENT +__APIREL__/api_c/env_set_errfile.html#2 @DBENV-__GT__set_errfile +__APIREL__/api_c/env_set_paniccall.html#2 @DBENV-__GT__set_paniccall +__APIREL__/api_c/hsearch.html#2 @hsearch +__APIREL__/api_c/set_func_close.html#2 @db_env_set_func_close +__APIREL__/api_c/set_func_dirfree.html#2 @db_env_set_func_dirfree +__APIREL__/api_c/set_func_dirlist.html#2 @db_env_set_func_dirlist +__APIREL__/api_c/set_func_exists.html#2 @db_env_set_func_exists +__APIREL__/api_c/set_func_free.html#2 @db_env_set_func_free +__APIREL__/api_c/set_func_fsync.html#2 @db_env_set_func_fsync +__APIREL__/api_c/set_func_ioinfo.html#2 @db_env_set_func_ioinfo +__APIREL__/api_c/set_func_malloc.html#2 @db_env_set_func_malloc +__APIREL__/api_c/set_func_map.html#2 @db_env_set_func_map +__APIREL__/api_c/set_func_open.html#2 @db_env_set_func_open +__APIREL__/api_c/set_func_read.html#2 @db_env_set_func_read +__APIREL__/api_c/set_func_realloc.html#2 @db_env_set_func_realloc +__APIREL__/api_c/set_func_rename.html#2 @db_env_set_func_rename +__APIREL__/api_c/set_func_seek.html#2 @db_env_set_func_seek +__APIREL__/api_c/set_func_sleep.html#2 @db_env_set_func_sleep +__APIREL__/api_c/set_func_unlink.html#2 @db_env_set_func_unlink +__APIREL__/api_c/set_func_unmap.html#2 @db_env_set_func_unmap +__APIREL__/api_c/set_func_write.html#2 @db_env_set_func_write +__APIREL__/api_c/set_func_yield.html#2 @db_env_set_func_yield +__APIREL__/api_c/db_close.html#2 @DB-__GT__close +__APIREL__/api_c/db_close.html#DB_NOSYNC DB-__GT__close@DB_NOSYNC +__APIREL__/api_c/db_close.html#3 DB-__GT__close @DB_INCOMPLETE +__APIREL__/api_c/db_cursor.html#2 @DB-__GT__cursor +__APIREL__/api_c/db_cursor.html#DB_WRITECURSOR DB-__GT__cursor@DB_WRITECURSOR +__APIREL__/api_c/db_del.html#2 @DB-__GT__del +__APIREL__/api_c/db_fd.html#2 @DB-__GT__fd +__APIREL__/api_c/db_get.html#2 @DB-__GT__get +__APIREL__/api_c/db_get.html#DB_CONSUME DB-__GT__get@DB_CONSUME +__APIREL__/api_c/db_get.html#DB_CONSUME_WAIT DB-__GT__get@DB_CONSUME_WAIT +__APIREL__/api_c/db_get.html#DB_GET_BOTH DB-__GT__get@DB_GET_BOTH +__APIREL__/api_c/db_get.html#DB_SET_RECNO DB-__GT__get@DB_SET_RECNO +__APIREL__/api_c/db_get.html#DB_RMW DB-__GT__get@DB_RMW +__APIREL__/api_c/db_get_byteswapped.html#2 @DB-__GT__get_byteswapped +__APIREL__/api_c/db_get_type.html#2 @DB-__GT__get_type +__APIREL__/api_c/db_join.html#2 @DB-__GT__join +__APIREL__/api_c/db_join.html#DB_JOIN_NOSORT DB-__GT__join@DB_JOIN_NOSORT +__APIREL__/api_c/db_join.html#DB_JOIN_ITEM DB-__GT__join@DB_JOIN_ITEM +__APIREL__/api_c/db_join.html#DB_RMW DB-__GT__join@DB_RMW +__APIREL__/api_c/db_key_range.html#2 @DB-__GT__key_range +__APIREL__/api_c/db_open.html#2 @DB-__GT__open +__APIREL__/api_c/db_open.html#DB_CREATE DB-__GT__open@DB_CREATE +__APIREL__/api_c/db_open.html#DB_EXCL DB-__GT__open@DB_EXCL +__APIREL__/api_c/db_open.html#DB_NOMMAP DB-__GT__open@DB_NOMMAP +__APIREL__/api_c/db_open.html#DB_RDONLY DB-__GT__open@DB_RDONLY +__APIREL__/api_c/db_open.html#DB_THREAD DB-__GT__open@DB_THREAD +__APIREL__/api_c/db_open.html#DB_TRUNCATE DB-__GT__open@DB_TRUNCATE +__APIREL__/api_c/db_open.html#DB_OLD_VERSION DB-__GT__open@DB_OLD_VERSION +__APIREL__/api_c/db_put.html#2 @DB-__GT__put +__APIREL__/api_c/db_put.html#DB_APPEND DB-__GT__put@DB_APPEND +__APIREL__/api_c/db_put.html#DB_NODUPDATA DB-__GT__put@DB_NODUPDATA +__APIREL__/api_c/db_put.html#DB_NOOVERWRITE DB-__GT__put@DB_NOOVERWRITE +__APIREL__/api_c/db_remove.html#2 @DB-__GT__remove +__APIREL__/api_c/db_rename.html#2 @DB-__GT__rename +__APIREL__/api_c/db_set_append_recno.html#2 @DB-__GT__set_append_recno +__APIREL__/api_c/db_set_bt_compare.html#2 @DB-__GT__set_bt_compare +__APIREL__/api_c/db_set_bt_minkey.html#2 @DB-__GT__set_bt_minkey +__APIREL__/api_c/db_set_bt_prefix.html#2 @DB-__GT__set_bt_prefix +__APIREL__/api_c/db_set_cachesize.html#2 @DB-__GT__set_cachesize +__APIREL__/api_c/db_set_dup_compare.html#2 @DB-__GT__set_dup_compare +__APIREL__/api_c/db_set_errcall.html#2 @DB-__GT__set_errcall +__APIREL__/api_c/db_set_errpfx.html#2 @DB-__GT__set_errpfx +__APIREL__/api_c/db_set_feedback.html#2 @DB-__GT__set_feedback +__APIREL__/api_c/db_set_feedback.html#DB_UPGRADE DB-__GT__set_feedback@DB_UPGRADE +__APIREL__/api_c/db_set_feedback.html#DB_VERIFY DB-__GT__set_feedback@DB_VERIFY +__APIREL__/api_c/db_set_flags.html#2 @DB-__GT__set_flags +__APIREL__/api_c/db_set_flags.html#DB_DUP DB-__GT__set_flags@DB_DUP +__APIREL__/api_c/db_set_flags.html#DB_DUPSORT DB-__GT__set_flags@DB_DUPSORT +__APIREL__/api_c/db_set_flags.html#DB_RECNUM DB-__GT__set_flags@DB_RECNUM +__APIREL__/api_c/db_set_flags.html#DB_REVSPLITOFF DB-__GT__set_flags@DB_REVSPLITOFF +__APIREL__/api_c/db_set_flags.html#DB_DUP DB-__GT__set_flags@DB_DUP +__APIREL__/api_c/db_set_flags.html#DB_DUPSORT DB-__GT__set_flags@DB_DUPSORT +__APIREL__/api_c/db_set_flags.html#DB_RENUMBER DB-__GT__set_flags@DB_RENUMBER +__APIREL__/api_c/db_set_flags.html#DB_SNAPSHOT DB-__GT__set_flags@DB_SNAPSHOT +__APIREL__/api_c/db_set_h_ffactor.html#2 @DB-__GT__set_h_ffactor +__APIREL__/api_c/db_set_h_hash.html#2 @DB-__GT__set_h_hash +__APIREL__/api_c/db_set_h_nelem.html#2 @DB-__GT__set_h_nelem +__APIREL__/api_c/db_set_lorder.html#2 @DB-__GT__set_lorder +__APIREL__/api_c/db_set_pagesize.html#2 @DB-__GT__set_pagesize +__APIREL__/api_c/db_set_q_extentsize.html#2 @DB-__GT__set_q_extentsize +__APIREL__/api_c/db_set_re_delim.html#2 @DB-__GT__set_re_delim +__APIREL__/api_c/db_set_re_len.html#2 @DB-__GT__set_re_len +__APIREL__/api_c/db_set_re_pad.html#2 @DB-__GT__set_re_pad +__APIREL__/api_c/db_set_re_source.html#2 @DB-__GT__set_re_source +__APIREL__/api_c/db_stat.html#2 @DB-__GT__stat +__APIREL__/api_c/db_stat.html#DB_CACHED_COUNTS DB-__GT__stat@DB_CACHED_COUNTS +__APIREL__/api_c/db_stat.html#DB_RECORDCOUNT DB-__GT__stat@DB_RECORDCOUNT +__APIREL__/api_c/db_sync.html#2 @DB-__GT__sync +__APIREL__/api_c/db_upgrade.html#2 @DB-__GT__upgrade +__APIREL__/api_c/db_upgrade.html#DB_DUPSORT DB-__GT__upgrade@DB_DUPSORT +__APIREL__/api_c/db_upgrade.html#DB_OLD_VERSION DB-__GT__upgrade@DB_OLD_VERSION +__APIREL__/api_c/db_verify.html#2 @DB-__GT__verify +__APIREL__/api_c/db_verify.html#DB_SALVAGE DB-__GT__verify@DB_SALVAGE +__APIREL__/api_c/db_verify.html#DB_AGGRESSIVE DB-__GT__verify@DB_AGGRESSIVE +__APIREL__/api_c/db_verify.html#DB_NOORDERCHK DB-__GT__verify@DB_NOORDERCHK +__APIREL__/api_c/db_verify.html#DB_ORDERCHKONLY DB-__GT__verify@DB_ORDERCHKONLY +__APIREL__/api_c/dbc_close.html#2 @DBcursor-__GT__c_close +__APIREL__/api_c/dbc_count.html#2 @DBcursor-__GT__c_count +__APIREL__/api_c/dbc_del.html#2 @DBcursor-__GT__c_del +__APIREL__/api_c/dbc_dup.html#2 @DBcursor-__GT__c_dup +__APIREL__/api_c/dbc_dup.html#DB_POSITION DBcursor-__GT__c_dup@DB_POSITION +__APIREL__/api_c/dbc_get.html#2 @DBcursor-__GT__c_get +__APIREL__/api_c/dbc_get.html#DB_CURRENT DBcursor-__GT__c_get@DB_CURRENT +__APIREL__/api_c/dbc_get.html#DB_FIRST DBcursor-__GT__c_get@DB_FIRST +__APIREL__/api_c/dbc_get.html#DB_LAST DBcursor-__GT__c_get@DB_LAST +__APIREL__/api_c/dbc_get.html#DB_GET_BOTH DBcursor-__GT__c_get@DB_GET_BOTH +__APIREL__/api_c/dbc_get.html#DB_GET_RECNO DBcursor-__GT__c_get@DB_GET_RECNO +__APIREL__/api_c/dbc_get.html#DB_JOIN_ITEM DBcursor-__GT__c_get@DB_JOIN_ITEM +__APIREL__/api_c/dbc_get.html#DB_NEXT DBcursor-__GT__c_get@DB_NEXT +__APIREL__/api_c/dbc_get.html#DB_PREV DBcursor-__GT__c_get@DB_PREV +__APIREL__/api_c/dbc_get.html#DB_NEXT_DUP DBcursor-__GT__c_get@DB_NEXT_DUP +__APIREL__/api_c/dbc_get.html#DB_NEXT_NODUP DBcursor-__GT__c_get@DB_NEXT_NODUP +__APIREL__/api_c/dbc_get.html#DB_PREV_NODUP DBcursor-__GT__c_get@DB_PREV_NODUP +__APIREL__/api_c/dbc_get.html#DB_SET DBcursor-__GT__c_get@DB_SET +__APIREL__/api_c/dbc_get.html#DB_SET_RANGE DBcursor-__GT__c_get@DB_SET_RANGE +__APIREL__/api_c/dbc_get.html#DB_SET_RECNO DBcursor-__GT__c_get@DB_SET_RECNO +__APIREL__/api_c/dbc_get.html#DB_RMW DBcursor-__GT__c_get@DB_RMW +__APIREL__/api_c/dbc_put.html#2 @DBcursor-__GT__c_put +__APIREL__/api_c/dbc_put.html#DB_AFTER DBcursor-__GT__c_put@DB_AFTER +__APIREL__/api_c/dbc_put.html#DB_BEFORE DBcursor-__GT__c_put@DB_BEFORE +__APIREL__/api_c/dbc_put.html#DB_CURRENT DBcursor-__GT__c_put@DB_CURRENT +__APIREL__/api_c/dbc_put.html#DB_KEYFIRST DBcursor-__GT__c_put@DB_KEYFIRST +__APIREL__/api_c/dbc_put.html#DB_KEYLAST DBcursor-__GT__c_put@DB_KEYLAST +__APIREL__/api_c/dbc_put.html#DB_NODUPDATA DBcursor-__GT__c_put@DB_NODUPDATA +__APIREL__/api_c/env_close.html#2 @DBENV-__GT__close +__APIREL__/api_c/env_open.html#2 @DBENV-__GT__open +__APIREL__/api_c/env_open.html#DB_JOINENV DBENV-__GT__open@DB_JOINENV +__APIREL__/api_c/env_open.html#DB_INIT_CDB DBENV-__GT__open@DB_INIT_CDB +__APIREL__/api_c/env_open.html#DB_INIT_LOCK DBENV-__GT__open@DB_INIT_LOCK +__APIREL__/api_c/env_open.html#DB_INIT_LOG DBENV-__GT__open@DB_INIT_LOG +__APIREL__/api_c/env_open.html#DB_INIT_MPOOL DBENV-__GT__open@DB_INIT_MPOOL +__APIREL__/api_c/env_open.html#DB_INIT_TXN DBENV-__GT__open@DB_INIT_TXN +__APIREL__/api_c/env_open.html#DB_RECOVER DBENV-__GT__open@DB_RECOVER +__APIREL__/api_c/env_open.html#DB_RECOVER_FATAL DBENV-__GT__open@DB_RECOVER_FATAL +__APIREL__/api_c/env_open.html#DB_USE_ENVIRON DBENV-__GT__open@DB_USE_ENVIRON +__APIREL__/api_c/env_open.html#DB_USE_ENVIRON_ROOT DBENV-__GT__open@DB_USE_ENVIRON_ROOT +__APIREL__/api_c/env_open.html#DB_CREATE DBENV-__GT__open@DB_CREATE +__APIREL__/api_c/env_open.html#DB_LOCKDOWN DBENV-__GT__open@DB_LOCKDOWN +__APIREL__/api_c/env_open.html#DB_PRIVATE DBENV-__GT__open@DB_PRIVATE +__APIREL__/api_c/env_open.html#DB_SYSTEM_MEM DBENV-__GT__open@DB_SYSTEM_MEM +__APIREL__/api_c/env_open.html#DB_THREAD DBENV-__GT__open@DB_THREAD +__APIREL__/api_c/env_remove.html#2 @DBENV-__GT__remove +__APIREL__/api_c/env_remove.html#DB_FORCE DBENV-__GT__remove@DB_FORCE +__APIREL__/api_c/env_remove.html#DB_USE_ENVIRON DBENV-__GT__remove@DB_USE_ENVIRON +__APIREL__/api_c/env_remove.html#DB_USE_ENVIRON_ROOT DBENV-__GT__remove@DB_USE_ENVIRON_ROOT +__APIREL__/api_c/env_set_cachesize.html#2 @DBENV-__GT__set_cachesize +__APIREL__/api_c/env_set_data_dir.html#2 @DBENV-__GT__set_data_dir +__APIREL__/api_c/env_set_errcall.html#2 @DBENV-__GT__set_errcall +__APIREL__/api_c/env_set_errpfx.html#2 @DBENV-__GT__set_errpfx +__APIREL__/api_c/env_set_feedback.html#2 @DBENV-__GT__set_feedback +__APIREL__/api_c/env_set_feedback.html#DB_RECOVER DBENV-__GT__set_feedback@DB_RECOVER +__APIREL__/api_c/env_set_flags.html#2 @DBENV-__GT__set_flags +__APIREL__/api_c/env_set_flags.html#DB_CDB_ALLDB DBENV-__GT__set_flags@DB_CDB_ALLDB +__APIREL__/api_c/env_set_flags.html#DB_NOMMAP DBENV-__GT__set_flags@DB_NOMMAP +__APIREL__/api_c/env_set_flags.html#DB_TXN_NOSYNC DBENV-__GT__set_flags@DB_TXN_NOSYNC +__APIREL__/api_c/env_set_lg_bsize.html#2 @DBENV-__GT__set_lg_bsize +__APIREL__/api_c/env_set_lg_dir.html#2 @DBENV-__GT__set_lg_dir +__APIREL__/api_c/env_set_lg_max.html#2 @DBENV-__GT__set_lg_max +__APIREL__/api_c/env_set_lk_conflicts.html#2 @DBENV-__GT__set_lk_conflicts +__APIREL__/api_c/env_set_lk_detect.html#2 @DBENV-__GT__set_lk_detect +__APIREL__/api_c/env_set_lk_detect.html#DB_LOCK_DEFAULT DBENV-__GT__set_lk_detect@DB_LOCK_DEFAULT +__APIREL__/api_c/env_set_lk_detect.html#DB_LOCK_OLDEST DBENV-__GT__set_lk_detect@DB_LOCK_OLDEST +__APIREL__/api_c/env_set_lk_detect.html#DB_LOCK_RANDOM DBENV-__GT__set_lk_detect@DB_LOCK_RANDOM +__APIREL__/api_c/env_set_lk_detect.html#DB_LOCK_YOUNGEST DBENV-__GT__set_lk_detect@DB_LOCK_YOUNGEST +__APIREL__/api_c/env_set_lk_max.html#2 @DBENV-__GT__set_lk_max +__APIREL__/api_c/env_set_lk_max_locks.html#2 @DBENV-__GT__set_lk_max_locks +__APIREL__/api_c/env_set_lk_max_lockers.html#2 @DBENV-__GT__set_lk_max_lockers +__APIREL__/api_c/env_set_lk_max_objects.html#2 @DBENV-__GT__set_lk_max_objects +__APIREL__/api_c/env_set_mp_mmapsize.html#2 @DBENV-__GT__set_mp_mmapsize +__APIREL__/api_c/env_set_mutexlocks.html#2 @DBENV-__GT__set_mutexlocks +__APIREL__/api_c/env_set_pageyield.html#2 @db_env_set_pageyield +__APIREL__/api_c/env_set_panicstate.html#2 @db_env_set_panicstate +__APIREL__/api_c/env_set_rec_init.html#2 @DBENV-__GT__set_recovery_init +__APIREL__/api_c/env_set_region_init.html#2 @db_env_set_region_init +__APIREL__/api_c/env_set_server.html#2 @DBENV-__GT__set_server +__APIREL__/api_c/env_set_server.html#DB_NOSERVER DBENV-__GT__set_server@DB_NOSERVER +__APIREL__/api_c/env_set_server.html#DB_NOSERVER_ID DBENV-__GT__set_server@DB_NOSERVER_ID +__APIREL__/api_c/env_set_shm_key.html#2 @DBENV-__GT__set_shm_key +__APIREL__/api_c/env_set_tas_spins.html#2 @db_env_set_tas_spins +__APIREL__/api_c/env_set_tmp_dir.html#2 @DBENV-__GT__set_tmp_dir +__APIREL__/api_c/env_set_tx_max.html#2 @DBENV-__GT__set_tx_max +__APIREL__/api_c/env_set_tx_recover.html#2 @DBENV-__GT__set_tx_recover +__APIREL__/api_c/env_set_tx_recover.html#DB_TXN_BACKWARD_ROLL DBENV-__GT__set_tx_recover@DB_TXN_BACKWARD_ROLL +__APIREL__/api_c/env_set_tx_recover.html#DB_TXN_FORWARD_ROLL DBENV-__GT__set_tx_recover@DB_TXN_FORWARD_ROLL +__APIREL__/api_c/env_set_tx_recover.html#DB_TXN_ABORT DBENV-__GT__set_tx_recover@DB_TXN_ABORT +__APIREL__/api_c/env_set_tx_timestamp.html#2 @DBENV-__GT__set_tx_timestamp +__APIREL__/api_c/env_set_verbose.html#2 @DBENV-__GT__set_verbose +__APIREL__/api_c/env_set_verbose.html#DB_VERB_CHKPOINT DBENV-__GT__set_verbose@DB_VERB_CHKPOINT +__APIREL__/api_c/env_set_verbose.html#DB_VERB_DEADLOCK DBENV-__GT__set_verbose@DB_VERB_DEADLOCK +__APIREL__/api_c/env_set_verbose.html#DB_VERB_RECOVERY DBENV-__GT__set_verbose@DB_VERB_RECOVERY +__APIREL__/api_c/env_set_verbose.html#DB_VERB_WAITSFOR DBENV-__GT__set_verbose@DB_VERB_WAITSFOR +__APIREL__/api_c/env_strerror.html#2 @db_strerror +__APIREL__/api_c/env_version.html#2 @db_version +__APIREL__/api_c/lock_detect.html#2 @lock_detect +__APIREL__/api_c/lock_detect.html#DB_LOCK_CONFLICT lock_detect@DB_LOCK_CONFLICT +__APIREL__/api_c/lock_get.html#2 @lock_get +__APIREL__/api_c/lock_get.html#DB_LOCK_NOWAIT lock_get@DB_LOCK_NOWAIT +__APIREL__/api_c/lock_get.html#DB_LOCK_NOTGRANTED lock_get@DB_LOCK_NOTGRANTED +__APIREL__/api_c/lock_id.html#2 @lock_id +__APIREL__/api_c/lock_put.html#2 @lock_put +__APIREL__/api_c/lock_stat.html#2 @lock_stat +__APIREL__/api_c/lock_vec.html#2 @lock_vec +__APIREL__/api_c/lock_vec.html#DB_LOCK_NOWAIT lock_vec@DB_LOCK_NOWAIT +__APIREL__/api_c/lock_vec.html#op lock_vec@op +__APIREL__/api_c/lock_vec.html#DB_LOCK_GET lock_vec@DB_LOCK_GET +__APIREL__/api_c/lock_vec.html#DB_LOCK_PUT lock_vec@DB_LOCK_PUT +__APIREL__/api_c/lock_vec.html#DB_LOCK_PUT_ALL lock_vec@DB_LOCK_PUT_ALL +__APIREL__/api_c/lock_vec.html#DB_LOCK_PUT_OBJ lock_vec@DB_LOCK_PUT_OBJ +__APIREL__/api_c/lock_vec.html#obj lock_vec@obj +__APIREL__/api_c/lock_vec.html#mode lock_vec@mode +__APIREL__/api_c/lock_vec.html#lock lock_vec@lock +__APIREL__/api_c/lock_vec.html#DB_LOCK_NOTGRANTED lock_vec@DB_LOCK_NOTGRANTED +__APIREL__/api_c/log_archive.html#2 @log_archive +__APIREL__/api_c/log_archive.html#DB_ARCH_ABS log_archive@DB_ARCH_ABS +__APIREL__/api_c/log_archive.html#DB_ARCH_DATA log_archive@DB_ARCH_DATA +__APIREL__/api_c/log_archive.html#DB_ARCH_LOG log_archive@DB_ARCH_LOG +__APIREL__/api_c/log_compare.html#2 @log_compare +__APIREL__/api_c/log_file.html#2 @log_file +__APIREL__/api_c/log_flush.html#2 @log_flush +__APIREL__/api_c/log_get.html#2 @log_get +__APIREL__/api_c/log_get.html#DB_CHECKPOINT log_get@DB_CHECKPOINT +__APIREL__/api_c/log_get.html#DB_FIRST log_get@DB_FIRST +__APIREL__/api_c/log_get.html#DB_LAST log_get@DB_LAST +__APIREL__/api_c/log_get.html#DB_NEXT log_get@DB_NEXT +__APIREL__/api_c/log_get.html#DB_PREV log_get@DB_PREV +__APIREL__/api_c/log_get.html#DB_CURRENT log_get@DB_CURRENT +__APIREL__/api_c/log_get.html#DB_SET log_get@DB_SET +__APIREL__/api_c/log_put.html#2 @log_put +__APIREL__/api_c/log_put.html#DB_CHECKPOINT log_put@DB_CHECKPOINT +__APIREL__/api_c/log_put.html#DB_CURLSN log_put@DB_CURLSN +__APIREL__/api_c/log_put.html#DB_FLUSH log_put@DB_FLUSH +__APIREL__/api_c/log_register.html#2 @log_register +__APIREL__/api_c/log_stat.html#2 @log_stat +__APIREL__/api_c/log_unregister.html#2 @log_unregister +__APIREL__/api_c/memp_fclose.html#2 @memp_fclose +__APIREL__/api_c/memp_fget.html#2 @memp_fget +__APIREL__/api_c/memp_fget.html#DB_MPOOL_CREATE memp_fget@DB_MPOOL_CREATE +__APIREL__/api_c/memp_fget.html#DB_MPOOL_LAST memp_fget@DB_MPOOL_LAST +__APIREL__/api_c/memp_fget.html#DB_MPOOL_NEW memp_fget@DB_MPOOL_NEW +__APIREL__/api_c/memp_fopen.html#2 @memp_fopen +__APIREL__/api_c/memp_fopen.html#DB_CREATE memp_fopen@DB_CREATE +__APIREL__/api_c/memp_fopen.html#DB_NOMMAP memp_fopen@DB_NOMMAP +__APIREL__/api_c/memp_fopen.html#DB_RDONLY memp_fopen@DB_RDONLY +__APIREL__/api_c/memp_fopen.html#ftype memp_fopen@ftype +__APIREL__/api_c/memp_fopen.html#pgcookie memp_fopen@pgcookie +__APIREL__/api_c/memp_fopen.html#fileid memp_fopen@fileid +__APIREL__/api_c/memp_fopen.html#lsn_offset memp_fopen@lsn_offset +__APIREL__/api_c/memp_fopen.html#clear_len memp_fopen@clear_len +__APIREL__/api_c/memp_fput.html#2 @memp_fput +__APIREL__/api_c/memp_fput.html#DB_MPOOL_CLEAN memp_fput@DB_MPOOL_CLEAN +__APIREL__/api_c/memp_fput.html#DB_MPOOL_DIRTY memp_fput@DB_MPOOL_DIRTY +__APIREL__/api_c/memp_fput.html#DB_MPOOL_DISCARD memp_fput@DB_MPOOL_DISCARD +__APIREL__/api_c/memp_fset.html#2 @memp_fset +__APIREL__/api_c/memp_fset.html#DB_MPOOL_CLEAN memp_fset@DB_MPOOL_CLEAN +__APIREL__/api_c/memp_fset.html#DB_MPOOL_DIRTY memp_fset@DB_MPOOL_DIRTY +__APIREL__/api_c/memp_fset.html#DB_MPOOL_DISCARD memp_fset@DB_MPOOL_DISCARD +__APIREL__/api_c/memp_fsync.html#2 @memp_fsync +__APIREL__/api_c/memp_register.html#2 @memp_register +__APIREL__/api_c/memp_stat.html#2 @memp_stat +__APIREL__/api_c/memp_sync.html#2 @memp_sync +__APIREL__/api_c/memp_trickle.html#2 @memp_trickle +__APIREL__/api_c/txn_abort.html#2 @txn_abort +__APIREL__/api_c/txn_begin.html#2 @txn_begin +__APIREL__/api_c/txn_begin.html#DB_TXN_NOSYNC txn_begin@DB_TXN_NOSYNC +__APIREL__/api_c/txn_begin.html#DB_TXN_NOWAIT txn_begin@DB_TXN_NOWAIT +__APIREL__/api_c/txn_begin.html#DB_TXN_SYNC txn_begin@DB_TXN_SYNC +__APIREL__/api_c/txn_checkpoint.html#2 @txn_checkpoint +__APIREL__/api_c/txn_checkpoint.html#DB_FORCE txn_checkpoint@DB_FORCE +__APIREL__/api_c/txn_commit.html#2 @txn_commit +__APIREL__/api_c/txn_commit.html#DB_TXN_NOSYNC txn_commit@DB_TXN_NOSYNC +__APIREL__/api_c/txn_commit.html#DB_TXN_SYNC txn_commit@DB_TXN_SYNC +__APIREL__/api_c/txn_id.html#2 @txn_id +__APIREL__/api_c/txn_prepare.html#2 @txn_prepare +__APIREL__/api_c/txn_stat.html#2 @txn_stat diff --git a/bdb/docs/api_c/set_func_close.html b/bdb/docs/api_c/set_func_close.html new file mode 100644 index 00000000000..0d4af0aef66 --- /dev/null +++ b/bdb/docs/api_c/set_func_close.html @@ -0,0 +1,66 @@ +<!--$Id: set_func_close.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_close</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_close</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_close(int (*func_close)(int fd)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>close</b> function +with <b>func_close</b>, which must conform to the standard interface. +<p>The db_env_set_func_close interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_close interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_close function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_dirfree.html b/bdb/docs/api_c/set_func_dirfree.html new file mode 100644 index 00000000000..249f69cc676 --- /dev/null +++ b/bdb/docs/api_c/set_func_dirfree.html @@ -0,0 +1,75 @@ +<!--$Id: set_func_dirfree.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_dirfree</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_dirfree</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_dirfree(void (*func_dirfree)(char **namesp, int cnt)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to return any memory allocated as part +of the routine which reads through a directory and creates a list of files +that that the directory contains (see <a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>). +The <b>func_dirfree</b> argument must conform to the following interface: +<p><blockquote><pre>int dirfree(char **namesp, int cnt);</pre></blockquote> +<p>The <b>namesp</b> and <b>cnt</b> arguments are the same values as were +returned by the <a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a> function. +<p>The <b>func_dirfree</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_dirfree interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_dirfree interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_dirfree interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The db_env_set_func_dirfree function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_dirlist.html b/bdb/docs/api_c/set_func_dirlist.html new file mode 100644 index 00000000000..5025912e5d9 --- /dev/null +++ b/bdb/docs/api_c/set_func_dirlist.html @@ -0,0 +1,78 @@ +<!--$Id: set_func_dirlist.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_dirlist</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_dirlist</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_dirlist( + int (*func_dirlist)(const char *dir, char ***namesp, int *cntp)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to read through a directory and +create a list of files that that the directory contains. The +<b>func_dirlist</b> argument must conform to the following interface: +<p><blockquote><pre>int dirlist(const char *dir, char ***namesp, int *cntp);</pre></blockquote> +<p>The <b>dir</b> argument is the name of the directory to be searched. +The function must return a pointer to an array of nul-terminated file +names in the memory location referenced by the argument <b>namesp</b>, +and a count of the number of elements in the array in the memory location +referenced by <b>cntp</b>. +<p>The <b>func_dirlist</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_dirlist interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_dirlist interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_dirlist interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The db_env_set_func_dirlist function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_exists.html b/bdb/docs/api_c/set_func_exists.html new file mode 100644 index 00000000000..0b38b1e2203 --- /dev/null +++ b/bdb/docs/api_c/set_func_exists.html @@ -0,0 +1,75 @@ +<!--$Id: set_func_exists.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_exists</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_exists</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_exists(int (*func_exists)(const char *path, int *isdirp)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to determine if a file exists, and +optionally, if it is a file of type directory. The <b>func</b> argument +must conform to the following interface: +<p><blockquote><pre>int exists(const char *path, int *isdirp);</pre></blockquote> +<p>The <b>path</b> argument is the pathname of the file to be checked. +<p>If the <b>isdirp</b> argument is non-NULL, it must be set to non-0 if +<b>path</b> is a directory, and 0 if <b>path</b> is not a directory. +<p>The <b>func_exists</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_exists interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_exists interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_exists interface may only be used to configure Berkeley DB before +the <a href="../api_c/env_open.html">DBENV->open</a> interface is called. +<p>The db_env_set_func_exists function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_free.html b/bdb/docs/api_c/set_func_free.html new file mode 100644 index 00000000000..8b7b1afa60c --- /dev/null +++ b/bdb/docs/api_c/set_func_free.html @@ -0,0 +1,67 @@ +<!--$Id: set_func_free.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_free</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_free</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_free(void (*func_free)(void *ptr)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the ANSI C X3.159-1989 (ANSI C) standard +<b>free</b> function with <b>func_free</b>, which must conform to +the standard interface. +<p>The db_env_set_func_free interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_free interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_free function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_fsync.html b/bdb/docs/api_c/set_func_fsync.html new file mode 100644 index 00000000000..f73956108b2 --- /dev/null +++ b/bdb/docs/api_c/set_func_fsync.html @@ -0,0 +1,66 @@ +<!--$Id: set_func_fsync.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_fsync</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_fsync</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_fsync(int (*func_fsync)(int fd)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>fsync</b> function +with <b>func_fsync</b>, which must conform to the standard interface. +<p>The db_env_set_func_fsync interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_fsync interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_fsync function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_ioinfo.html b/bdb/docs/api_c/set_func_ioinfo.html new file mode 100644 index 00000000000..3a0143e57ea --- /dev/null +++ b/bdb/docs/api_c/set_func_ioinfo.html @@ -0,0 +1,83 @@ +<!--$Id: set_func_ioinfo.so,v 10.6 2000/05/31 15:10:00 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_ioinfo</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_ioinfo</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_ioinfo(int (*func_ioinfo)(const char *path, + int fd, u_int32_t *mbytesp, u_int32_t *bytesp, u_int32_t *iosizep)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to determine the size and I/O +characteristics of a file. The <b>func_ioinfo</b> argument must conform +to the following interface: +<p><blockquote><pre>int ioinfo(const char *path, int fd, +u_int32_t *mbytesp, u_int32_t *bytesp, u_int32_t *iosizep);</pre></blockquote> +<p>The <b>path</b> argument is the pathname of the file to be checked, and the +<b>fd</b> argument is an open file descriptor on the file. +<p>If the <b>mbytesp</b> and <b>bytesp</b> arguments are non-NULL, the +<b>ioinfo</b> function must return in them the size of the file: the +number of megabytes in the file into the memory location referenced by +the <b>mbytesp</b> argument, and the number of bytes over and above that +number of megabytes into the memory location referenced by the +<b>bytesp</b> argument. +<p>In addition, if the <b>iosizep</b> argument is non-NULL, the <b>ioinfo</b> +function must return the optimum granularity for I/O operations to the file +in the memory location referenced by it. +<p>The <b>func_ioinfo</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_ioinfo interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_ioinfo interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_ioinfo function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_malloc.html b/bdb/docs/api_c/set_func_malloc.html new file mode 100644 index 00000000000..a4be5bfb04e --- /dev/null +++ b/bdb/docs/api_c/set_func_malloc.html @@ -0,0 +1,67 @@ +<!--$Id: set_func_malloc.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_malloc</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_malloc</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_malloc(void *(*func_malloc)(size_t size)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the ANSI C X3.159-1989 (ANSI C) standard +<b>malloc</b> function with <b>func_malloc</b>, which must conform to +the standard interface. +<p>The db_env_set_func_malloc interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_malloc interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_malloc function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_map.html b/bdb/docs/api_c/set_func_map.html new file mode 100644 index 00000000000..e14e9c4aad7 --- /dev/null +++ b/bdb/docs/api_c/set_func_map.html @@ -0,0 +1,86 @@ +<!--$Id: set_func_map.so,v 10.8 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_map</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_map</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_map(int (*func_map)(char *path, + size_t len, int is_region, int is_rdonly, void **addr)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to map a file into memory and to +create shared memory regions (which may or may not be backed by files). +The <b>func_map</b> argument must conform to the following interface: +<p><blockquote><pre>int map(char *path, size_t len, +int is_region, int is_rdonly, void **addr);</pre></blockquote> +<p>The <b>path</b> argument is the name of a file. +<p>The <b>is_region</b> argument will be zero if the intention is to map a +file into shared memory. In this case, the <b>map</b> function must map +the first <b>len</b> bytes of the file into memory and return a pointer +to the mapped location in the memory location referenced by the argument +<b>addr</b>. The <b>is_rdonly</b> argument will be non-zero if the file +is considered read-only by the caller. +<p>The <b>is_region</b> argument will be non-zero if the memory is intended +to be used as a shared memory region for synchronization between Berkeley DB +threads/processes. In this case, the returned memory may be of any kind +(e.g., anonymous), but must be able to support semaphores. In this case, +the <b>path</b> argument may be ignored (although future <b>map</b> +calls using the same <b>path</b> must return the same memory), and the +<b>is_rdonly</b> argument will always be zero. +<p>The <b>func_map</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_map interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_map interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_map function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_open.html b/bdb/docs/api_c/set_func_open.html new file mode 100644 index 00000000000..ff72d9882ed --- /dev/null +++ b/bdb/docs/api_c/set_func_open.html @@ -0,0 +1,66 @@ +<!--$Id: set_func_open.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_open</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_open</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_open(int (*func_open)(const char *path, int flags, int mode)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>open</b> function +with <b>func_open</b>, which must conform to the standard interface. +<p>The db_env_set_func_open interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_open interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_open function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_read.html b/bdb/docs/api_c/set_func_read.html new file mode 100644 index 00000000000..b3ee9308118 --- /dev/null +++ b/bdb/docs/api_c/set_func_read.html @@ -0,0 +1,66 @@ +<!--$Id: set_func_read.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_read</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_read</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_read(ssize_t (*func_read)(int fd, void *buf, size_t nbytes)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>read</b> function +with <b>func_read</b>, which must conform to the standard interface. +<p>The db_env_set_func_read interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_read interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_read function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_realloc.html b/bdb/docs/api_c/set_func_realloc.html new file mode 100644 index 00000000000..91e5835bcca --- /dev/null +++ b/bdb/docs/api_c/set_func_realloc.html @@ -0,0 +1,67 @@ +<!--$Id: set_func_realloc.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_realloc</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_realloc</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_realloc(void *(*func_realloc)(void *ptr, size_t size)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the ANSI C X3.159-1989 (ANSI C) standard +<b>realloc</b> function with <b>func_realloc</b>, which must conform to +the standard interface. +<p>The db_env_set_func_realloc interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_realloc interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_realloc function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_rename.html b/bdb/docs/api_c/set_func_rename.html new file mode 100644 index 00000000000..bb588672359 --- /dev/null +++ b/bdb/docs/api_c/set_func_rename.html @@ -0,0 +1,66 @@ +<!--$Id: set_func_rename.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_rename</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_rename</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_rename(int (*func_rename)(int fd)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>close</b> function +with <b>func_close</b>, which must conform to the standard interface. +<p>The db_env_set_func_rename interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_rename interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_rename function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_seek.html b/bdb/docs/api_c/set_func_seek.html new file mode 100644 index 00000000000..dd27384f672 --- /dev/null +++ b/bdb/docs/api_c/set_func_seek.html @@ -0,0 +1,81 @@ +<!--$Id: set_func_seek.so,v 10.7 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_seek</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_seek</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_seek(int (*func_seek)(int fd, size_t pgsize, + db_pgno_t pageno, u_int32_t relative, int rewind, int whence)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to specify that a subsequent read +from or write to a file will occur at a specific location in that file. +The <b>func_seek</b> argument must conform to the following interface: +<p><blockquote><pre>int seek(int fd, size_t pgsize, db_pgno_t pageno, +u_int32_t relative, int rewind, int whence);</pre></blockquote> +<p>The <b>fd</b> argument is an open file descriptor on the file. +<p>The <b>seek</b> function must cause a subsequent read from or write to +the file to occur at a byte offset specified by the calculation: +<p><blockquote><pre>(pgsize * pageno) + relative</pre></blockquote> +<p>If <b>rewind</b> is non-zero, the byte offset is treated as a backwards +seek, not a forwards one. +<p>The <b>whence</b> argument specifies where in the file the byte offset +is relative to, as described by the IEEE/ANSI Std 1003.1 (POSIX) <b>lseek</b> system +call. +<p>The <b>func_seek</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_seek interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_seek interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_seek function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_sleep.html b/bdb/docs/api_c/set_func_sleep.html new file mode 100644 index 00000000000..dd454b1a725 --- /dev/null +++ b/bdb/docs/api_c/set_func_sleep.html @@ -0,0 +1,76 @@ +<!--$Id: set_func_sleep.so,v 10.7 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_sleep</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_sleep</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_sleep(int (*func_sleep)(u_long seconds, u_long microseconds)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to cause a process to suspend itself +for a period of time, relinquishing control of the processor to any other +waiting thread of control. The <b>func_sleep</b> argument must conform +to the following interface: +<p><blockquote><pre>int sleep(u_long seconds, u_long microseconds);</pre></blockquote> +<p>The <b>seconds</b> and <b>microseconds</b> arguments specify the amount +of time to wait until the suspending thread of control should run again. +<p>The <b>seconds</b> and <b>microseconds</b> arguments may not be +normalized when the <b>sleep</b> function is called, i.e., the +<b>microseconds</b> argument may be greater than 1000000. +<p>The <b>func_sleep</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_sleep interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_sleep interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_sleep function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_unlink.html b/bdb/docs/api_c/set_func_unlink.html new file mode 100644 index 00000000000..1e5e8e3cba9 --- /dev/null +++ b/bdb/docs/api_c/set_func_unlink.html @@ -0,0 +1,66 @@ +<!--$Id: set_func_unlink.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_unlink</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_unlink</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_unlink(int (*func_unlink)(const char *path)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>unlink</b> function +with <b>func_unlink</b>, which must conform to the standard interface. +<p>The db_env_set_func_unlink interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_unlink interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_unlink function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_unmap.html b/bdb/docs/api_c/set_func_unmap.html new file mode 100644 index 00000000000..07635b48a80 --- /dev/null +++ b/bdb/docs/api_c/set_func_unmap.html @@ -0,0 +1,75 @@ +<!--$Id: set_func_unmap.so,v 10.8 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_unmap</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_unmap</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_unmap(int (*func_unmap)(void *addr, size_t len)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to unmap a file or shared memory +region from memory. The <b>func_unmap</b> argument must conform to the +following interface: +<p><blockquote><pre>int unmap(void *addr, size_t len);</pre></blockquote> +<p>The <b>addr</b> argument is the argument returned by the +<a href="../api_c/set_func_map.html">db_env_set_func_map</a> function when the file or region was mapped +into memory, and the <b>len</b> argument is the same as the <b>len</b> +argument specified to the <a href="../api_c/set_func_map.html">db_env_set_func_map</a> function when the +file or region was mapped into memory. +<p>The <b>func_unmap</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_unmap interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_unmap interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_unmap function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_write.html b/bdb/docs/api_c/set_func_write.html new file mode 100644 index 00000000000..7b52b5078ba --- /dev/null +++ b/bdb/docs/api_c/set_func_write.html @@ -0,0 +1,67 @@ +<!--$Id: set_func_write.so,v 10.6 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_write</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_write</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_write( + ssize_t (*func_write)(int fd, const void *buffer, size_t nbytes)); +</pre></h3> +<h1>Description</h1> +<p>Replace Berkeley DB calls to the IEEE/ANSI Std 1003.1 (POSIX) <b>write</b> function +with <b>func_write</b>, which must conform to the standard interface. +<p>The db_env_set_func_write interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_write interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_write function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/set_func_yield.html b/bdb/docs/api_c/set_func_yield.html new file mode 100644 index 00000000000..23915aea68b --- /dev/null +++ b/bdb/docs/api_c/set_func_yield.html @@ -0,0 +1,84 @@ +<!--$Id: set_func_yield.so,v 10.8 2000/05/31 15:10:01 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: db_env_set_func_yield</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>db_env_set_func_yield</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +db_env_set_func_yield(int (*func_yield)(void)); +</pre></h3> +<h1>Description</h1> +<p>The Berkeley DB library requires the ability to yield the processor from the current +thread of control to any other waiting threads of control. +The <b>func_yield</b> argument must conform to the following interface: +<p><blockquote><pre>int yield(void);</pre></blockquote> +<p>The <b>func_yield</b> function must be able to cause the rescheduling +all participants in the current Berkeley DB environment, whether threaded or +not. It may be incorrect to supply a thread <b>yield</b> function if +more than a single process is operating in the Berkeley DB environment. This +is because many thread-yield functions will not allow other processes to +run, and the contested lock may be held by another process, not by another +thread. +<p>If no <b>func_yield</b> function is specified, or if the <b>yield</b> +function returns an error, the function specified by the +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a> entry will be used instead or subsequently, +i.e., if no <b>yield</b> function is specified, or it is possible for +the <b>yield</b> function to fail, the <b>sleep</b> function +<b>must</b> cause the processor to reschedule any waiting threads of +control for execution. +<p>The <b>func_yield</b> function must return the value of <b>errno</b> on +failure and 0 on success. +<p>The db_env_set_func_yield interface affects the entire application, not a single +database or database environment. +<p>While the db_env_set_func_yield interface may be used to configure Berkeley DB at any time +during the life of the application, it should normally be called before +making any calls to the <a href="../api_c/env_create.html">db_env_create</a> or <a href="../api_c/db_create.html">db_create</a> functions. +<p>The db_env_set_func_yield function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<h1>See Also</h1> +<a href="../api_c/set_func_close.html">db_env_set_func_close</a>, +<a href="../api_c/set_func_dirfree.html">db_env_set_func_dirfree</a>, +<a href="../api_c/set_func_dirlist.html">db_env_set_func_dirlist</a>, +<a href="../api_c/set_func_exists.html">db_env_set_func_exists</a>, +<a href="../api_c/set_func_free.html">db_env_set_func_free</a>, +<a href="../api_c/set_func_fsync.html">db_env_set_func_fsync</a>, +<a href="../api_c/set_func_ioinfo.html">db_env_set_func_ioinfo</a>, +<a href="../api_c/set_func_malloc.html">db_env_set_func_malloc</a>, +<a href="../api_c/set_func_map.html">db_env_set_func_map</a>, +<a href="../api_c/set_func_open.html">db_env_set_func_open</a>, +<a href="../api_c/set_func_read.html">db_env_set_func_read</a>, +<a href="../api_c/set_func_realloc.html">db_env_set_func_realloc</a>, +<a href="../api_c/set_func_seek.html">db_env_set_func_seek</a>, +<a href="../api_c/set_func_sleep.html">db_env_set_func_sleep</a>, +<a href="../api_c/set_func_unlink.html">db_env_set_func_unlink</a>, +<a href="../api_c/set_func_unmap.html">db_env_set_func_unmap</a>, +<a href="../api_c/set_func_write.html">db_env_set_func_write</a> +and +<a href="../api_c/set_func_yield.html">db_env_set_func_yield</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_abort.html b/bdb/docs/api_c/txn_abort.html new file mode 100644 index 00000000000..00056023aba --- /dev/null +++ b/bdb/docs/api_c/txn_abort.html @@ -0,0 +1,63 @@ +<!--$Id: txn_abort.so,v 10.25 2000/12/31 19:26:21 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_abort</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_abort</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_abort(DB_TXN *tid); +</pre></h3> +<h1>Description</h1> +<p>The txn_abort function causes an abnormal termination of the +transaction. The log is played backwards and any necessary recovery +operations are initiated through the <b>recover</b> function specified +to <a href="../api_c/env_open.html">DBENV->open</a>. After the log processing is completed, all locks +held by the transaction are released. As is the case for +<a href="../api_c/txn_commit.html">txn_commit</a>, applications that require strict two-phase locking +should not explicitly release any locks. +<p>In the case of nested transactions, aborting a parent transaction causes +all children (unresolved or not) of the parent transaction to be aborted. +<p>Once the txn_abort function returns, the DB_TXN handle may not +be accessed again. +<p>The txn_abort function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The txn_abort function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_abort function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_begin.html b/bdb/docs/api_c/txn_begin.html new file mode 100644 index 00000000000..0241d5c1fdb --- /dev/null +++ b/bdb/docs/api_c/txn_begin.html @@ -0,0 +1,93 @@ +<!--$Id: txn_begin.so,v 10.37 2001/01/11 17:47:12 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_begin</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_begin</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_begin(DB_ENV *env, + DB_TXN *parent, DB_TXN **tid, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The txn_begin method creates a new transaction in the environment +and copies a pointer to a DB_TXN that uniquely identifies it into +the memory referenced by <b>tid</b>. +<p>If the <b>parent</b> argument is non-NULL, the new transaction will +be a nested transaction, with the transaction indicated by +<b>parent</b> as its parent. Transactions may be +nested to any level. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_TXN_NOSYNC">DB_TXN_NOSYNC</a><dd>Do not synchronously flush the log when this transaction commits or +prepares. This means the transaction will exhibit the ACI (atomicity, +consistency and isolation) properties, but not D (durability), i.e., +database integrity will be maintained but it is possible that this +transaction may be undone during recovery instead of being redone. +<p>This behavior may be set for an entire Berkeley DB environment as part of the +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a> interface. +<p><dt><a name="DB_TXN_NOWAIT">DB_TXN_NOWAIT</a><dd>If a lock is unavailable for any Berkeley DB operation performed in the context +of this transaction, return immediately instead of blocking on the lock. +The error return in the case will be <a href="../ref/program/errorret.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a>. +<p><dt><a name="DB_TXN_SYNC">DB_TXN_SYNC</a><dd>Synchronously flush the log when this transaction commits or prepares. +This means the transaction will exhibit all of the ACID (atomicity, +consistency and isolation and durability) properties. +<p>This behavior is the default for Berkeley DB environments unless the +<a href="../api_c/env_open.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a> flag was specified to the <a href="../api_c/env_set_flags.html">DBENV->set_flags</a> +interface. +</dl> +<p><b>Note: An transaction may not span threads, +i.e., each transaction must begin and end in the same thread, and each +transaction may only be used by a single thread.</b> +<p><b>Note: cursors may not span transactions, i.e., each cursor must be opened +and closed within a single transaction.</b> +<p><b>Note: a parent transaction may not issue any Berkeley DB operations, except for +txn_begin, <a href="../api_c/txn_abort.html">txn_abort</a> and <a href="../api_c/txn_commit.html">txn_commit</a>, while it has +active child transactions (child transactions that have not yet been +committed or aborted).</b> +<p>The txn_begin function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The txn_begin function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>ENOMEM<dd>The maximum number of concurrent transactions has been reached. +</dl> +<p>The txn_begin function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_begin function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_checkpoint.html b/bdb/docs/api_c/txn_checkpoint.html new file mode 100644 index 00000000000..140edee57d7 --- /dev/null +++ b/bdb/docs/api_c/txn_checkpoint.html @@ -0,0 +1,75 @@ +<!--$Id: txn_checkpoint.so,v 10.25 2000/09/08 15:20:28 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_checkpoint</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_checkpoint</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_checkpoint(const DB_ENV *env, + u_int32_t kbyte, u_int32_t min, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The txn_checkpoint function flushes the underlying memory pool, +writes a checkpoint record to the log and then flushes the log. +<p>If either <b>kbyte</b> or <b>min</b> is non-zero, the checkpoint is only +done if there has been activity since the last checkpoint and either +more than <b>min</b> minutes have passed since the last checkpoint, +or if more than <b>kbyte</b> kilobytes of log data have been written since +the last checkpoint. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_FORCE">DB_FORCE</a><dd>Force a checkpoint record even if there has been no activity since the +last checkpoint. +</dl> +<p>The txn_checkpoint function returns a non-zero error value on failure, 0 on success, and returns <a href="../api_c/memp_fsync.html#DB_INCOMPLETE">DB_INCOMPLETE</a> if there were pages that needed to be +written to complete the checkpoint but that <a href="../api_c/memp_sync.html">memp_sync</a> was unable +to write immediately. +<p>The txn_checkpoint function is the underlying function used by the <a href="../utility/db_checkpoint.html">db_checkpoint</a> utility. +See the <a href="../utility/db_checkpoint.html">db_checkpoint</a> utility source code for an example of using txn_checkpoint +in a IEEE/ANSI Std 1003.1 (POSIX) environment. +<h1>Errors</h1> +<p>The txn_checkpoint function may fail and return a non-zero error for the following conditions: +<p><dl compact> +<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. +</dl> +<p>The txn_checkpoint function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_checkpoint function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_commit.html b/bdb/docs/api_c/txn_commit.html new file mode 100644 index 00000000000..7fca3d08d7b --- /dev/null +++ b/bdb/docs/api_c/txn_commit.html @@ -0,0 +1,83 @@ +<!--$Id: txn_commit.so,v 10.27 2000/12/31 19:26:21 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_commit</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_commit</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_commit(DB_TXN *tid, u_int32_t flags); +</pre></h3> +<h1>Description</h1> +<p>The txn_commit function ends the transaction. In the case of nested +transactions, if the transaction is a parent transaction, committing +the parent transaction causes all unresolved children of the parent to +be committed. +<p>In the case of nested transactions, if the transaction is a child +transaction, its locks are not released, but are acquired by its parent. +While the commit of the child transaction will succeed, the actual +resolution of the child transaction is postponed until the parent +transaction is committed or aborted, i.e., if its parent transaction +commits, it will be committed, and if its parent transaction aborts, it +will be aborted. +<p>The <b>flags</b> parameter must be set to 0 or one of the following +values: +<p><dl compact> +<p><dt><a name="DB_TXN_NOSYNC">DB_TXN_NOSYNC</a><dd>Do not synchronously flush the log. This means the transaction will +exhibit the ACI (atomicity, consistency and isolation) properties, but +not D (durability), i.e., database integrity will be maintained but it is +possible that this transaction may be undone during recovery instead of +being redone. +<p>This behavior may be set for an entire Berkeley DB environment as part of the +<a href="../api_c/env_set_flags.html">DBENV->set_flags</a> interface. +<p><dt><a name="DB_TXN_SYNC">DB_TXN_SYNC</a><dd>Synchronously flush the log. This means the transaction will exhibit +all of the ACID (atomicity, consistency and isolation and durability) +properties. +<p>This behavior is the default for Berkeley DB environments unless the +<a href="../api_c/env_open.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a> flag was specified to the <a href="../api_c/env_set_flags.html">DBENV->set_flags</a> +or <a href="../api_c/txn_begin.html">txn_begin</a> interfaces. +</dl> +<p>Once the txn_commit function returns, the DB_TXN handle may not +be accessed again. If txn_commit encounters an error, the +transaction and all child transactions of the transaction are aborted. +<p>The txn_commit function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The txn_commit function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_commit function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_id.html b/bdb/docs/api_c/txn_id.html new file mode 100644 index 00000000000..bcda4bcdfff --- /dev/null +++ b/bdb/docs/api_c/txn_id.html @@ -0,0 +1,50 @@ +<!--$Id: txn_id.so,v 10.12 1999/12/20 08:52:32 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_id</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_id</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +u_int32_t +txn_id(DB_TXN *tid); +</pre></h3> +<h1>Description</h1> +<p>The txn_id function returns the unique transaction id associated with the +specified transaction. Locking calls made on behalf of this transaction +should use the value returned from txn_id as the locker parameter +to the <a href="../api_c/lock_get.html">lock_get</a> or <a href="../api_c/lock_vec.html">lock_vec</a> calls. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_prepare.html b/bdb/docs/api_c/txn_prepare.html new file mode 100644 index 00000000000..549a6f074a0 --- /dev/null +++ b/bdb/docs/api_c/txn_prepare.html @@ -0,0 +1,63 @@ +<!--$Id: txn_prepare.so,v 10.17 2000/12/31 19:26:21 bostic Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_prepare</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_prepare</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_prepare(DB_TXN *tid); +</pre></h3> +<h1>Description</h1> +<p>The txn_prepare function initiates the beginning of a two-phase commit. +<p>In a distributed transaction environment, Berkeley DB can be used as a local +transaction manager. In this case, the distributed transaction manager +must send <i>prepare</i> messages to each local manager. The local +manager must then issue a txn_prepare and await its successful +return before responding to the distributed transaction manager. Only +after the distributed transaction manager receives successful responses +from all of its <i>prepare</i> messages should it issue any +<i>commit</i> messages. +<p>In the case of nested transactions, preparing a parent transaction +causes all unresolved children of the parent transaction to be prepared. +<p>The txn_prepare function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The txn_prepare function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_prepare function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> diff --git a/bdb/docs/api_c/txn_stat.html b/bdb/docs/api_c/txn_stat.html new file mode 100644 index 00000000000..769283f93c2 --- /dev/null +++ b/bdb/docs/api_c/txn_stat.html @@ -0,0 +1,94 @@ +<!--$Id: txn_stat.so,v 10.27 2000/05/25 13:47:08 dda Exp $--> +<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> +<title>Berkeley DB: txn_stat</title> +<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> +<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> +</head> +<body bgcolor=white> + <a name="2"><!--meow--></a> +<table><tr valign=top> +<td> +<h1>txn_stat</h1> +</td> +<td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<hr size=1 noshade> +<tt> +<h3><pre> +#include <db.h> +<p> +int +txn_stat(DB_ENV *env, + DB_TXN_STAT **statp, void *(*db_malloc)(size_t)); +</pre></h3> +<h1>Description</h1> +<p>The txn_stat function +creates a statistical structure and copies a pointer to it into a +user-specified memory location. +<p>Statistical structures are created in allocated memory. If <b>db_malloc</b> is non-NULL, it +is called to allocate the memory, otherwise, the library function +<b>malloc</b>(3) is used. The function <b>db_malloc</b> must match +the calling conventions of the <b>malloc</b>(3) library routine. +Regardless, the caller is responsible for deallocating the returned +memory. To deallocate returned memory, free the returned memory +reference, references inside the returned memory do not need to be +individually freed. +<p>The transaction region statistics are stored in a structure of type +DB_TXN_STAT. The following DB_TXN_STAT fields will be filled in: +<p><dl compact> +<dt><a href="../api_c/db_lsn.html">DB_LSN</a> st_last_ckp;<dd>The LSN of the last checkpoint. +<dt><a href="../api_c/db_lsn.html">DB_LSN</a> st_pending_ckp;<dd>The LSN of any checkpoint that is currently in progress. If +<b>st_pending_ckp</b> is the same as <b>st_last_ckp</b> there +is no checkpoint in progress. +<dt>time_t st_time_ckp;<dd>The time the last completed checkpoint finished (as the number of seconds +since the Epoch, returned by the IEEE/ANSI Std 1003.1 (POSIX) <b>time</b> interface). +<dt>u_int32_t st_last_txnid;<dd>The last transaction ID allocated. +<dt>u_int32_t st_maxtxns;<dd>The maximum number of active transactions possible. +<dt>u_int32_t st_nactive;<dd>The number of transactions that are currently active. +<dt>u_int32_t st_maxnactive;<dd>The maximum number of active transactions at any one time. +<dt>u_int32_t st_nbegins;<dd>The number of transactions that have begun. +<dt>u_int32_t st_naborts;<dd>The number of transactions that have aborted. +<dt>u_int32_t st_ncommits;<dd>The number of transactions that have committed. +<dt>u_int32_t st_regsize;<dd>The size of the region. +<dt>u_int32_t st_region_wait;<dd>The number of times that a thread of control was forced to wait before +obtaining the region lock. +<dt>u_int32_t st_region_nowait;<dd>The number of times that a thread of control was able to obtain +the region lock without waiting. +<dt>DB_TXN_ACTIVE * st_txnarray;<dd>A pointer to an array of <b>st_nactive</b> DB_TXN_ACTIVE structures, +describing the currently active transactions. The following fields of +the DB_TXN_ACTIVE structure will be filled in: +<p><dl compact> +<p><dt>u_int32_t txnid;<dd>The transaction ID as returned by <a href="../api_c/txn_begin.html">txn_begin</a>. +<dt>u_int32_t parentid;<dd>The transaction ID of the parent transaction (or 0, if no parent). +<dt><a href="../api_c/db_lsn.html">DB_LSN</a> lsn;<dd>The log sequence number of the transaction-begin record. +</dl> +</dl> +<p>The txn_stat function returns a non-zero error value on failure and 0 on success. +<h1>Errors</h1> +<p>The txn_stat function may fail and return a non-zero error for errors specified for other Berkeley DB and C library or system functions. +If a catastrophic error has occurred, the txn_stat function may fail and return +<a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a>, in which case all subsequent Berkeley DB calls will fail +in the same way. +<h1>See Also</h1> +<a href="../api_c/env_set_tx_max.html">DBENV->set_tx_max</a>, +<a href="../api_c/env_set_tx_recover.html">DBENV->set_tx_recover</a>, +<a href="../api_c/env_set_tx_timestamp.html">DBENV->set_tx_timestamp</a>, +<a href="../api_c/txn_abort.html">txn_abort</a>, +<a href="../api_c/txn_begin.html">txn_begin</a>, +<a href="../api_c/txn_checkpoint.html">txn_checkpoint</a>, +<a href="../api_c/txn_commit.html">txn_commit</a>, +<a href="../api_c/txn_id.html">txn_id</a>, +<a href="../api_c/txn_prepare.html">txn_prepare</a> +and +<a href="../api_c/txn_stat.html">txn_stat</a>. +</tt> +<table><tr><td><br></td><td width="1%"> +<a href="../api_c/c_index.html"><img src="../images/api.gif" alt="API"></a><a href="../ref/toc.html"><img src="../images/ref.gif" alt="Ref"></a> +</td></tr></table> +<p><font size=1><a href="http://www.sleepycat.com">Copyright Sleepycat Software</a></font> +</body> +</html> |