diff options
Diffstat (limited to 'bdb/docs/api_cxx')
131 files changed, 0 insertions, 12650 deletions
diff --git a/bdb/docs/api_cxx/cxx_index.html b/bdb/docs/api_cxx/cxx_index.html deleted file mode 100644 index 1ba43a0f227..00000000000 --- a/bdb/docs/api_cxx/cxx_index.html +++ /dev/null @@ -1,148 +0,0 @@ -<!--$Id: cxx_index.so,v 10.65 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 Class</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 Class</h1> -<p><table border=1 align=center> -<tr><th>Class</th><th>Method</th><th>Description</th></tr> -<tr><td><a href="../api_cxx/dbenv_class.html">DbEnv</a></td><td><br></td><td>Berkeley DB Environment Class</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_close.html">DbEnv::close</a></td><td>Close an environment</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_err.html">DbEnv::err</a></td><td>Error message with error string</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_err.html">DbEnv::errx</a></td><td>Error message</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_open.html">DbEnv::open</a></td><td>Open an environment</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_remove.html">DbEnv::remove</a></td><td>Remove an environment</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a></td><td>Set the environment cache size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_data_dir.html">DbEnv::set_data_dir</a></td><td>Set the environment data directory</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a></td><td>Set error message callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a></td><td>Set error message FILE *</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a></td><td>Set error message output stream</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a></td><td>Set error message prefix</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_feedback.html">DbEnv::set_feedback</a></td><td>Set feedback callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a></td><td>Environment configuration</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a></td><td>Set log buffer size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lg_dir.html">DbEnv::set_lg_dir</a></td><td>Set the environment logging directory</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a></td><td>Set log file size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a></td><td>Set lock conflicts matrix</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a></td><td>Set automatic deadlock detection</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a></td><td>Set maximum number of locks (<b>Deprecated</b>)</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a></td><td>Set maximum number of locks</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a></td><td>Set maximum number of lockers</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a></td><td>Set maximum number of lock objects</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a></td><td>Set maximum mapped-in database file size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a></td><td>Turn off mutual exclusion locking</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_pageyield.html">DbEnv::set_pageyield</a></td><td>Yield the processor on each page access</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a></td><td>Set panic callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_panicstate.html">DbEnv::set_panicstate</a></td><td>Reset panic state</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_rec_init.html">DbEnv::set_recovery_init</a></td><td>Set recovery initialization callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_region_init.html">DbEnv::set_region_init</a></td><td>Fault in shared regions on initial access</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_server.html">DbEnv::set_server</a></td><td>Establish server connection</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_shm_key.html">DbEnv::set_shm_key</a></td><td>Set system memory shared segment ID</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_tas_spins.html">DbEnv::set_tas_spins</a></td><td>Set the number of test-and-set spins</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_tmp_dir.html">DbEnv::set_tmp_dir</a></td><td>Set the environment temporary file directory</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a></td><td>Set maximum number of transactions</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a></td><td>Set transaction abort recover function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a></td><td>Set recovery timestamp</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a></td><td>Set verbose messages</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_strerror.html">DbEnv::strerror</a></td><td>Error strings</td></tr> -<tr><td><br></td><td><a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a></td><td>Perform deadlock detection</td></tr> -<tr><td><br></td><td><a href="../api_cxx/lock_get.html">DbEnv::lock_get</a></td><td>Acquire a lock</td></tr> -<tr><td><br></td><td><a href="../api_cxx/lock_id.html">DbEnv::lock_id</a></td><td>Acquire a locker ID</td></tr> -<tr><td><br></td><td><a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a></td><td>Return lock subsystem statistics</td></tr> -<tr><td><br></td><td><a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a></td><td>Acquire/release locks</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_archive.html">DbEnv::log_archive</a></td><td>List log and database files</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_compare.html">DbEnv::log_compare</a></td><td>Compare two Log Sequence Numbers</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_file.html">DbEnv::log_file</a></td><td>Map Log Sequence Numbers to log files</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_flush.html">DbEnv::log_flush</a></td><td>Flush log records</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_get.html">DbEnv::log_get</a></td><td>Get a log record</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_put.html">DbEnv::log_put</a></td><td>Write a log record</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_register.html">DbEnv::log_register</a></td><td>Register a file name with the log manager</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_stat.html">DbEnv::log_stat</a></td><td>Return log subsystem statistics</td></tr> -<tr><td><br></td><td><a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a></td><td>Unregister a file name with the log manager</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_register.html">DbEnv::memp_register</a></td><td>Register input/output functions for a file in a buffer pool.</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a></td><td>Return buffer pool statistics</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a></td><td>Flush pages from a buffer pool</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a></td><td>Trickle flush pages from a buffer pool</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a></td><td>Begin a transaction</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a></td><td>Checkpoint the transaction subsystem</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a></td><td>Return transaction subsystem statistics</td></tr> -<tr><td><br></td><td><a href="../api_cxx/env_version.html">DbEnv::version</a></td><td>Return version information</td></tr> -<tr><td><a href="../api_cxx/db_class.html">Db</a></td><td><br></td><td>Berkeley DB Access Method Class</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_close.html">Db::close</a></td><td>Close a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_cursor.html">Db::cursor</a></td><td>Open a cursor into a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_del.html">Db::del</a></td><td>Delete items from a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_err.html">Db::err</a></td><td>Error message with error string</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_err.html">Db::errx</a></td><td>Error message</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_fd.html">Db::fd</a></td><td>Return a file descriptor from a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_get.html">Db::get</a></td><td>Get items from a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a></td><td>Return if the underlying database is in host order</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_get_type.html">Db::get_type</a></td><td>Return the database type</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_join.html">Db::join</a></td><td>Perform a database join on cursors</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_key_range.html">Db::key_range</a></td><td>Return estimate of key location</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_open.html">Db::open</a></td><td>Open a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_put.html">Db::put</a></td><td>Store items into a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_remove.html">Db::remove</a></td><td>Remove a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_rename.html">Db::rename</a></td><td>Rename a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_append_recno.html">Db::set_append_recno</a></td><td>Set record append callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a></td><td>Set a Btree comparison function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a></td><td>Set the minimum number of keys per Btree page</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a></td><td>Set a Btree prefix comparison function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a></td><td>Set the database cache size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a></td><td>Set a duplicate comparison function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a></td><td>Set error message callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a></td><td>Set error message FILE *</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a></td><td>Set error message prefix</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_feedback.html">Db::set_feedback</a></td><td>Set feedback callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_flags.html">Db::set_flags</a></td><td>General database configuration</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a></td><td>Set the Hash table density</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a></td><td>Set a hashing function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a></td><td>Set the Hash table size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a></td><td>Set the database byte order</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a></td><td>Set a local space allocation function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a></td><td>Set the underlying database page size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a></td><td>Set panic callback</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a></td><td>Set Queue database extent size</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a></td><td>Set the variable-length record delimiter</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a></td><td>Set the fixed-length record length</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a></td><td>Set the fixed-length record pad byte</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a></td><td>Set the backing Recno text file</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a></td><td>Set a local space allocation function</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_stat.html">Db::stat</a></td><td>Return database statistics</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_sync.html">Db::sync</a></td><td>Flush a database to stable storage</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_upgrade.html">Db::upgrade</a></td><td>Upgrade a database</td></tr> -<tr><td><br></td><td><a href="../api_cxx/db_verify.html">Db::verify</a></td><td>Verify/upgrade a database</td></tr> -<tr><td><a href="../api_cxx/dbc_class.html">Dbc</a></td><td><br></td><td>Berkeley DB Cursor Class</td></tr> -<tr><td><br></td><td><a href="../api_cxx/dbc_close.html">Dbc::close</a></td><td>Close a cursor</td></tr> -<tr><td><br></td><td><a href="../api_cxx/dbc_count.html">Dbc::count</a></td><td>Return count of duplicates</td></tr> -<tr><td><br></td><td><a href="../api_cxx/dbc_del.html">Dbc::del</a></td><td>Delete by cursor</td></tr> -<tr><td><br></td><td><a href="../api_cxx/dbc_dup.html">Dbc::dup</a></td><td>Duplicate a cursor</td></tr> -<tr><td><br></td><td><a href="../api_cxx/dbc_get.html">Dbc::get</a></td><td>Retrieve by cursor</td></tr> -<tr><td><br></td><td><a href="../api_cxx/dbc_put.html">Dbc::put</a></td><td>Store by cursor</td></tr> -<tr><td><a href="../api_cxx/dbt_class.html">Dbt</a></td><td><br></td><td>Key/Data Encoding Class</td></tr> -<tr><td><a href="../api_cxx/lock_class.html">DbLock</a></td><td><br></td><td>Lock Class</td></tr> -<tr><td><br></td><td><a href="../api_cxx/lock_put.html">DbLock::put</a></td><td>Release a lock</td></tr> -<tr><td><a href="../api_cxx/lsn_class.html">DbLsn</a></td><td><br></td><td>Log Sequence Number Class</td></tr> -<tr><td><a href="../api_cxx/mempfile_class.html">DbMpoolFile</a></td><td><br></td><td>Memory Pool File Class</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a></td><td>Close a file in a buffer pool</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a></td><td>Get page from a file in a buffer pool</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a></td><td>Open a file in a buffer pool</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a></td><td>Return a page to a buffer pool</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a></td><td>Modify meta information for buffer pool page</td></tr> -<tr><td><br></td><td><a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a></td><td>Flush pages from a file in a buffer pool</td></tr> -<tr><td><a href="../api_cxx/txn_class.html">DbTxn</a></td><td><br></td><td>Transaction Class</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_abort.html">DbTxn::abort</a></td><td>Abort a transaction</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_commit.html">DbTxn::commit</a></td><td>Commit a transaction</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_id.html">DbTxn::id</a></td><td>Return a transaction ID</td></tr> -<tr><td><br></td><td><a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a></td><td>Prepare a transaction for commit</td></tr> -<tr><td><a href="../api_cxx/except_class.html">DbException</a></td><td><br></td><td>Exception Class for Berkeley DB Activity</td></tr> -<tr><td><br></td><td><a href="../api_cxx/get_errno.html">DbException::get_errno</a></td><td>Get the error value</td></tr> -<tr><td><br></td><td><a href="../api_cxx/what.html">DbException::what</a></td><td>Get the error string</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_cxx/cxx_pindex.html b/bdb/docs/api_cxx/cxx_pindex.html deleted file mode 100644 index d460fcf65c4..00000000000 --- a/bdb/docs/api_cxx/cxx_pindex.html +++ /dev/null @@ -1,516 +0,0 @@ -<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_cxx/dbt_class.html#6">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>DbMpoolFile::open</td><td><a href="../api_cxx/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_cxx/dbt_class.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> </td><td><a href="../api_cxx/db_class.html#2">Db</a></td></tr> -<tr><td align=right>Dbc::put</td><td><a href="../api_cxx/dbc_put.html#DB_AFTER">DB_AFTER</a></td></tr> -<tr><td align=right>Db::verify</td><td><a href="../api_cxx/db_verify.html#DB_AGGRESSIVE">DB_AGGRESSIVE</a></td></tr> -<tr><td align=right>Db::put</td><td><a href="../api_cxx/db_put.html#DB_APPEND">DB_APPEND</a></td></tr> -<tr><td align=right>DbEnv::log_archive</td><td><a href="../api_cxx/log_archive.html#DB_ARCH_ABS">DB_ARCH_ABS</a></td></tr> -<tr><td align=right>DbEnv::log_archive</td><td><a href="../api_cxx/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>DbEnv::log_archive</td><td><a href="../api_cxx/log_archive.html#DB_ARCH_LOG">DB_ARCH_LOG</a></td></tr> -<tr><td align=right>Dbc::put</td><td><a href="../api_cxx/dbc_put.html#DB_BEFORE">DB_BEFORE</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_class.html#2">Dbc</a></td></tr> -<tr><td align=right>Db::stat</td><td><a href="../api_cxx/db_stat.html#DB_CACHED_COUNTS">DB_CACHED_COUNTS</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_close.html#2">Dbc::close</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_count.html#2">Dbc::count</a></td></tr> -<tr><td align=right>DbEnv::set_flags</td><td><a href="../api_cxx/env_set_flags.html#DB_CDB_ALLDB">DB_CDB_ALLDB</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_del.html#2">Dbc::del</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_dup.html#2">Dbc::dup</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_get.html#2">Dbc::get</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/log_get.html#DB_CHECKPOINT">DB_CHECKPOINT</a></td></tr> -<tr><td align=right>DbEnv::log_put</td><td><a href="../api_cxx/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>DbEnv</td><td><a href="../api_cxx/dbenv_class.html#DB_CLIENT">DB_CLIENT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_close.html#2">Db::close</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_cxx/db_get.html#DB_CONSUME">DB_CONSUME</a></td></tr> -<tr><td align=right>Db::get</td><td><a href="../api_cxx/db_get.html#DB_CONSUME_WAIT">DB_CONSUME_WAIT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbc_put.html#2">Dbc::put</a></td></tr> -<tr><td align=right>Db::open</td><td><a href="../api_cxx/db_open.html#DB_CREATE">DB_CREATE</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_CREATE">DB_CREATE</a></td></tr> -<tr><td align=right>DbMpoolFile::open</td><td><a href="../api_cxx/memp_fopen.html#DB_CREATE">DB_CREATE</a></td></tr> -<tr><td align=right>DbEnv::log_put</td><td><a href="../api_cxx/log_put.html#DB_CURLSN">DB_CURLSN</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_CURRENT">DB_CURRENT</a></td></tr> -<tr><td align=right>Dbc::put</td><td><a href="../api_cxx/dbc_put.html#DB_CURRENT">DB_CURRENT</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/log_get.html#DB_CURRENT">DB_CURRENT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_cursor.html#2">Db::cursor</a></td></tr> -<tr><td align=right>Db</td><td><a href="../api_cxx/db_class.html#DB_CXX_NO_EXCEPTIONS">DB_CXX_NO_EXCEPTIONS</a></td></tr> -<tr><td align=right>DbEnv</td><td><a href="../api_cxx/dbenv_class.html#DB_CXX_NO_EXCEPTIONS">DB_CXX_NO_EXCEPTIONS</a></td></tr> -<tr><td align=right>Dbt</td><td><a href="../api_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a></td></tr> -<tr><td align=right>Dbt</td><td><a href="../api_cxx/dbt_class.html#DB_DBT_PARTIAL">DB_DBT_PARTIAL</a></td></tr> -<tr><td align=right>Dbt</td><td><a href="../api_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a></td></tr> -<tr><td align=right>Dbt</td><td><a href="../api_cxx/dbt_class.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="../api_cxx/db_del.html#2">Db::del</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_cxx/db_set_flags.html#DB_DUP">DB_DUP</a></td></tr> -<tr><td align=right>Db::set_flags</td><td><a href="../api_cxx/db_set_flags.html#DB_DUPSORT">DB_DUPSORT</a></td></tr> -<tr><td align=right>Db::upgrade</td><td><a href="../api_cxx/db_upgrade.html#DB_DUPSORT">DB_DUPSORT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbenv_class.html#2">DbEnv</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_close.html#2">DbEnv::close</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_err.html#2">DbEnv::err</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lock_detect.html#2">DbEnv::lock_detect</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lock_get.html#2">DbEnv::lock_get</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lock_id.html#2">DbEnv::lock_id</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lock_stat.html#2">DbEnv::lock_stat</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lock_vec.html#2">DbEnv::lock_vec</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_archive.html#2">DbEnv::log_archive</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_compare.html#2">DbEnv::log_compare</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_file.html#2">DbEnv::log_file</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_flush.html#2">DbEnv::log_flush</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_get.html#2">DbEnv::log_get</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_put.html#2">DbEnv::log_put</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_register.html#2">DbEnv::log_register</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_stat.html#2">DbEnv::log_stat</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/log_unregister.html#2">DbEnv::log_unregister</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_register.html#2">DbEnv::memp_register</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_stat.html#2">DbEnv::memp_stat</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_sync.html#2">DbEnv::memp_sync</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_trickle.html#2">DbEnv::memp_trickle</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_open.html#2">DbEnv::open</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_remove.html#2">DbEnv::remove</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_cachesize.html#2">DbEnv::set_cachesize</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_data_dir.html#2">DbEnv::set_data_dir</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_errcall.html#2">DbEnv::set_errcall</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_errfile.html#2">DbEnv::set_errfile</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_error_stream.html#2">DbEnv::set_error_stream</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_errpfx.html#2">DbEnv::set_errpfx</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_feedback.html#2">DbEnv::set_feedback</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_flags.html#2">DbEnv::set_flags</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lg_bsize.html#2">DbEnv::set_lg_bsize</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lg_dir.html#2">DbEnv::set_lg_dir</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lg_max.html#2">DbEnv::set_lg_max</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lk_conflicts.html#2">DbEnv::set_lk_conflicts</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lk_detect.html#2">DbEnv::set_lk_detect</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lk_max.html#2">DbEnv::set_lk_max</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lk_max_lockers.html#2">DbEnv::set_lk_max_lockers</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lk_max_locks.html#2">DbEnv::set_lk_max_locks</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_lk_max_objects.html#2">DbEnv::set_lk_max_objects</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_mp_mmapsize.html#2">DbEnv::set_mp_mmapsize</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_mutexlocks.html#2">DbEnv::set_mutexlocks</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_pageyield.html#2">DbEnv::set_pageyield</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_paniccall.html#2">DbEnv::set_paniccall</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_panicstate.html#2">DbEnv::set_panicstate</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_rec_init.html#2">DbEnv::set_recovery_init</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_region_init.html#2">DbEnv::set_region_init</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_server.html#2">DbEnv::set_server</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_shm_key.html#2">DbEnv::set_shm_key</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_tas_spins.html#2">DbEnv::set_tas_spins</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_tmp_dir.html#2">DbEnv::set_tmp_dir</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_tx_max.html#2">DbEnv::set_tx_max</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_tx_recover.html#2">DbEnv::set_tx_recover</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_tx_timestamp.html#2">DbEnv::set_tx_timestamp</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_set_verbose.html#2">DbEnv::set_verbose</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_strerror.html#2">DbEnv::strerror</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_begin.html#2">DbEnv::txn_begin</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_checkpoint.html#2">DbEnv::txn_checkpoint</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_stat.html#2">DbEnv::txn_stat</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/env_version.html#2">DbEnv::version</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/except_class.html#2">DbException</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/get_errno.html#2">DbException::get_errno</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/what.html#2">DbException::what</a></td></tr> -<tr><td align=right>Db::open</td><td><a href="../api_cxx/db_open.html#DB_EXCL">DB_EXCL</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_fd.html#2">Db::fd</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_FIRST">DB_FIRST</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/log_get.html#DB_FIRST">DB_FIRST</a></td></tr> -<tr><td align=right>DbEnv::log_put</td><td><a href="../api_cxx/log_put.html#DB_FLUSH">DB_FLUSH</a></td></tr> -<tr><td align=right>DbEnv::remove</td><td><a href="../api_cxx/env_remove.html#DB_FORCE">DB_FORCE</a></td></tr> -<tr><td align=right>DbEnv::txn_checkpoint</td><td><a href="../api_cxx/txn_checkpoint.html#DB_FORCE">DB_FORCE</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_get.html#2">Db::get</a></td></tr> -<tr><td align=right>Db::get</td><td><a href="../api_cxx/db_get.html#DB_GET_BOTH">DB_GET_BOTH</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_GET_BOTH">DB_GET_BOTH</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_get_byteswapped.html#2">Db::get_byteswapped</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_GET_RECNO">DB_GET_RECNO</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_get_type.html#2">Db::get_type</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_cxx/db_close.html#3">DB_INCOMPLETE</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_INIT_LOCK">DB_INIT_LOCK</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_INIT_LOG">DB_INIT_LOG</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_INIT_MPOOL">DB_INIT_MPOOL</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_INIT_TXN">DB_INIT_TXN</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_join.html#2">Db::join</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_JOINENV">DB_JOINENV</a></td></tr> -<tr><td align=right>Db::join</td><td><a href="../api_cxx/db_join.html#DB_JOIN_ITEM">DB_JOIN_ITEM</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_JOIN_ITEM">DB_JOIN_ITEM</a></td></tr> -<tr><td align=right>Db::join</td><td><a href="../api_cxx/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>Dbc::put</td><td><a href="../api_cxx/dbc_put.html#DB_KEYFIRST">DB_KEYFIRST</a></td></tr> -<tr><td align=right>Dbc::put</td><td><a href="../api_cxx/dbc_put.html#DB_KEYLAST">DB_KEYLAST</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_key_range.html#2">Db::key_range</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_LAST">DB_LAST</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/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> </td><td><a href="../api_cxx/lock_class.html#2">DbLock</a></td></tr> -<tr><td align=right>DbEnv::lock_detect</td><td><a href="../api_cxx/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_cxx/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_cxx/env_open.html#DB_LOCKDOWN">DB_LOCKDOWN</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/lock_vec.html#DB_LOCK_GET">DB_LOCK_GET</a></td></tr> -<tr><td align=right>DbEnv::lock_get</td><td><a href="../api_cxx/lock_get.html#DB_LOCK_NOTGRANTED">DB_LOCK_NOTGRANTED</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/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>DbEnv::lock_get</td><td><a href="../api_cxx/lock_get.html#DB_LOCK_NOWAIT">DB_LOCK_NOWAIT</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/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_cxx/env_set_lk_detect.html#DB_LOCK_OLDEST">DB_LOCK_OLDEST</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lock_put.html#2">DbLock::put</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/lock_vec.html#DB_LOCK_PUT">DB_LOCK_PUT</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/lock_vec.html#DB_LOCK_PUT_ALL">DB_LOCK_PUT_ALL</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/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_cxx/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_cxx/env_set_lk_detect.html#DB_LOCK_YOUNGEST">DB_LOCK_YOUNGEST</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/lsn_class.html#2">DbLsn</a></td></tr> -<tr><td align=right>DbMpoolFile::put</td><td><a href="../api_cxx/memp_fput.html#DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a></td></tr> -<tr><td align=right>DbMpoolFile::set</td><td><a href="../api_cxx/memp_fset.html#DB_MPOOL_CLEAN">DB_MPOOL_CLEAN</a></td></tr> -<tr><td align=right>DbMpoolFile::get</td><td><a href="../api_cxx/memp_fget.html#DB_MPOOL_CREATE">DB_MPOOL_CREATE</a></td></tr> -<tr><td align=right>DbMpoolFile::put</td><td><a href="../api_cxx/memp_fput.html#DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a></td></tr> -<tr><td align=right>DbMpoolFile::set</td><td><a href="../api_cxx/memp_fset.html#DB_MPOOL_DIRTY">DB_MPOOL_DIRTY</a></td></tr> -<tr><td align=right>DbMpoolFile::put</td><td><a href="../api_cxx/memp_fput.html#DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a></td></tr> -<tr><td align=right>DbMpoolFile::set</td><td><a href="../api_cxx/memp_fset.html#DB_MPOOL_DISCARD">DB_MPOOL_DISCARD</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/mempfile_class.html#2">DbMpoolFile</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_fclose.html#2">DbMpoolFile::close</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_fget.html#2">DbMpoolFile::get</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_fopen.html#2">DbMpoolFile::open</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_fput.html#2">DbMpoolFile::put</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_fset.html#2">DbMpoolFile::set</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/memp_fsync.html#2">DbMpoolFile::sync</a></td></tr> -<tr><td align=right>DbMpoolFile::get</td><td><a href="../api_cxx/memp_fget.html#DB_MPOOL_LAST">DB_MPOOL_LAST</a></td></tr> -<tr><td align=right>DbMpoolFile::get</td><td><a href="../api_cxx/memp_fget.html#DB_MPOOL_NEW">DB_MPOOL_NEW</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_NEXT">DB_NEXT</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/log_get.html#DB_NEXT">DB_NEXT</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_NEXT_DUP">DB_NEXT_DUP</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_NEXT_NODUP">DB_NEXT_NODUP</a></td></tr> -<tr><td align=right>Db::put</td><td><a href="../api_cxx/db_put.html#DB_NODUPDATA">DB_NODUPDATA</a></td></tr> -<tr><td align=right>Dbc::put</td><td><a href="../api_cxx/dbc_put.html#DB_NODUPDATA">DB_NODUPDATA</a></td></tr> -<tr><td align=right>Db::open</td><td><a href="../api_cxx/db_open.html#DB_NOMMAP">DB_NOMMAP</a></td></tr> -<tr><td align=right>DbEnv::set_flags</td><td><a href="../api_cxx/env_set_flags.html#DB_NOMMAP">DB_NOMMAP</a></td></tr> -<tr><td align=right>DbMpoolFile::open</td><td><a href="../api_cxx/memp_fopen.html#DB_NOMMAP">DB_NOMMAP</a></td></tr> -<tr><td align=right>Db::verify</td><td><a href="../api_cxx/db_verify.html#DB_NOORDERCHK">DB_NOORDERCHK</a></td></tr> -<tr><td align=right>Db::put</td><td><a href="../api_cxx/db_put.html#DB_NOOVERWRITE">DB_NOOVERWRITE</a></td></tr> -<tr><td align=right>DbEnv::set_server</td><td><a href="../api_cxx/env_set_server.html#DB_NOSERVER">DB_NOSERVER</a></td></tr> -<tr><td align=right>DbEnv::set_server</td><td><a href="../api_cxx/env_set_server.html#DB_NOSERVER_ID">DB_NOSERVER_ID</a></td></tr> -<tr><td align=right>Db::close</td><td><a href="../api_cxx/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_cxx/db_open.html#DB_OLD_VERSION">DB_OLD_VERSION</a></td></tr> -<tr><td align=right>Db::upgrade</td><td><a href="../api_cxx/db_upgrade.html#DB_OLD_VERSION">DB_OLD_VERSION</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_open.html#2">Db::open</a></td></tr> -<tr><td align=right>Db::verify</td><td><a href="../api_cxx/db_verify.html#DB_ORDERCHKONLY">DB_ORDERCHKONLY</a></td></tr> -<tr><td align=right>Dbc::dup</td><td><a href="../api_cxx/dbc_dup.html#DB_POSITION">DB_POSITION</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_PREV">DB_PREV</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/log_get.html#DB_PREV">DB_PREV</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/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_cxx/env_open.html#DB_PRIVATE">DB_PRIVATE</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_put.html#2">Db::put</a></td></tr> -<tr><td align=right>Db::open</td><td><a href="../api_cxx/db_open.html#DB_RDONLY">DB_RDONLY</a></td></tr> -<tr><td align=right>DbMpoolFile::open</td><td><a href="../api_cxx/memp_fopen.html#DB_RDONLY">DB_RDONLY</a></td></tr> -<tr><td align=right>Db::set_flags</td><td><a href="../api_cxx/db_set_flags.html#DB_RECNUM">DB_RECNUM</a></td></tr> -<tr><td align=right>Db::stat</td><td><a href="../api_cxx/db_stat.html#DB_RECORDCOUNT">DB_RECORDCOUNT</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_RECOVER">DB_RECOVER</a></td></tr> -<tr><td align=right>DbEnv::set_feedback</td><td><a href="../api_cxx/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_cxx/env_open.html#DB_RECOVER_FATAL">DB_RECOVER_FATAL</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_remove.html#2">Db::remove</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_rename.html#2">Db::rename</a></td></tr> -<tr><td align=right>Db::set_flags</td><td><a href="../api_cxx/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a></td></tr> -<tr><td align=right>Db::set_flags</td><td><a href="../api_cxx/db_set_flags.html#DB_REVSPLITOFF">DB_REVSPLITOFF</a></td></tr> -<tr><td align=right>Db::get</td><td><a href="../api_cxx/db_get.html#DB_RMW">DB_RMW</a></td></tr> -<tr><td align=right>Db::join</td><td><a href="../api_cxx/db_join.html#DB_RMW">DB_RMW</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/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_cxx/db_verify.html#DB_SALVAGE">DB_SALVAGE</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_SET">DB_SET</a></td></tr> -<tr><td align=right>DbEnv::log_get</td><td><a href="../api_cxx/log_get.html#DB_SET">DB_SET</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_append_recno.html#2">Db::set_append_recno</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_bt_compare.html#2">Db::set_bt_compare</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_bt_minkey.html#2">Db::set_bt_minkey</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_bt_prefix.html#2">Db::set_bt_prefix</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_cachesize.html#2">Db::set_cachesize</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_dup_compare.html#2">Db::set_dup_compare</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_errcall.html#2">Db::set_errcall</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_errfile.html#2">Db::set_errfile</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_errpfx.html#2">Db::set_errpfx</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_feedback.html#2">Db::set_feedback</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_flags.html#2">Db::set_flags</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_h_ffactor.html#2">Db::set_h_ffactor</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_h_hash.html#2">Db::set_h_hash</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_h_nelem.html#2">Db::set_h_nelem</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_lorder.html#2">Db::set_lorder</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_malloc.html#2">Db::set_malloc</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_pagesize.html#2">Db::set_pagesize</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_paniccall.html#2">Db::set_paniccall</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_q_extentsize.html#2">Db::set_q_extentsize</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_SET_RANGE">DB_SET_RANGE</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_realloc.html#2">Db::set_realloc</a></td></tr> -<tr><td align=right>Db::get</td><td><a href="../api_cxx/db_get.html#DB_SET_RECNO">DB_SET_RECNO</a></td></tr> -<tr><td align=right>Dbc::get</td><td><a href="../api_cxx/dbc_get.html#DB_SET_RECNO">DB_SET_RECNO</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_re_delim.html#2">Db::set_re_delim</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_re_len.html#2">Db::set_re_len</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_re_pad.html#2">Db::set_re_pad</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_set_re_source.html#2">Db::set_re_source</a></td></tr> -<tr><td align=right>Db::set_flags</td><td><a href="../api_cxx/db_set_flags.html#DB_SNAPSHOT">DB_SNAPSHOT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_stat.html#2">Db::stat</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_cxx/db_sync.html#2">Db::sync</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/dbt_class.html#2">Dbt</a></td></tr> -<tr><td align=right>Db::open</td><td><a href="../api_cxx/db_open.html#DB_THREAD">DB_THREAD</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/env_open.html#DB_THREAD">DB_THREAD</a></td></tr> -<tr><td align=right>Db::open</td><td><a href="../api_cxx/db_open.html#DB_TRUNCATE">DB_TRUNCATE</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_class.html#2">DbTxn</a></td></tr> -<tr><td align=right>DbEnv::set_tx_recover</td><td><a href="../api_cxx/env_set_tx_recover.html#DB_TXN_ABORT">DB_TXN_ABORT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_abort.html#2">DbTxn::abort</a></td></tr> -<tr><td align=right>DbEnv::set_tx_recover</td><td><a href="../api_cxx/env_set_tx_recover.html#DB_TXN_BACKWARD_ROLL">DB_TXN_BACKWARD_ROLL</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_commit.html#2">DbTxn::commit</a></td></tr> -<tr><td align=right>DbEnv::set_tx_recover</td><td><a href="../api_cxx/env_set_tx_recover.html#DB_TXN_FORWARD_ROLL">DB_TXN_FORWARD_ROLL</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_id.html#2">DbTxn::id</a></td></tr> -<tr><td align=right>DbEnv::set_flags</td><td><a href="../api_cxx/env_set_flags.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></td></tr> -<tr><td align=right>DbEnv::txn_begin</td><td><a href="../api_cxx/txn_begin.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></td></tr> -<tr><td align=right>DbTxn::commit</td><td><a href="../api_cxx/txn_commit.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a></td></tr> -<tr><td align=right>DbEnv::txn_begin</td><td><a href="../api_cxx/txn_begin.html#DB_TXN_NOWAIT">DB_TXN_NOWAIT</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/txn_prepare.html#2">DbTxn::prepare</a></td></tr> -<tr><td align=right>DbEnv::txn_begin</td><td><a href="../api_cxx/txn_begin.html#DB_TXN_SYNC">DB_TXN_SYNC</a></td></tr> -<tr><td align=right>DbTxn::commit</td><td><a href="../api_cxx/txn_commit.html#DB_TXN_SYNC">DB_TXN_SYNC</a></td></tr> -<tr><td align=right>Db::set_feedback</td><td><a href="../api_cxx/db_set_feedback.html#DB_UPGRADE">DB_UPGRADE</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_upgrade.html#2">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_cxx/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a></td></tr> -<tr><td align=right>DbEnv::remove</td><td><a href="../api_cxx/env_remove.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a></td></tr> -<tr><td align=right>DbEnv::open</td><td><a href="../api_cxx/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_cxx/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_cxx/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_cxx/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_cxx/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_cxx/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_cxx/db_set_feedback.html#DB_VERIFY">DB_VERIFY</a></td></tr> -<tr><td align=right> </td><td><a href="../api_cxx/db_verify.html#2">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>Db::cursor</td><td><a href="../api_cxx/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a></td></tr> -<tr><td align=right>Db</td><td><a href="../api_cxx/db_class.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> 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>DbMpoolFile::open</td><td><a href="../api_cxx/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>DbMpoolFile::open</td><td><a href="../api_cxx/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="../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_cxx/dbt_class.html#3">key/data</a> pairs</td></tr> -<tr><td align=right> retrieved </td><td><a href="../api_cxx/dbt_class.html#5">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>DbEnv::lock_vec</td><td><a href="../api_cxx/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> page-level </td><td><a href="../ref/lock/page.html#2">locking</a></td></tr> -<tr><td align=right> two-phase </td><td><a href="../ref/lock/twopl.html#2">locking</a></td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/nondb.html#2">locking</a> and non-Berkeley DB applications</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/config.html#2">locking</a> configuration</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/am_conv.html#2">locking</a> conventions</td></tr> -<tr><td align=right> Berkeley DB Concurrent Data Store </td><td><a href="../ref/lock/cam_conv.html#2">locking</a> conventions</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/intro.html#2">locking</a> introduction</td></tr> -<tr><td align=right> sizing the </td><td><a href="../ref/lock/max.html#2">locking</a> subsystem</td></tr> -<tr><td align=right> </td><td><a href="../ref/lock/notxn.html#2">locking</a> without transactions</td></tr> -<tr><td align=right> </td><td><a href="../ref/log/limits.html#2">log</a> file limits</td></tr> -<tr><td align=right> </td><td><a href="../ref/transapp/logfile.html#2">log</a> file removal</td></tr> -<tr><td align=right> utility to display </td><td><a href="../utility/db_printlog.html#3">log</a> files as text</td></tr> -<tr><td align=right> </td><td><a href="../ref/log/config.html#2">logging</a> configuration</td></tr> -<tr><td align=right> </td><td><a href="../ref/log/intro.html#2">logging</a> introduction</td></tr> -<tr><td align=right>DbMpoolFile::open</td><td><a href="../api_cxx/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>DbEnv::lock_vec</td><td><a href="../api_cxx/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>DbEnv::lock_vec</td><td><a href="../api_cxx/lock_vec.html#obj">obj</a></td></tr> -<tr><td align=right>DbEnv::lock_vec</td><td><a href="../api_cxx/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_cxx/dbt_class.html#4">permanence</a></td></tr> -<tr><td align=right>DbMpoolFile::open</td><td><a href="../api_cxx/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_cxx/dbt_class.html#7">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></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="../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_cxx/db_class.html b/bdb/docs/api_cxx/db_class.html deleted file mode 100644 index 75296aeee61..00000000000 --- a/bdb/docs/api_cxx/db_class.html +++ /dev/null @@ -1,109 +0,0 @@ -<!--$Id: db_class.so,v 10.23 2000/03/17 01:54:00 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: Db</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>Db</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class Db { -public: - Db(DbEnv *dbenv, u_int32_t flags); - ~Db(); - ... -}; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the specific details of the Db class, -which is the center of access method activity. -<p>If no <b>dbenv</b> value is specified, the database is standalone, i.e., -it is not part of any Berkeley DB environment. -<p>If a <b>dbenv</b> value is specified, 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> 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_CXX_NO_EXCEPTIONS">DB_CXX_NO_EXCEPTIONS</a><dd>The Berkeley DB C++ API supports two different error behaviors. By default, -whenever an error occurs an exception is thrown that encapsulates the -error information. This generally allows for cleaner logic for -transaction processing, as a try block can surround a single transaction. -However, if DB_CXX_NO_EXCEPTIONS is specified, exceptions are not -thrown, instead each individual function returns an error code. -<p>If <b>dbenv</b> is not null, this flag is ignored and the error behavior -of the specified environment is used instead. -<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> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_close.html b/bdb/docs/api_cxx/db_close.html deleted file mode 100644 index fdde15bdb67..00000000000 --- a/bdb/docs/api_cxx/db_close.html +++ /dev/null @@ -1,123 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::close(u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::close method 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_cxx/db_sync.html">Db::sync</a> method 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_cxx/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 method. -<p>Once Db::close has been called, regardless of its return, the -<a href="../api_cxx/db_class.html">Db</a> handle may not be accessed again. - <a name="3"><!--meow--></a> -<p>The Db::close method either returns a non-zero error value or throws an exception that -encapsulates 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 method 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_cxx/db_close.html#DB_NOSYNC">DB_NOSYNC</a> option should probably -have been specified.) -<p>The Db::close method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::close method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::close method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_cursor.html b/bdb/docs/api_cxx/db_cursor.html deleted file mode 100644 index b6954b9f329..00000000000 --- a/bdb/docs/api_cxx/db_cursor.html +++ /dev/null @@ -1,105 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::cursor(DbTxn *txnid, Dbc **cursorp, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::cursor method -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_cxx/txn_begin.html">DbEnv::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_cxx/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag -was specified to <a href="../api_cxx/env_open.html">DbEnv::open</a>. -</dl> -<p>The Db::cursor method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::cursor method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::cursor method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_del.html b/bdb/docs/api_cxx/db_del.html deleted file mode 100644 index ec30c6ad01c..00000000000 --- a/bdb/docs/api_cxx/db_del.html +++ /dev/null @@ -1,104 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::del(DbTxn *txnid, Dbt *key, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::del method 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_cxx/txn_begin.html">DbEnv::txn_begin</a>, otherwise, NULL. -<p>The <b>flags</b> parameter is currently unused, and must be set to 0. -<p>The Db::del method either returns a non-zero error value or throws an exception that -encapsulates 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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::del method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_err.html b/bdb/docs/api_cxx/db_err.html deleted file mode 100644 index fa0bccc3926..00000000000 --- a/bdb/docs/api_cxx/db_err.html +++ /dev/null @@ -1,94 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -DbEnv::err(int error, const char *fmt, ...); -<p> -DbEnv::errx(const char *fmt, ...); -<p> -Db::err(int error, const char *fmt, ...); -<p> -Db::errx(const char *fmt, ...); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::err, DbEnv::errx, Db::err and -Db::errx methods provide error messaging functionality for -applications written using the Berkeley DB library. -<p>The DbEnv::err method 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 method has been set using the -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method, any prefix string specified using the -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a> method, 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_cxx/env_strerror.html">DbEnv::strerror</a> method. -</dl> -</blockquote> -<p>This constructed error message is then handled as follows: -<p><blockquote> -<p>If an error callback method has been set (see <a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a> -and <a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>), that method is called with two -arguments: any prefix string specified (see <a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a> and -<a href="../api_cxx/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_cxx/db_set_errfile.html">Db::set_errfile</a> and -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>), the error message is written to that output -stream. -<p>If a C++ ostream has been set -(see <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>), the error message is written to that -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 methods perform identically to the -DbEnv::err and Db::err methods except that they do not append -the final separator characters and standard error string to the error -message. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_fd.html b/bdb/docs/api_cxx/db_fd.html deleted file mode 100644 index 1cb98fb6bc7..00000000000 --- a/bdb/docs/api_cxx/db_fd.html +++ /dev/null @@ -1,95 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::fd(int *fdp); -</pre></h3> -<h1>Description</h1> -<p>The Db::fd method -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_cxx/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 method only supports a coarse-grained form of locking. -Applications should use the lock manager where possible. -<p>The Db::fd method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::fd method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::fd method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_get.html b/bdb/docs/api_cxx/db_get.html deleted file mode 100644 index 0cee5526b50..00000000000 --- a/bdb/docs/api_cxx/db_get.html +++ /dev/null @@ -1,158 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::get(DbTxn *txnid, Dbt *key, Dbt *data, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::get method 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_cxx/dbc_get.html">Dbc::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_cxx/txn_begin.html">DbEnv::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_cxx/dbt_class.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 method. -<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_cxx/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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::get method may fail and throw an exception or 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_cxx/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified to the -<a href="../api_cxx/db_open.html">Db::open</a> method and none of the <a href="../api_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, -<a href="../api_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> or <a href="../api_cxx/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags were set in the -<a href="../api_cxx/dbt_class.html">Dbt</a>. -</dl> -<p>The Db::get method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::get method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_get_byteswapped.html b/bdb/docs/api_cxx/db_get_byteswapped.html deleted file mode 100644 index 5c661fa5776..00000000000 --- a/bdb/docs/api_cxx/db_get_byteswapped.html +++ /dev/null @@ -1,85 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::get_byteswapped(void) const; -</pre></h3> -<h1>Description</h1> -<p>The Db::get_byteswapped method 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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_get_type.html b/bdb/docs/api_cxx/db_get_type.html deleted file mode 100644 index 755032390fc..00000000000 --- a/bdb/docs/api_cxx/db_get_type.html +++ /dev/null @@ -1,82 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -DBTYPE -Db::get_type(void) const; -</pre></h3> -<h1>Description</h1> -<p>The Db::get_type method 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_cxx/db_open.html">Db::open</a> -with the <b>type</b> argument set to DB_UNKNOWN. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_join.html b/bdb/docs/api_cxx/db_join.html deleted file mode 100644 index 6767aaf769e..00000000000 --- a/bdb/docs/api_cxx/db_join.html +++ /dev/null @@ -1,153 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::join(Dbc **curslist, Dbc **dbcp, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::join method 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 <a href="../api_cxx/db_class.html">Db</a> 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_cxx/dbc_get.html">Dbc::get</a> call with the <a href="../api_cxx/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_cxx/dbc_get.html">Dbc::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_cxx/dbc_put.html">Dbc::put</a><dd>Returns EINVAL. -<p><dt><a href="../api_cxx/dbc_del.html">Dbc::del</a><dd>Returns EINVAL. -<p><dt><a href="../api_cxx/dbc_close.html">Dbc::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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::join method may fail and throw an exception or 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_cxx/dbc_put.html">Dbc::put</a> or <a href="../api_cxx/dbc_del.html">Dbc::del</a> functions were called. -</dl> -<p>The Db::join method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::join method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_key_range.html b/bdb/docs/api_cxx/db_key_range.html deleted file mode 100644 index 980dc119ae6..00000000000 --- a/bdb/docs/api_cxx/db_key_range.html +++ /dev/null @@ -1,109 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::key_range(DbTxn *txnid - Dbt *key, DB_KEY_RANGE *key_range, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::key_range method 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_cxx/txn_begin.html">DbEnv::txn_begin</a>, otherwise, NULL. -The Db::key_range method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::key_range method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::key_range method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_open.html b/bdb/docs/api_cxx/db_open.html deleted file mode 100644 index 4c8cb75f452..00000000000 --- a/bdb/docs/api_cxx/db_open.html +++ /dev/null @@ -1,185 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::open(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_cxx/dbt_class.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_cxx/db_get_type.html">Db::get_type</a> method 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_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a> method 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 <a href="../api_cxx/db_class.html">Db</a> 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/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 method may fail and throw an exception or 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_cxx/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified and spinlocks are not -implemented for this architecture. -<p>The <a href="../api_cxx/env_open.html#DB_THREAD">DB_THREAD</a> flag was specified to Db::open, but was not -specified to the <a href="../api_cxx/env_open.html">DbEnv::open</a> call for the environment in which the -<a href="../api_cxx/db_class.html">Db</a> handle was created. -<p>A <b>re_source</b> file was specified with either the <a href="../api_cxx/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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::open method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_put.html b/bdb/docs/api_cxx/db_put.html deleted file mode 100644 index 5e2d1b8c4c9..00000000000 --- a/bdb/docs/api_cxx/db_put.html +++ /dev/null @@ -1,138 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::put(DbTxn *txnid, Dbt *key, Dbt *data, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::put method 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 method 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_cxx/txn_begin.html">DbEnv::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_cxx/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_cxx/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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::put method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::put method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_remove.html b/bdb/docs/api_cxx/db_remove.html deleted file mode 100644 index 56cc5a23439..00000000000 --- a/bdb/docs/api_cxx/db_remove.html +++ /dev/null @@ -1,110 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::remove(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 method 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 -<a href="../api_cxx/db_class.html">Db</a> handle may not be accessed again. -<p>The Db::remove method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::remove method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_rename.html b/bdb/docs/api_cxx/db_rename.html deleted file mode 100644 index 03f2063d41a..00000000000 --- a/bdb/docs/api_cxx/db_rename.html +++ /dev/null @@ -1,112 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::rename(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 method 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 -<a href="../api_cxx/db_class.html">Db</a> handle may not be accessed again. -<p>The Db::rename method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::rename method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_append_recno.html b/bdb/docs/api_cxx/db_set_append_recno.html deleted file mode 100644 index 296b4748407..00000000000 --- a/bdb/docs/api_cxx/db_set_append_recno.html +++ /dev/null @@ -1,69 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_append_recno( - 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_cxx/db_put.html#DB_APPEND">DB_APPEND</a> option of the <a href="../api_cxx/db_put.html">Db::put</a> method, -it may be useful to modify the stored data based on the generated key. -If a callback method is specified using the -Db::set_append_recno method, 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_cxx/dbt_class.html">Dbt</a> to be stored and the -selected record number. The called function may then modify the data -<a href="../api_cxx/dbt_class.html">Dbt</a>. -<p>The Db::set_append_recno interface may only be used to configure Berkeley DB before -the <a href="../api_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_append_recno method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_bt_compare.html b/bdb/docs/api_cxx/db_set_bt_compare.html deleted file mode 100644 index 5ca95d40110..00000000000 --- a/bdb/docs/api_cxx/db_set_bt_compare.html +++ /dev/null @@ -1,109 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef int (*bt_compare_fcn_type)(DB *, const DBT *, const DBT *); -}; -int -Db::set_bt_compare(bt_compare_fcn_type bt_compare_fcn); -</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_cxx/dbt_class.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_cxx/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_cxx/dbt_class.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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_bt_compare method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_bt_minkey.html b/bdb/docs/api_cxx/db_set_bt_minkey.html deleted file mode 100644 index c0c5aced12b..00000000000 --- a/bdb/docs/api_cxx/db_set_bt_minkey.html +++ /dev/null @@ -1,94 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_bt_minkey(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_bt_minkey method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_bt_prefix.html b/bdb/docs/api_cxx/db_set_bt_prefix.html deleted file mode 100644 index ecf9495459a..00000000000 --- a/bdb/docs/api_cxx/db_set_bt_prefix.html +++ /dev/null @@ -1,110 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef size_t (*bt_prefix_fcn_type)(DB *, const DBT *, const DBT *); -}; -int -Db::set_bt_prefix(bt_prefix_fcn_type bt_prefix_fcn); -</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_cxx/dbt_class.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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_bt_prefix method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_cachesize.html b/bdb/docs/api_cxx/db_set_cachesize.html deleted file mode 100644 index cc8e020cc30..00000000000 --- a/bdb/docs/api_cxx/db_set_cachesize.html +++ /dev/null @@ -1,108 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_cachesize(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_cachesize method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_dup_compare.html b/bdb/docs/api_cxx/db_set_dup_compare.html deleted file mode 100644 index 7cd09ec0cb1..00000000000 --- a/bdb/docs/api_cxx/db_set_dup_compare.html +++ /dev/null @@ -1,106 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef int (*dup_compare_fcn_type)(DB *, const DBT *, const DBT *); -}; -int -Db::set_dup_compare(dup_compare_fcn_type dup_compare_fcn); -</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_cxx/dbt_class.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_cxx/dbt_class.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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_dup_compare method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_errcall.html b/bdb/docs/api_cxx/db_set_errcall.html deleted file mode 100644 index 6cc5310eb50..00000000000 --- a/bdb/docs/api_cxx/db_set_errcall.html +++ /dev/null @@ -1,79 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -void Db::set_errcall( - void (*db_errcall_fcn)(const char *errpfx, char *msg)); -</pre></h3> -<h1>Description</h1> -When an error occurs in the Berkeley DB library, an exception is thrown or an -error return value is returned by the method. In some cases, -however, the <b>errno</b> value may be insufficient to completely -describe the cause of the error, especially during initial application -debugging. -<p>The Db::set_errcall method 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 defined with two arguments; the first will be the prefix -string (as previously set by <a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a> or -<a href="../api_cxx/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> method to display the error -message in an appropriate manner. -<p>Alternatively, you can use the <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method to display -the additional information via an output stream, or the <a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a> -or <a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> methods to display the additional information via a C -library FILE *. You should not mix these approaches. -<p>This error logging enhancement does not slow performance or significantly -increase application size, and may be run during normal operation as well -as during application debugging. -<p>For <a href="../api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the -Db::set_errcall method affects the entire environment and is equivalent to calling -the <a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method. -<p>The Db::set_errcall interface may be used to configure Berkeley DB at any time -during the life of the application. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_errfile.html b/bdb/docs/api_cxx/db_set_errfile.html deleted file mode 100644 index 50c6bebd1d8..00000000000 --- a/bdb/docs/api_cxx/db_set_errfile.html +++ /dev/null @@ -1,80 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -void Db::set_errfile(FILE *errfile); -</pre></h3> -<h1>Description</h1> -When an error occurs in the Berkeley DB library, an exception is thrown or an -error return value is returned by the method. In some cases, -however, the <b>errno</b> value may be insufficient to completely -describe the cause of the error, especially during initial application -debugging. -<p>The Db::set_errfile method 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>Alternatively, you can use the <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method to display -the additional information via an output stream, or the -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method to capture the additional error information in -a way that does not use either output streams or C library FILE *'s. You -should not mix these approaches. -<p>The error message will consist of the prefix string and a colon -("<b>:</b>") (if a prefix string was previously specified using -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a> or <a href="../api_cxx/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 <a href="../api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the -Db::set_errfile method affects the entire environment and is equivalent to calling -the <a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> method. -<p>The Db::set_errfile interface may be used to configure Berkeley DB at any time -during the life of the application. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_errpfx.html b/bdb/docs/api_cxx/db_set_errpfx.html deleted file mode 100644 index 0baa3ba674c..00000000000 --- a/bdb/docs/api_cxx/db_set_errpfx.html +++ /dev/null @@ -1,63 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -void Db::set_errpfx(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 method 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 <a href="../api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the -Db::set_errpfx method affects the entire environment and is equivalent to calling -the <a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a> method. -<p>The Db::set_errpfx interface may be used to configure Berkeley DB at any time -during the life of the application. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_feedback.html b/bdb/docs/api_cxx/db_set_feedback.html deleted file mode 100644 index 97a5a85b717..00000000000 --- a/bdb/docs/api_cxx/db_set_feedback.html +++ /dev/null @@ -1,97 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_feedback( - 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 method 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 method. This method 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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_flags.html b/bdb/docs/api_cxx/db_set_flags.html deleted file mode 100644 index 059810357ec..00000000000 --- a/bdb/docs/api_cxx/db_set_flags.html +++ /dev/null @@ -1,183 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_flags(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_cxx/db_set_dup_compare.html">Db::set_dup_compare</a> method, 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_cxx/db_get.html">Db::get</a> and -<a href="../api_cxx/dbc_get.html">Dbc::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_cxx/db_set_dup_compare.html">Db::set_dup_compare</a> method, 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_cxx/db_put.html">Db::put</a> or <a href="../api_cxx/dbc_put.html">Dbc::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_cxx/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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_flags method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_h_ffactor.html b/bdb/docs/api_cxx/db_set_h_ffactor.html deleted file mode 100644 index fa7d4209e8e..00000000000 --- a/bdb/docs/api_cxx/db_set_h_ffactor.html +++ /dev/null @@ -1,95 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_h_ffactor(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_h_ffactor method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_h_hash.html b/bdb/docs/api_cxx/db_set_h_hash.html deleted file mode 100644 index 71808b081c8..00000000000 --- a/bdb/docs/api_cxx/db_set_h_hash.html +++ /dev/null @@ -1,102 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef u_int32_t (*h_hash_fcn_type) - (DB *, const void *bytes, u_int32_t length); -}; -int -Db::set_h_hash(h_hash_fcn_type h_hash_fcn); -</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_cxx/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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_h_hash method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_h_nelem.html b/bdb/docs/api_cxx/db_set_h_nelem.html deleted file mode 100644 index 55698d45737..00000000000 --- a/bdb/docs/api_cxx/db_set_h_nelem.html +++ /dev/null @@ -1,90 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_h_nelem(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_h_nelem method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_lorder.html b/bdb/docs/api_cxx/db_set_lorder.html deleted file mode 100644 index f25779a252a..00000000000 --- a/bdb/docs/api_cxx/db_set_lorder.html +++ /dev/null @@ -1,96 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_lorder(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_lorder method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_malloc.html b/bdb/docs/api_cxx/db_set_malloc.html deleted file mode 100644 index e38092fcbeb..00000000000 --- a/bdb/docs/api_cxx/db_set_malloc.html +++ /dev/null @@ -1,103 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -Db::set_malloc(db_malloc_fcn_type db_malloc); -</pre></h3> -<h1>Description</h1> -<p>Set the allocation function used by the <a href="../api_cxx/db_class.html">Db</a> methods to allocate -memory in which to return key/data items to the application. -<p>The <a href="../api_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a> flag, when specified in the <a href="../api_cxx/dbt_class.html">Dbt</a> object, -will cause the <a href="../api_cxx/db_class.html">Db</a> methods to allocate and re-allocate memory which -then becomes the responsibility of the calling application. See <a href="../api_cxx/dbt_class.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_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a> flag will fail because -the <a href="../api_cxx/db_class.html">Db</a> library will allocate memory from a different heap than -the application will use to free it. To avoid this problem, the -Db::set_malloc method 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_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a> flag is set. -<p>The method 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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_malloc method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_pagesize.html b/bdb/docs/api_cxx/db_set_pagesize.html deleted file mode 100644 index 114f0578aa7..00000000000 --- a/bdb/docs/api_cxx/db_set_pagesize.html +++ /dev/null @@ -1,92 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_pagesize(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_pagesize method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_paniccall.html b/bdb/docs/api_cxx/db_set_paniccall.html deleted file mode 100644 index 7cd08de4a53..00000000000 --- a/bdb/docs/api_cxx/db_set_paniccall.html +++ /dev/null @@ -1,76 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_paniccall( - void (*db_paniccall_fcn)(DbEnv *dbenv, 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, when the C++ error model has been configured so that the -individual Berkeley DB methods return error codes (see <a href="../api_cxx/except_class.html">DbException</a> for -more information), the value <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> is returned by Berkeley DB -methods. -<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 method is used to specify a method 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 method. -<p>For <a href="../api_cxx/db_class.html">Db</a> handles opened inside of Berkeley DB environments, calling the -Db::set_paniccall method affects the entire environment and is equivalent to calling -the <a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a> method. -<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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_q_extentsize.html b/bdb/docs/api_cxx/db_set_q_extentsize.html deleted file mode 100644 index d9c702196b7..00000000000 --- a/bdb/docs/api_cxx/db_set_q_extentsize.html +++ /dev/null @@ -1,92 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_q_extentsize(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_q_extentsize method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_re_delim.html b/bdb/docs/api_cxx/db_set_re_delim.html deleted file mode 100644 index c88d6e89e06..00000000000 --- a/bdb/docs/api_cxx/db_set_re_delim.html +++ /dev/null @@ -1,92 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_re_delim(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_re_delim method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_re_len.html b/bdb/docs/api_cxx/db_set_re_len.html deleted file mode 100644 index 7432ced166d..00000000000 --- a/bdb/docs/api_cxx/db_set_re_len.html +++ /dev/null @@ -1,96 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_re_len(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_cxx/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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_re_len method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_re_pad.html b/bdb/docs/api_cxx/db_set_re_pad.html deleted file mode 100644 index 5b9453d0db2..00000000000 --- a/bdb/docs/api_cxx/db_set_re_pad.html +++ /dev/null @@ -1,90 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_re_pad(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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_re_pad method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_re_source.html b/bdb/docs/api_cxx/db_set_re_source.html deleted file mode 100644 index ea51dde6202..00000000000 --- a/bdb/docs/api_cxx/db_set_re_source.html +++ /dev/null @@ -1,132 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::set_re_source(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_cxx/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_cxx/db_close.html">Db::close</a> or <a href="../api_cxx/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_cxx/db_open.html">Db::open</a> call. See the <a href="../api_cxx/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_cxx/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_cxx/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_cxx/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_cxx/db_sync.html">Db::sync</a> or <a href="../api_cxx/db_close.html">Db::close</a> methods will fail, of course. -Specify the <a href="../api_cxx/db_close.html#DB_NOSYNC">DB_NOSYNC</a> flag to the <a href="../api_cxx/db_close.html">Db::close</a> method 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 <a href="../api_cxx/db_class.html">Db</a> 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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_re_source method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/db_open.html">Db::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_set_realloc.html b/bdb/docs/api_cxx/db_set_realloc.html deleted file mode 100644 index e163a889c33..00000000000 --- a/bdb/docs/api_cxx/db_set_realloc.html +++ /dev/null @@ -1,103 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_realloc_fcn_type)(void *, size_t); -}; -int -Db::set_realloc(db_realloc_fcn_type db_realloc_fcn); -</pre></h3> -<h1>Description</h1> -<p>Set the realloc function used by the <a href="../api_cxx/db_class.html">Db</a> methods to allocate memory -in which to return key/data items to the application. -<p>The <a href="../api_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> flag, when specified in the <a href="../api_cxx/dbt_class.html">Dbt</a> object, -will cause the <a href="../api_cxx/db_class.html">Db</a> methods to allocate and re-allocate memory which -then becomes the responsibility of the calling application. See <a href="../api_cxx/dbt_class.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_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> flag will fail because -the <a href="../api_cxx/db_class.html">Db</a> library will allocate memory from a different heap than -the application will use to free it. To avoid this problem, the -Db::set_realloc method 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_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> flag is set. -<p>The method 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_cxx/db_open.html">Db::open</a> interface is called. -<p>The Db::set_realloc method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_stat.html b/bdb/docs/api_cxx/db_stat.html deleted file mode 100644 index 4245fd91704..00000000000 --- a/bdb/docs/api_cxx/db_stat.html +++ /dev/null @@ -1,201 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -Db::stat(void *sp, db_malloc_fcn_type db_malloc, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::stat method 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_cxx/db_set_flags.html#DB_RECNUM">DB_RECNUM</a> -flag. -</dl> -<p>The Db::stat method 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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Db::stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::stat method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_sync.html b/bdb/docs/api_cxx/db_sync.html deleted file mode 100644 index 170d99127f5..00000000000 --- a/bdb/docs/api_cxx/db_sync.html +++ /dev/null @@ -1,101 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::sync(u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::sync method flushes any cached information to disk. -<p>If the database is in memory only, the Db::sync method 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_cxx/db_close.html">Db::close</a> for a discussion of Berkeley DB and cached data. -<p>The Db::sync method either returns a non-zero error value or throws an exception that -encapsulates 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 method 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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::sync method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_upgrade.html b/bdb/docs/api_cxx/db_upgrade.html deleted file mode 100644 index 8cbc3561fe3..00000000000 --- a/bdb/docs/api_cxx/db_upgrade.html +++ /dev/null @@ -1,135 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::upgrade(const char *file, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::upgrade method 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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::upgrade method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/db_verify.html b/bdb/docs/api_cxx/db_verify.html deleted file mode 100644 index 7e742af4c50..00000000000 --- a/bdb/docs/api_cxx/db_verify.html +++ /dev/null @@ -1,150 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Db::verify(const char *file, - const char *database, ostream *outfile, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Db::verify method 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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates 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. -<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_cxx/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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Db::verify method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/db_class.html">Db</a> -<h1>See Also</h1> -<a href="../api_cxx/db_close.html">Db::close</a>, -<a href="../api_cxx/db_cursor.html">Db::cursor</a>, -<a href="../api_cxx/db_del.html">Db::del</a>, -<a href="../api_cxx/db_err.html">Db::err</a>, -<a href="../api_cxx/db_fd.html">Db::fd</a>, -<a href="../api_cxx/db_get.html">Db::get</a>, -<a href="../api_cxx/db_get_byteswapped.html">Db::get_byteswapped</a>, -<a href="../api_cxx/db_get_type.html">Db::get_type</a>, -<a href="../api_cxx/db_join.html">Db::join</a>, -<a href="../api_cxx/db_key_range.html">Db::key_range</a>, -<a href="../api_cxx/db_open.html">Db::open</a>, -<a href="../api_cxx/db_put.html">Db::put</a>, -<a href="../api_cxx/db_remove.html">Db::remove</a>, -<a href="../api_cxx/db_set_bt_compare.html">Db::set_bt_compare</a>, -<a href="../api_cxx/db_set_bt_minkey.html">Db::set_bt_minkey</a>, -<a href="../api_cxx/db_set_bt_prefix.html">Db::set_bt_prefix</a>, -<a href="../api_cxx/db_set_cachesize.html">Db::set_cachesize</a>, -<a href="../api_cxx/db_set_dup_compare.html">Db::set_dup_compare</a>, -<a href="../api_cxx/db_set_errcall.html">Db::set_errcall</a>, -<a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a>, -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a>, -<a href="../api_cxx/db_set_flags.html">Db::set_flags</a>, -<a href="../api_cxx/db_set_h_ffactor.html">Db::set_h_ffactor</a>, -<a href="../api_cxx/db_set_h_hash.html">Db::set_h_hash</a>, -<a href="../api_cxx/db_set_h_nelem.html">Db::set_h_nelem</a>, -<a href="../api_cxx/db_set_lorder.html">Db::set_lorder</a>, -<a href="../api_cxx/db_set_malloc.html">Db::set_malloc</a>, -<a href="../api_cxx/db_set_pagesize.html">Db::set_pagesize</a>, -<a href="../api_cxx/db_set_paniccall.html">Db::set_paniccall</a>, -<a href="../api_cxx/db_set_q_extentsize.html">Db::set_q_extentsize</a>, -<a href="../api_cxx/db_set_realloc.html">Db::set_realloc</a>, -<a href="../api_cxx/db_set_re_delim.html">Db::set_re_delim</a>, -<a href="../api_cxx/db_set_re_len.html">Db::set_re_len</a>, -<a href="../api_cxx/db_set_re_pad.html">Db::set_re_pad</a>, -<a href="../api_cxx/db_set_re_source.html">Db::set_re_source</a>, -<a href="../api_cxx/db_stat.html">Db::stat</a>, -<a href="../api_cxx/db_sync.html">Db::sync</a>, -<a href="../api_cxx/db_upgrade.html">Db::upgrade</a> -and -<a href="../api_cxx/db_verify.html">Db::verify</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_class.html b/bdb/docs/api_cxx/dbc_class.html deleted file mode 100644 index ac8081d4ab3..00000000000 --- a/bdb/docs/api_cxx/dbc_class.html +++ /dev/null @@ -1,49 +0,0 @@ -<!--$Id: dbc_class.so,v 10.12 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: Dbc</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>Dbc</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class Dbc { ... }; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the specific details of the Dbc class, -which provides cursor support for the access methods in Db. -<p>The Dbc functions are the library interface supporting sequential -access to the records stored by the access methods of the Berkeley DB library. -Cursors are created by calling the <a href="../api_cxx/db_cursor.html">Db::cursor</a> method which returns a -pointer to a Dbc object. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_close.html b/bdb/docs/api_cxx/dbc_close.html deleted file mode 100644 index 881bc3f7de8..00000000000 --- a/bdb/docs/api_cxx/dbc_close.html +++ /dev/null @@ -1,68 +0,0 @@ -<!--$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: Dbc::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>Dbc::close</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Dbc::close(void); -</pre></h3> -<h1>Description</h1> -<p>The Dbc::close method discards the cursor. -<p>It is possible for the Dbc::close method 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 Dbc::close has been called, regardless of its return, the -cursor handle may not be used again. -<p>The Dbc::close method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Dbc::close method may fail and throw an exception or 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 Dbc::close method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Dbc::close method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_count.html b/bdb/docs/api_cxx/dbc_count.html deleted file mode 100644 index be8f6b8e601..00000000000 --- a/bdb/docs/api_cxx/dbc_count.html +++ /dev/null @@ -1,59 +0,0 @@ -<!--$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: Dbc::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>Dbc::count</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Dbc::count(db_recno_t *countp, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Dbc::count method 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 Dbc::count method either returns EINVAL or throws an exception that encapsulates EINVAL. -<p>Otherwise, the Dbc::count method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Dbc::count method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Dbc::count method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_del.html b/bdb/docs/api_cxx/dbc_del.html deleted file mode 100644 index 18f6959a8b3..00000000000 --- a/bdb/docs/api_cxx/dbc_del.html +++ /dev/null @@ -1,72 +0,0 @@ -<!--$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: Dbc::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>Dbc::del</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Dbc::del(u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Dbc::del method 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, Dbc::del will return -<a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. -<p>If the cursor is not yet initialized, the Dbc::del method either returns EINVAL or throws an exception that encapsulates EINVAL. -<p>Otherwise, the Dbc::del method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Dbc::del method may fail and throw an exception or 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_cxx/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was -specified to <a href="../api_cxx/env_open.html">DbEnv::open</a>. -</dl> -<p>The Dbc::del method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Dbc::del method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_dup.html b/bdb/docs/api_cxx/dbc_dup.html deleted file mode 100644 index 5dec52e46a6..00000000000 --- a/bdb/docs/api_cxx/dbc_dup.html +++ /dev/null @@ -1,76 +0,0 @@ -<!--$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: Dbc::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>Dbc::dup</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Dbc::dup(Dbc **cursorp, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Dbc::dup method 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_cxx/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_cxx/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 Dbc::dup method either returns EINVAL or throws an exception that encapsulates EINVAL. -<p>Otherwise, the Dbc::dup method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The Dbc::dup method may fail and throw an exception or 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_cxx/db_cursor.html#DB_WRITECURSOR">DB_WRITECURSOR</a> flag in the Berkeley DB Concurrent Data Store product. -</dl> -<p>The Dbc::dup method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Dbc::dup method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_get.html b/bdb/docs/api_cxx/dbc_get.html deleted file mode 100644 index d42a194e514..00000000000 --- a/bdb/docs/api_cxx/dbc_get.html +++ /dev/null @@ -1,170 +0,0 @@ -<!--$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: Dbc::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>Dbc::get</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Dbc::get(Dbt *key, Dbt *data, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Dbc::get method 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, Dbc::get will return -<a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. -<p>If the cursor is not yet initialized, the Dbc::get method either returns EINVAL or throws an exception that encapsulates 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, Dbc::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, Dbc::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_cxx/dbt_class.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_cxx/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_cxx/db_join.html">Db::join</a> method. -<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, Dbc::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, -Dbc::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, Dbc::get will -return <a href="../ref/program/errorret.html#DB_NOTFOUND">DB_NOTFOUND</a>. -<p>If the cursor is not yet initialized, the Dbc::get method either returns EINVAL or throws an exception that encapsulates 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, Dbc::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, Dbc::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, Dbc::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, -Dbc::get will return <a href="../ref/program/errorret.html#DB_KEYEMPTY">DB_KEYEMPTY</a>. -<p>If no matching keys are found, Dbc::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 method), 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_cxx/dbt_class.html#db_recno_t">db_recno_t</a> -may be read, as described in <a href="../api_cxx/dbt_class.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_cxx/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 Dbc::get method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<p>If Dbc::get fails for any reason, the state of the cursor will be -unchanged. -<h1>Errors</h1> -<p>The Dbc::get method may fail and throw an exception or 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 Dbc::get method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Dbc::get method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbc_put.html b/bdb/docs/api_cxx/dbc_put.html deleted file mode 100644 index 05a95cd36bc..00000000000 --- a/bdb/docs/api_cxx/dbc_put.html +++ /dev/null @@ -1,158 +0,0 @@ -<!--$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: Dbc::put</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>Dbc::put</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -Dbc::put(Dbt *key, Dbt *data, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The Dbc::put method 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_cxx/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag. If the <a href="../api_cxx/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_cxx/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, Dbc::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 Dbc::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_cxx/db_set_flags.html#DB_RENUMBER">DB_RENUMBER</a> flag. If the <a href="../api_cxx/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_cxx/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, Dbc::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, Dbc::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, Dbc::put will return EINVAL. -<p>If the current cursor record has already been deleted and the underlying -access method is Hash, Dbc::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, Dbc::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_cxx/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 Dbc::put method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<p>If Dbc::put fails for any reason, the state of the cursor will be -unchanged. If Dbc::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 Dbc::put method may fail and throw an exception or 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_cxx/env_open.html#DB_INIT_CDB">DB_INIT_CDB</a> flag was -specified to <a href="../api_cxx/env_open.html">DbEnv::open</a>. -</dl> -<p>The Dbc::put method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the Dbc::put method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbc_class.html">Dbc</a> -<h1>See Also</h1> -<a href="../api_cxx/dbc_close.html">Dbc::close</a>, -<a href="../api_cxx/dbc_count.html">Dbc::count</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>, -<a href="../api_cxx/dbc_dup.html">Dbc::dup</a>, -<a href="../api_cxx/dbc_get.html">Dbc::get</a> -and -<a href="../api_cxx/dbc_put.html">Dbc::put</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbenv_class.html b/bdb/docs/api_cxx/dbenv_class.html deleted file mode 100644 index 1c59dcbf1a1..00000000000 --- a/bdb/docs/api_cxx/dbenv_class.html +++ /dev/null @@ -1,76 +0,0 @@ -<!--$Id: dbenv_class.so,v 10.20 2000/07/27 13:10:54 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbEnv</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>DbEnv</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class DbEnv { -public: - DbEnv(u_int32 flags); - ~DbEnv(); - ... -}; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the specific details of the DbEnv -class, which is the center of the Berkeley DB environment. -<p>The following <b>flags</b> value may be specified: -<p><dl compact> -<p><dt><a name="DB_CLIENT">DB_CLIENT</a><dd>Create a client environment to connect to a server. -<p>The DB_CLIENT flag indicates to the system that this environment -is remote on a server. The use of this flag causes the environment -methods to use functions that call a server instead of local functions. -Prior to making any environment or database method calls, the -application must call the <a href="../api_cxx/env_set_server.html">DbEnv::set_server</a> function to establish -the connection to the server. -<p><dt><a name="DB_CXX_NO_EXCEPTIONS">DB_CXX_NO_EXCEPTIONS</a><dd>The Berkeley DB C++ API supports two different error behaviors. By default, -whenever an error occurs an exception is thrown that encapsulates the -error information. This generally allows for cleaner logic for -transaction processing, as a try block can surround a single -transaction. However, if DB_CXX_NO_EXCEPTIONS is specified, -exceptions are not thrown, instead each individual function returns an -error code. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/dbt_class.html b/bdb/docs/api_cxx/dbt_class.html deleted file mode 100644 index 24d18c60e50..00000000000 --- a/bdb/docs/api_cxx/dbt_class.html +++ /dev/null @@ -1,230 +0,0 @@ -<!--$Id: dbt_class.so,v 10.33 2000/12/18 21:05:13 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> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>Dbt</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class Dbt { -public: - void *get_data() const; - void set_data(void *); -<p> - u_int32_t get_size() const; - void set_size(u_int32_t); -<p> - u_int32_t get_ulen() const; - void set_ulen(u_int32_t); -<p> - u_int32_t get_dlen() const; - void set_dlen(u_int32_t); -<p> - u_int32_t get_doff() const; - void set_doff(u_int32_t); -<p> - u_int32_t get_flags() const; - void set_flags(u_int32_t); -<p> - Dbt(void *data, size_t size); - Dbt(); - Dbt(const Dbt &); - Dbt &operator = (const Dbt &); - ~Dbt(); -}; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the specific details of the Dbt class, -used to encode keys and data items in a database. - <a name="3"><!--meow--></a> -<h3>Key/Data Pairs</h3> -<p>Storage and retrieval for the Db access methods are based on -key/data pairs. Both key and data items are represented by Dbt -objects. 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>The Dbt class provides simple access to an underlying data structure, -whose elements can be examined or changed using the <b>set_</b> or -<b>get_</b> methods. The remainder of the manual page sometimes refers -to these accesses using the underlying name, e.g., simply <b>ulen</b> -instead of Dbt::get_ulen and Dbt::set_ulen. -Dbt can be subclassed, providing a way to associate -with it additional data, or references to other structures. -<p>The constructors set all elements of the underlying structure to zero. -The constructor with two arguments has the effect of setting all elements -to zero except for the specified <b>data</b> and <b>size</b> elements. -<p>In the case where the <b>flags</b> structure element is 0, when the -application is providing Berkeley DB a key or data item to store into the -database, Berkeley DB expects the <b>data</b> object 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> object 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 structure underlying the Dbt class are defined as follows: -<p><dl compact> -<p><dt>void *<a name="data">data</a>;<dd>A pointer to a byte string. -This element is accessed using Dbt::get_data and -Dbt::set_data, and may be initialized using one -of the constructors. -<p><dt>int offset;<dd>The number of bytes offset into the <b>data</b> array to determine the -portion of the array actually used. -This element is accessed using Dbt::get_offset and -Dbt::set_offset. -<p><dt>u_int32_t size;<dd>The length of <b>data</b>, in bytes. -This element is accessed using Dbt::get_size and -Dbt::set_size, and may be initialized -using the constructor with two arguments. -<p><dt>u_int32_t ulen;<dd>The size of the user's buffer (referenced by <b>data</b>), in bytes. -This location is not written by the Db methods. -<p>Note that applications can determine the length of a record by setting -the <b>ulen</b> to 0 and checking the return value found in <b>size</b>. -See the DB_DBT_USERMEM flag for more information. -<p>This element is accessed using -Dbt::get_ulen and Dbt::set_ulen. -<p><dt>u_int32_t dlen;<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. -This element is accessed using -Dbt::get_dlen, and Dbt::set_dlen. -<p><dt>u_int32_t doff;<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. -This element is accessed using -Dbt::get_doff and Dbt::set_doff. -<p><dt>u_int32_t flags;<dd>This element is accessed using Dbt::get_flags and -Dbt::set_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. -<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 method) and -return a pointer to it in the <b>data</b> field of the key or data -Dbt object. 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 method) and return -a pointer to it in the <b>data</b> field of the key or data Dbt -object. 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_USERMEM">DB_DBT_USERMEM</a><dd>The <b>data</b> field of the key or data object 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. -</dl> -<p>If DB_DBT_MALLOC or DB_DBT_REALLOC is specified, Berkeley DB -allocates a properly sized byte array to contain the data. This can be -convenient if you know little about the nature of the data, specifically -the size of data in the database. However, if your application makes -repeated calls to retrieve keys or data, you may notice increased garbage -collection due to this allocation. If you know the maximum size of data -you are retrieving, you might decrease the memory burden and speed your -application by allocating your own byte array and using -DB_DBT_USERMEM. Even if you don't know the maximum size, you can -use this option and reallocate your array whenever your retrieval API call -returns an ENOMEM error, or throws an exception encapsulating an ENOMEM. -<p><dl compact> -<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> -objects. -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_cxx/db_put.html">Db::put</a> -method in a database that supports duplicate records. -Partial puts in databases supporting duplicate records must be done -using a <a href="../api_cxx/dbc_class.html">Dbc</a> method. -<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="4"><!--meow--></a> <a name="5"><!--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_cxx/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_cxx/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 for 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_cxx/dbc_get.html">Dbc::get</a>), the memory referenced by the pointer into the -Dbt is only valid until the next call to Berkeley DB using the -<a href="../api_cxx/dbc_class.html">Dbc</a> handle returned by <a href="../api_cxx/db_cursor.html">Db::cursor</a>. - <a name="6"><!--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="7"><!--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_cxx/db_get.html">Db::get</a> and <a href="../api_cxx/dbc_get.html">Dbc::get</a> functions with the -<a href="../api_cxx/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_cxx.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> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_close.html b/bdb/docs/api_cxx/env_close.html deleted file mode 100644 index fc1ae2573a4..00000000000 --- a/bdb/docs/api_cxx/env_close.html +++ /dev/null @@ -1,87 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -DbEnv::close(u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::close method 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_cxx/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_cxx/lock_vec.html">DbEnv::lock_vec</a> call. -<p>Where the environment was initialized with the <a href="../api_cxx/env_open.html#DB_INIT_MPOOL">DB_INIT_MPOOL</a> -flag, calling DbEnv::close implies calls to <a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a> for -any remaining open files in the memory pool that were returned to this -process by calls to <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>. It does not imply a call to -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a> for those files. -<p>Where the environment was initialized with the <a href="../api_cxx/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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::close method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::close method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_open.html b/bdb/docs/api_cxx/env_open.html deleted file mode 100644 index 53c9908dcb8..00000000000 --- a/bdb/docs/api_cxx/env_open.html +++ /dev/null @@ -1,209 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::open(const char *db_home, u_int32_t flags, int mode); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::open method 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_cxx/dbc_put.html">Dbc::put</a>, -<a href="../api_cxx/dbc_del.html">Dbc::del</a>) will be made must have the <a href="../api_cxx/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_cxx/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_cxx/lock_detect.html">DbEnv::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 method, 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 <a href="../api_cxx/dbenv_class.html">DbEnv</a> 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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 method may fail and throw an exception or 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::open method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_remove.html b/bdb/docs/api_cxx/env_remove.html deleted file mode 100644 index 58c3ff5de0c..00000000000 --- a/bdb/docs/api_cxx/env_remove.html +++ /dev/null @@ -1,129 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::remove(const char *db_home, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::remove method 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_cxx/env_open.html">DbEnv::open</a> without -calling <a href="../api_cxx/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_cxx/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_cxx/env_open.html#DB_SYSTEM_MEM">DB_SYSTEM_MEM</a> flag was specified to -<a href="../api_cxx/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_cxx/env_open.html#DB_RECOVER">DB_RECOVER</a> and -<a href="../api_cxx/env_open.html#DB_RECOVER_FATAL">DB_RECOVER_FATAL</a> flags to <a href="../api_cxx/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_cxx/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_cxx/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_cxx/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 <a href="../api_cxx/dbenv_class.html">DbEnv</a> handle which has already been used to open an -environment should not be used to call the DbEnv::remove method, a new -<a href="../api_cxx/dbenv_class.html">DbEnv</a> 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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 method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::remove method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_cachesize.html b/bdb/docs/api_cxx/env_set_cachesize.html deleted file mode 100644 index 57ad573cb3f..00000000000 --- a/bdb/docs/api_cxx/env_set_cachesize.html +++ /dev/null @@ -1,89 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_cachesize(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_cachesize method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -<p>The specified cache size was impossibly small. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_data_dir.html b/bdb/docs/api_cxx/env_set_data_dir.html deleted file mode 100644 index 7c8bd44ff3d..00000000000 --- a/bdb/docs/api_cxx/env_set_data_dir.html +++ /dev/null @@ -1,80 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_data_dir(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_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_data_dir method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_errcall.html b/bdb/docs/api_cxx/env_set_errcall.html deleted file mode 100644 index 8c59632c684..00000000000 --- a/bdb/docs/api_cxx/env_set_errcall.html +++ /dev/null @@ -1,76 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -void DbEnv::set_errcall( - void (*db_errcall_fcn)(const char *errpfx, char *msg)); -</pre></h3> -<h1>Description</h1> -When an error occurs in the Berkeley DB library, an exception is thrown or an -error return value is returned by the method. In some cases, -however, the <b>errno</b> value may be insufficient to completely -describe the cause of the error, especially during initial application -debugging. -<p>The DbEnv::set_errcall method 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 defined with two arguments; the first will be the prefix -string (as previously set by <a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a> or -<a href="../api_cxx/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> method to display the error -message in an appropriate manner. -<p>Alternatively, you can use the <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method to display -the additional information via an output stream, or the <a href="../api_cxx/db_set_errfile.html">Db::set_errfile</a> -or <a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> methods to display the additional information via a C -library FILE *. You should not mix these approaches. -<p>This error logging enhancement does not slow performance or significantly -increase application size, and may be run during normal operation as well -as during application debugging. -<p>The DbEnv::set_errcall interface may be used to configure Berkeley DB at any time -during the life of the application. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_errfile.html b/bdb/docs/api_cxx/env_set_errfile.html deleted file mode 100644 index e9658cd18ec..00000000000 --- a/bdb/docs/api_cxx/env_set_errfile.html +++ /dev/null @@ -1,77 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -void DbEnv::set_errfile(FILE *errfile); -</pre></h3> -<h1>Description</h1> -When an error occurs in the Berkeley DB library, an exception is thrown or an -error return value is returned by the method. In some cases, -however, the <b>errno</b> value may be insufficient to completely -describe the cause of the error, especially during initial application -debugging. -<p>The DbEnv::set_errfile method 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>Alternatively, you can use the <a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a> method to display -the additional information via an output stream, or the -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method to capture the additional error information in -a way that does not use either output streams or C library FILE *'s. You -should not mix these approaches. -<p>The error message will consist of the prefix string and a colon -("<b>:</b>") (if a prefix string was previously specified using -<a href="../api_cxx/db_set_errpfx.html">Db::set_errpfx</a> or <a href="../api_cxx/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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_error_stream.html b/bdb/docs/api_cxx/env_set_error_stream.html deleted file mode 100644 index 18dc192cc77..00000000000 --- a/bdb/docs/api_cxx/env_set_error_stream.html +++ /dev/null @@ -1,74 +0,0 @@ -<!--$Id: env_set_error_stream.so,v 10.13 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbEnv::set_error_stream</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>DbEnv::set_error_stream</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -void DbEnv::set_error_stream(class ostream*); -</pre></h3> -<h1>Description</h1> -<p>When an error occurs in the Berkeley DB library, an exception is thrown or an -<b>errno</b> value is returned by the method. In some cases, -however, the <b>errno</b> value may be insufficient to completely -describe the cause of the error, especially during initial application -debugging. -<p>The DbEnv::set_error_stream method is used to enhance the mechanism for -reporting error messages to the application by setting the C++ ostream -used for displaying additional Berkeley DB error messages. In some cases, -when an error occurs, Berkeley DB will output an additional error message to -the specified stream. -<p>The error message will consist of the prefix string and a colon -("<b>:</b>") (if a prefix string was previously specified using -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>), an error string, and a trailing -<newline> character. -<p>Alternatively, you can use the <a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a> method to display -the additional information via a C library FILE *, or the -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a> method to capture the additional error information in -a way that does not use either output streams or C library FILE *'s. You -should not mix these approaches. -<p>This error logging enhancement does not slow performance or significantly -increase application size, and may be run during normal operation as well -as during application debugging. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_errpfx.html b/bdb/docs/api_cxx/env_set_errpfx.html deleted file mode 100644 index 62167d96ed4..00000000000 --- a/bdb/docs/api_cxx/env_set_errpfx.html +++ /dev/null @@ -1,60 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -void DbEnv::set_errpfx(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 method 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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_feedback.html b/bdb/docs/api_cxx/env_set_feedback.html deleted file mode 100644 index 147a5dc5930..00000000000 --- a/bdb/docs/api_cxx/env_set_feedback.html +++ /dev/null @@ -1,72 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_feedback( - void (*db_feedback_fcn)(DbEnv *, 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 method 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 method. This method 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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_flags.html b/bdb/docs/api_cxx/env_set_flags.html deleted file mode 100644 index ad8f4fc1ce2..00000000000 --- a/bdb/docs/api_cxx/env_set_flags.html +++ /dev/null @@ -1,87 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_flags(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_cxx/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_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a> method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lg_bsize.html b/bdb/docs/api_cxx/env_set_lg_bsize.html deleted file mode 100644 index fb9efecef3f..00000000000 --- a/bdb/docs/api_cxx/env_set_lg_bsize.html +++ /dev/null @@ -1,71 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lg_bsize(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lg_bsize method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lg_dir.html b/bdb/docs/api_cxx/env_set_lg_dir.html deleted file mode 100644 index 9a97eb3fe00..00000000000 --- a/bdb/docs/api_cxx/env_set_lg_dir.html +++ /dev/null @@ -1,76 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lg_dir(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lg_dir method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lg_max.html b/bdb/docs/api_cxx/env_set_lg_max.html deleted file mode 100644 index c0f27d19b20..00000000000 --- a/bdb/docs/api_cxx/env_set_lg_max.html +++ /dev/null @@ -1,71 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lg_max(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_cxx/lsn_class.html">DbLsn</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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lg_max method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -<p>The specified log file size was too large. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lk_conflicts.html b/bdb/docs/api_cxx/env_set_lk_conflicts.html deleted file mode 100644 index 9ef5e8c7802..00000000000 --- a/bdb/docs/api_cxx/env_set_lk_conflicts.html +++ /dev/null @@ -1,71 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lk_conflicts(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lk_conflicts method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/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> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lk_detect.html b/bdb/docs/api_cxx/env_set_lk_detect.html deleted file mode 100644 index ee17ce2a46c..00000000000 --- a/bdb/docs/api_cxx/env_set_lk_detect.html +++ /dev/null @@ -1,75 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lk_detect(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lk_detect method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lk_max.html b/bdb/docs/api_cxx/env_set_lk_max.html deleted file mode 100644 index 7e614d4ac6f..00000000000 --- a/bdb/docs/api_cxx/env_set_lk_max.html +++ /dev/null @@ -1,75 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lk_max(u_int32_t max); -</pre></h3> -<h1>Description</h1> -<p><b>The DbEnv::set_lk_max method interface has been deprecated in favor of -the <a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, <a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -and <a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a> methods. 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_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lk_max method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lk_max_lockers.html b/bdb/docs/api_cxx/env_set_lk_max_lockers.html deleted file mode 100644 index 9e84c0150fb..00000000000 --- a/bdb/docs/api_cxx/env_set_lk_max_lockers.html +++ /dev/null @@ -1,71 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lk_max_lockers(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_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lk_max_lockers method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lk_max_locks.html b/bdb/docs/api_cxx/env_set_lk_max_locks.html deleted file mode 100644 index 4e296e97939..00000000000 --- a/bdb/docs/api_cxx/env_set_lk_max_locks.html +++ /dev/null @@ -1,70 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lk_max_locks(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_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lk_max_locks method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_lk_max_objects.html b/bdb/docs/api_cxx/env_set_lk_max_objects.html deleted file mode 100644 index b196cb92593..00000000000 --- a/bdb/docs/api_cxx/env_set_lk_max_objects.html +++ /dev/null @@ -1,71 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_lk_max_objects(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_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_lk_max_objects method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_mp_mmapsize.html b/bdb/docs/api_cxx/env_set_mp_mmapsize.html deleted file mode 100644 index da7b3b5a698..00000000000 --- a/bdb/docs/api_cxx/env_set_mp_mmapsize.html +++ /dev/null @@ -1,74 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_mp_mmapsize(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_mp_mmapsize method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_mutexlocks.html b/bdb/docs/api_cxx/env_set_mutexlocks.html deleted file mode 100644 index b728927a2b4..00000000000 --- a/bdb/docs/api_cxx/env_set_mutexlocks.html +++ /dev/null @@ -1,62 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_mutexlocks(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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_pageyield.html b/bdb/docs/api_cxx/env_set_pageyield.html deleted file mode 100644 index 01247edc50b..00000000000 --- a/bdb/docs/api_cxx/env_set_pageyield.html +++ /dev/null @@ -1,71 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::set_pageyield</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static int -DbEnv::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 DbEnv::set_pageyield interface affects the entire application, not a single -database or database environment. -<p>While the DbEnv::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> methods. -<p>This functionality should never be used for any other purpose than stress -testing. -<p>The DbEnv::set_pageyield interface may be used to configure Berkeley DB at any time -during the life of the application. -<p>The DbEnv::set_pageyield method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_paniccall.html b/bdb/docs/api_cxx/env_set_paniccall.html deleted file mode 100644 index 61950ad0417..00000000000 --- a/bdb/docs/api_cxx/env_set_paniccall.html +++ /dev/null @@ -1,72 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_paniccall(void (*)(DbEnv *, int)); -</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, when the C++ error model has been configured so that the -individual Berkeley DB methods return error codes (see <a href="../api_cxx/except_class.html">DbException</a> for -more information), the value <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> is returned by Berkeley DB -methods. -<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 method is used to specify a method 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 method. -<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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_panicstate.html b/bdb/docs/api_cxx/env_set_panicstate.html deleted file mode 100644 index 6655003ccc4..00000000000 --- a/bdb/docs/api_cxx/env_set_panicstate.html +++ /dev/null @@ -1,67 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::set_panicstate</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static int -DbEnv::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 DbEnv::set_panicstate interface affects the entire application, not a single -database or database environment. -<p>While the DbEnv::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> methods. -<p>The DbEnv::set_panicstate method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p><dl compact> -<p><dt>EINVAL<dd>An invalid flag value or parameter was specified. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_rec_init.html b/bdb/docs/api_cxx/env_set_rec_init.html deleted file mode 100644 index 96af5948541..00000000000 --- a/bdb/docs/api_cxx/env_set_rec_init.html +++ /dev/null @@ -1,73 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_recovery_init(int (*db_recovery_init_fcn)(DbEnv *)); -</pre></h3> -<h1>Description</h1> -<p>Applications installing application-specific recovery methods need -to be called before Berkeley DB performs recovery so they may add their recovery -methods to Berkeley DB's. -<p>The DbEnv::set_recovery_init method supports this functionality. The -<b>db_recovery_init_fcn</b> method must be declared with one -argument, a reference to the enclosing Berkeley DB environment. This -method will be called after the <a href="../api_cxx/env_open.html">DbEnv::open</a> has been called, -but before recovery is started. -<p>If the <b>db_recovery_init_fcn</b> method returns a non-zero value, -no recovery will be performed and <a href="../api_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_recovery_init method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_region_init.html b/bdb/docs/api_cxx/env_set_region_init.html deleted file mode 100644 index f052adaf69e..00000000000 --- a/bdb/docs/api_cxx/env_set_region_init.html +++ /dev/null @@ -1,80 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::set_region_init</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static int -DbEnv::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 DbEnv::set_region_init interface affects the entire application, not a single -database or database environment. -<p>While the DbEnv::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> methods. -<p>The DbEnv::set_region_init method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_server.html b/bdb/docs/api_cxx/env_set_server.html deleted file mode 100644 index 208c9cc9c3a..00000000000 --- a/bdb/docs/api_cxx/env_set_server.html +++ /dev/null @@ -1,80 +0,0 @@ -<!--"@(#)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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_server(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 method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_shm_key.html b/bdb/docs/api_cxx/env_set_shm_key.html deleted file mode 100644 index 643bc1afdb3..00000000000 --- a/bdb/docs/api_cxx/env_set_shm_key.html +++ /dev/null @@ -1,90 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_shm_key(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_shm_key method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_tas_spins.html b/bdb/docs/api_cxx/env_set_tas_spins.html deleted file mode 100644 index fd21f03d341..00000000000 --- a/bdb/docs/api_cxx/env_set_tas_spins.html +++ /dev/null @@ -1,73 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::set_tas_spins</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static int -DbEnv::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 DbEnv::set_tas_spins interface affects the entire application, not a single -database or database environment. -<p>While the DbEnv::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> methods. -<p>The DbEnv::set_tas_spins method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_tmp_dir.html b/bdb/docs/api_cxx/env_set_tmp_dir.html deleted file mode 100644 index 5993fe8a84a..00000000000 --- a/bdb/docs/api_cxx/env_set_tmp_dir.html +++ /dev/null @@ -1,92 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_tmp_dir(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_cxx/env_open.html#DB_USE_ENVIRON">DB_USE_ENVIRON</a> or <a href="../api_cxx/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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_tmp_dir method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_tx_max.html b/bdb/docs/api_cxx/env_set_tx_max.html deleted file mode 100644 index 9189528948c..00000000000 --- a/bdb/docs/api_cxx/env_set_tx_max.html +++ /dev/null @@ -1,70 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_tx_max(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_cxx/txn_begin.html">DbEnv::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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_tx_max method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_tx_recover.html b/bdb/docs/api_cxx/env_set_tx_recover.html deleted file mode 100644 index 08ceec64d47..00000000000 --- a/bdb/docs/api_cxx/env_set_tx_recover.html +++ /dev/null @@ -1,77 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_tx_recover(int (*)(DbEnv *dbenv, - Dbt *log_rec, DbLsn *lsn, db_recops op)); -</pre></h3> -<h1>Description</h1> -<p>Set the application's method to be called during transaction abort -and recovery. This method 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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_tx_recover method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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_cxx/env_open.html">DbEnv::open</a> was called. -</dl> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_tx_timestamp.html b/bdb/docs/api_cxx/env_set_tx_timestamp.html deleted file mode 100644 index fa793324ca9..00000000000 --- a/bdb/docs/api_cxx/env_set_tx_timestamp.html +++ /dev/null @@ -1,66 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_tx_timestamp(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_cxx/env_open.html">DbEnv::open</a> interface is called. -<p>The DbEnv::set_tx_timestamp method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_set_verbose.html b/bdb/docs/api_cxx/env_set_verbose.html deleted file mode 100644 index 48b2809645e..00000000000 --- a/bdb/docs/api_cxx/env_set_verbose.html +++ /dev/null @@ -1,81 +0,0 @@ -<!--$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_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::set_verbose(u_int32_t which, int onoff); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::set_verbose method 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 method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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> -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_strerror.html b/bdb/docs/api_cxx/env_strerror.html deleted file mode 100644 index e1572018be3..00000000000 --- a/bdb/docs/api_cxx/env_strerror.html +++ /dev/null @@ -1,62 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::strerror</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static char * -DbEnv::strerror(int error); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::strerror method 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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/env_version.html b/bdb/docs/api_cxx/env_version.html deleted file mode 100644 index 8d40aa8c5df..00000000000 --- a/bdb/docs/api_cxx/env_version.html +++ /dev/null @@ -1,59 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::version</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static char * -DbEnv::version(int *major, int *minor, int *patch); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::version method 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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_close.html">DbEnv::close</a>, -<a href="../api_cxx/env_open.html">DbEnv::open</a>, -<a href="../api_cxx/env_remove.html">DbEnv::remove</a>, -<a href="../api_cxx/db_err.html">DbEnv::err</a>, -<a href="../api_cxx/env_strerror.html">DbEnv::strerror</a>, -<a href="../api_cxx/env_version.html">DbEnv::version</a>, -<a href="../api_cxx/env_set_cachesize.html">DbEnv::set_cachesize</a>, -<a href="../api_cxx/env_set_errcall.html">DbEnv::set_errcall</a>, -<a href="../api_cxx/env_set_errfile.html">DbEnv::set_errfile</a>, -<a href="../api_cxx/env_set_error_stream.html">DbEnv::set_error_stream</a>, -<a href="../api_cxx/env_set_errpfx.html">DbEnv::set_errpfx</a>, -<a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a>, -<a href="../api_cxx/env_set_mutexlocks.html">DbEnv::set_mutexlocks</a>, -<a href="../api_cxx/env_set_paniccall.html">DbEnv::set_paniccall</a>, -and -<a href="../api_cxx/env_set_verbose.html">DbEnv::set_verbose</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/except_class.html b/bdb/docs/api_cxx/except_class.html deleted file mode 100644 index 063bede9530..00000000000 --- a/bdb/docs/api_cxx/except_class.html +++ /dev/null @@ -1,64 +0,0 @@ -<!--$Id: except_class.so,v 10.15 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbException</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>DbException</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class DbException { - DbException(int err); - DbException(const char *description); - DbException(const char *prefix, int err); - DbException(const char *prefix1, const char *prefix2, int err); -}; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the DbException class and how it is used -by the various Berkeley DB classes. -<p>Most methods in the Berkeley DB classes return an int but also throw an -exception. This allows for two different error behaviors. By default, -the Berkeley DB C++ API is configured to throw an exception whenever a serious -error occurs. This generally allows for cleaner logic for transaction -processing, as a try block can surround a single transaction. -Alternatively, Berkeley DB can be configured to not throw exceptions, and -instead have the individual function return an error code, by setting -the constructor flags for the Db and <a href="../api_cxx/dbenv_class.html">DbEnv</a> objects. -<p>A DbException object contains an informational string and an errno. -The errno can be obtained by using <a href="../api_cxx/get_errno.html">DbException::get_errno</a>. -The informational string can be obtained by using <a href="../api_cxx/what.html">DbException::what</a>. -<p>We expect in the future that this class will inherit from the standard -class exception, but certain language implementation bugs currently -prevent this on some platforms. -<p>Some methods may return non-zero values without issuing an exception. -This occurs in situations that are not normally considered an error, but -when some informational status is returned. For example, <a href="../api_cxx/db_get.html">Db::get</a> -returns DB_NOTFOUND when a requested key does not appear in the database. -<h3>Class</h3> -<a href="../api_cxx/except_class.html">DbException</a> -<h1>See Also</h1> -<a href="../api_cxx/get_errno.html">DbException::get_errno</a> -and -<a href="../api_cxx/what.html">DbException::what</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/get_errno.html b/bdb/docs/api_cxx/get_errno.html deleted file mode 100644 index 25c639ac2d6..00000000000 --- a/bdb/docs/api_cxx/get_errno.html +++ /dev/null @@ -1,43 +0,0 @@ -<!--$Id: get_errno.so,v 10.8 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbException::get_errno</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>DbException::get_errno</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -const int -DbException::get_errno(); -</pre></h3> -<h1>Description</h1> -<p>A DbException object contains an informational string and an errno. -The errno can be obtained by using DbException::get_errno. -The informational string can be obtained by using <a href="../api_cxx/what.html">DbException::what</a>. -<h3>Class</h3> -<a href="../api_cxx/except_class.html">DbException</a> -<h1>See Also</h1> -<a href="../api_cxx/get_errno.html">DbException::get_errno</a> -and -<a href="../api_cxx/what.html">DbException::what</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_class.html b/bdb/docs/api_cxx/lock_class.html deleted file mode 100644 index c0aa324d9f0..00000000000 --- a/bdb/docs/api_cxx/lock_class.html +++ /dev/null @@ -1,61 +0,0 @@ -<!--$Id: lock_class.so,v 10.13 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbLock</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>DbLock</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class DbLock { -public: - DbLock(); - DbLock(const DbLock &); - DbLock &operator = (const DbLock &); - ~DbLock(); -}; -</pre></h3> -<h1>Description</h1> -<p>The <a href="../api_cxx/dbenv_class.html">DbEnv</a> lock methods and the DbLock class are used -to provide general-purpose locking. While designed to work with the -other Db classes, they are also useful for more general locking -purposes. Locks can be shared between processes. -<p>In most cases, when multiple threads or processes are using locking, the -deadlock detector, <a href="../utility/db_deadlock.html">db_deadlock</a> should be run. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_detect.html b/bdb/docs/api_cxx/lock_detect.html deleted file mode 100644 index 889d0f52048..00000000000 --- a/bdb/docs/api_cxx/lock_detect.html +++ /dev/null @@ -1,73 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::lock_detect</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::lock_detect(u_int32_t flags, u_int32_t atype, int *aborted); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::lock_detect method 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_cxx/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 -DbEnv::lock_detect method. -<p>The DbEnv::lock_detect method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::lock_detect method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::lock_detect method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_get.html b/bdb/docs/api_cxx/lock_get.html deleted file mode 100644 index 4dae9f5dc67..00000000000 --- a/bdb/docs/api_cxx/lock_get.html +++ /dev/null @@ -1,94 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::lock_get</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::lock_get(u_int32_t locker, u_int32_t flags, - const Dbt *obj, const db_lockmode_t lock_mode, DbLock *lock); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::lock_get method 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 DbEnv::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_cxx/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 DbEnv::lock_get method may -return or throw an exception encapsulating -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 DbEnv::lock_get method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::lock_get method may fail and throw an exception or 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 DbEnv::lock_get method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::lock_get method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_id.html b/bdb/docs/api_cxx/lock_id.html deleted file mode 100644 index 72ab2a274db..00000000000 --- a/bdb/docs/api_cxx/lock_id.html +++ /dev/null @@ -1,61 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::lock_id</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::lock_id(u_int32_t *idp); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::lock_id method -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 DbEnv::lock_id method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::lock_id method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::lock_id method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_put.html b/bdb/docs/api_cxx/lock_put.html deleted file mode 100644 index 2875e4cfed4..00000000000 --- a/bdb/docs/api_cxx/lock_put.html +++ /dev/null @@ -1,63 +0,0 @@ -<!--$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: DbLock::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>DbLock::put</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbLock::put(DbEnv *env); -</pre></h3> -<h1>Description</h1> -<p>The DbLock::put method releases <b>lock</b> from the lock table. -<p>The DbLock::put method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbLock::put method may fail and throw an exception or 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 DbLock::put method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbLock::put method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_stat.html b/bdb/docs/api_cxx/lock_stat.html deleted file mode 100644 index 87bdc9d75a4..00000000000 --- a/bdb/docs/api_cxx/lock_stat.html +++ /dev/null @@ -1,98 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::lock_stat</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -DbEnv::lock_stat(DB_LOCK_STAT **statp, db_malloc_fcn_type db_malloc); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::lock_stat method -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_cxx/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 DbEnv::lock_stat method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::lock_stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::lock_stat method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lock_vec.html b/bdb/docs/api_cxx/lock_vec.html deleted file mode 100644 index 46180f2cee8..00000000000 --- a/bdb/docs/api_cxx/lock_vec.html +++ /dev/null @@ -1,127 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::lock_vec</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::lock_vec(u_int32_t locker, u_int32_t flags, - DB_LOCKREQ list[], int nlist, DB_LOCKREQ **elistp); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::lock_vec method atomically obtains and releases one or more locks -from the lock table. The DbEnv::lock_vec method 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 DbEnv::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 DbEnv::lock_vec is typedef'd as -DB_LOCKREQ. A DB_LOCKREQ structure has at least the following fields, -which must be initialized before calling DbEnv::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 DbEnv::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 -DbEnv::lock_vec or <a href="../api_cxx/lock_put.html">DbLock::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 DbEnv::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 DbEnv::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_cxx/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 -DbEnv::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 DbEnv::lock_vec method may -return or throw an exception encapsulating -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 DbEnv::lock_vec method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::lock_vec method may fail and throw an exception or 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 DbEnv::lock_vec method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::lock_vec method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/lock_class.html">DbLock</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lk_conflicts.html">DbEnv::set_lk_conflicts</a>, -<a href="../api_cxx/env_set_lk_detect.html">DbEnv::set_lk_detect</a>, -<a href="../api_cxx/env_set_lk_max_locks.html">DbEnv::set_lk_max_locks</a>, -<a href="../api_cxx/env_set_lk_max_lockers.html">DbEnv::set_lk_max_lockers</a>, -<a href="../api_cxx/env_set_lk_max_objects.html">DbEnv::set_lk_max_objects</a>, -<a href="../api_cxx/env_set_lk_max.html">DbEnv::set_lk_max</a>, -<a href="../api_cxx/lock_detect.html">DbEnv::lock_detect</a>, -<a href="../api_cxx/lock_get.html">DbEnv::lock_get</a>, -<a href="../api_cxx/lock_id.html">DbEnv::lock_id</a>, -<a href="../api_cxx/lock_put.html">DbLock::put</a>, -<a href="../api_cxx/lock_stat.html">DbEnv::lock_stat</a> -and -<a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_archive.html b/bdb/docs/api_cxx/log_archive.html deleted file mode 100644 index e5436431a02..00000000000 --- a/bdb/docs/api_cxx/log_archive.html +++ /dev/null @@ -1,106 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_archive</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -DbEnv::log_archive(char *(*listp)[], - u_int32_t flags, db_malloc_fcn_type db_malloc); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_archive method -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, DbEnv::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, -DbEnv::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 DbEnv::log_archive method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 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 DbEnv::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 DbEnv::log_archive method may fail and throw an exception or 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 DbEnv::log_archive method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_archive method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_compare.html b/bdb/docs/api_cxx/log_compare.html deleted file mode 100644 index 7d1b7ebb9d6..00000000000 --- a/bdb/docs/api_cxx/log_compare.html +++ /dev/null @@ -1,53 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_compare</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static int -DbEnv::log_compare(const DbLsn *lsn0, const DbLsn *lsn1); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_compare method allows the caller to compare two -<a href="../api_cxx/lsn_class.html">DbLsn</a> objects, -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>. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_file.html b/bdb/docs/api_cxx/log_file.html deleted file mode 100644 index fa0ed4e5332..00000000000 --- a/bdb/docs/api_cxx/log_file.html +++ /dev/null @@ -1,79 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_file</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::log_file(const DbLsn *lsn, char *namep, size_t len); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_file method maps -<a href="../api_cxx/lsn_class.html">DbLsn</a> objects -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, DbEnv::log_file will -return ENOMEM. -(Log file names are normally quite short, on the order of 10 characters.) -<p>This mapping of -<a href="../api_cxx/lsn_class.html">DbLsn</a> objects -to files is needed for database administration. For example, a -transaction manager typically records the earliest -<a href="../api_cxx/lsn_class.html">DbLsn</a> -needed for restart, and the database administrator may want to archive -log files to tape when they contain only -<a href="../api_cxx/lsn_class.html">DbLsn</a> -entries before the earliest one needed for restart. -<p>The DbEnv::log_file method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::log_file method may fail and throw an exception or 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 DbEnv::log_file method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_file method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_flush.html b/bdb/docs/api_cxx/log_flush.html deleted file mode 100644 index ecb13b9c0c6..00000000000 --- a/bdb/docs/api_cxx/log_flush.html +++ /dev/null @@ -1,66 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_flush</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::log_flush(const DbLsn *lsn); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_flush method guarantees that all log records whose -<a href="../api_cxx/lsn_class.html">DbLsn</a> 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 DbEnv::log_flush method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::log_flush method may fail and throw an exception or 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 DbEnv::log_flush method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_flush method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_get.html b/bdb/docs/api_cxx/log_get.html deleted file mode 100644 index 37a8c497bbc..00000000000 --- a/bdb/docs/api_cxx/log_get.html +++ /dev/null @@ -1,118 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_get</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::log_get(DbLsn *lsn, Dbt *data, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_get method 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_cxx/dbt_class.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_cxx/dbt_class.html#DB_DBT_MALLOC">DB_DBT_MALLOC</a>, <a href="../api_cxx/dbt_class.html#DB_DBT_REALLOC">DB_DBT_REALLOC</a> or -<a href="../api_cxx/dbt_class.html#DB_DBT_USERMEM">DB_DBT_USERMEM</a> flags must be specified for any <a href="../api_cxx/dbt_class.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_cxx/log_put.html">DbEnv::log_put</a> method is returned in the <b>data</b> argument. The -<b>lsn</b> argument is overwritten with the <a href="../api_cxx/lsn_class.html">DbLsn</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 DbEnv::log_get method 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_cxx/lsn_class.html">DbLsn</a> of the -record returned. -<p>If the log is empty, the DbEnv::log_get method 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_cxx/lsn_class.html">DbLsn</a> of the -record returned. -<p>If the log is empty, the DbEnv::log_get method 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_cxx/lsn_class.html">DbLsn</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, DbEnv::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 -DbEnv::log_get method 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 -DbEnv::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_cxx/lsn_class.html">DbLsn</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, -DbEnv::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 -DbEnv::log_get method 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 -DbEnv::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, -DbEnv::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_cxx/lsn_class.html">DbLsn</a> is invalid (e.g., does not appear in the log) -DbEnv::log_get will return EINVAL. -</dl> -<p>Otherwise, the DbEnv::log_get method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::log_get method may fail and throw an exception or 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 DbEnv::log_get method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_get method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_put.html b/bdb/docs/api_cxx/log_put.html deleted file mode 100644 index ecd84e33c78..00000000000 --- a/bdb/docs/api_cxx/log_put.html +++ /dev/null @@ -1,84 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_put</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::log_put(DbLsn *lsn, const Dbt *data, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_put method appends records to the log. The <a href="../api_cxx/lsn_class.html">DbLsn</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_cxx/lsn_class.html">DbLsn</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_cxx/lsn_class.html">DbLsn</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_cxx/txn_commit.html">DbTxn::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_cxx/lsn_class.html">DbLsn</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 DbEnv::log_put method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The <a href="../api_cxx/log_flush.html">DbEnv::log_flush</a> method may fail and throw an exception or 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 DbEnv::log_put method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_put method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_register.html b/bdb/docs/api_cxx/log_register.html deleted file mode 100644 index b837a60b352..00000000000 --- a/bdb/docs/api_cxx/log_register.html +++ /dev/null @@ -1,68 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_register</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::log_register(Db *dbp, const char *name); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_register method 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 <a href="../api_cxx/db_class.html">Db</a> object being -registered. The <b>name</b> argument should be a file name appropriate -for opening the file in the environment, during recovery. -<p>The DbEnv::log_register method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::log_register method may fail and throw an exception or 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 DbEnv::log_register method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_register method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_stat.html b/bdb/docs/api_cxx/log_stat.html deleted file mode 100644 index 061685ab497..00000000000 --- a/bdb/docs/api_cxx/log_stat.html +++ /dev/null @@ -1,96 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_stat</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -DbEnv::log_stat(DB_LOG_STAT **spp, db_malloc_fcn_type db_malloc); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_stat method -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 DbEnv::log_stat method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::log_stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_stat method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/log_unregister.html b/bdb/docs/api_cxx/log_unregister.html deleted file mode 100644 index 364e62259b5..00000000000 --- a/bdb/docs/api_cxx/log_unregister.html +++ /dev/null @@ -1,63 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::log_unregister</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::log_unregister(int32_t DB *dbp); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::log_unregister method function unregisters the file represented by -the <b>dbp</b> parameter from the Berkeley DB environment's log manager. -<p>The DbEnv::log_unregister method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::log_unregister method may fail and throw an exception or 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 DbEnv::log_unregister method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::log_unregister method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Class</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_lg_bsize.html">DbEnv::set_lg_bsize</a>, -<a href="../api_cxx/env_set_lg_max.html">DbEnv::set_lg_max</a>, -<a href="../api_cxx/log_archive.html">DbEnv::log_archive</a>, -<a href="../api_cxx/log_compare.html">DbEnv::log_compare</a>, -<a href="../api_cxx/log_file.html">DbEnv::log_file</a>, -<a href="../api_cxx/log_flush.html">DbEnv::log_flush</a>, -<a href="../api_cxx/log_get.html">DbEnv::log_get</a>, -<a href="../api_cxx/log_put.html">DbEnv::log_put</a>, -<a href="../api_cxx/log_register.html">DbEnv::log_register</a>, -<a href="../api_cxx/log_stat.html">DbEnv::log_stat</a> -and -<a href="../api_cxx/log_unregister.html">DbEnv::log_unregister</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/lsn_class.html b/bdb/docs/api_cxx/lsn_class.html deleted file mode 100644 index db4d5656794..00000000000 --- a/bdb/docs/api_cxx/lsn_class.html +++ /dev/null @@ -1,38 +0,0 @@ -<!--$Id: lsn_class.so,v 10.11 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbLsn</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>DbLsn</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class DbLsn { ... }; -</pre></h3> -<h1>Description</h1> -<p>A DbLsn is a <b>log sequence number</b> that is fully -encapsulated. The class itself has no methods, other than a default -constructor, so there is no way for the user to manipulate its data -directly. -Methods always take a pointer to a DbLsn as an argument. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_fclose.html b/bdb/docs/api_cxx/memp_fclose.html deleted file mode 100644 index 0906388e3ee..00000000000 --- a/bdb/docs/api_cxx/memp_fclose.html +++ /dev/null @@ -1,65 +0,0 @@ -<!--$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: DbMpoolFile::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>DbMpoolFile::close</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbMpoolFile::close(); -</pre></h3> -<h1>Description</h1> -<p>The DbMpoolFile::close method closes the source file indicated by the -<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> object. Calling DbMpoolFile::close does not imply -a call to <a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, i.e. no pages are written to the source -file as as a result of calling DbMpoolFile::close. -<p>In addition, if the <b>file</b> argument to <a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a> was NULL, -any underlying files created for this <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> will be removed. -<p>Once DbMpoolFile::close has been called, regardless of its return, the -<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> handle may not be accessed again. -<p>The DbMpoolFile::close method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbMpoolFile::close method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbMpoolFile::close method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_fget.html b/bdb/docs/api_cxx/memp_fget.html deleted file mode 100644 index c8067603c77..00000000000 --- a/bdb/docs/api_cxx/memp_fget.html +++ /dev/null @@ -1,101 +0,0 @@ -<!--$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: DbMpoolFile::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>DbMpoolFile::get</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbMpoolFile::get(db_pgno_t *pgnoaddr, u_int32_t flags, void **pagep); -</pre></h3> -<h1>Description</h1> -<p>The DbMpoolFile::get method copies a pointer to the page with the page -number specified by <b>pgnoaddr</b>, from the source file in the -<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>, into the memory location referenced by <b>pagep</b>. -If the page does not exist or cannot be retrieved, DbMpoolFile::get 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> method, 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> method, 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 DbMpoolFile::get will be retained (i.e. -<i>pinned</i>), in the pool until a subsequent call to -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>. -<p>The DbMpoolFile::get method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbMpoolFile::get method may fail and throw an exception or 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 DbMpoolFile::get method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbMpoolFile::get method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_fopen.html b/bdb/docs/api_cxx/memp_fopen.html deleted file mode 100644 index c993ee6f11d..00000000000 --- a/bdb/docs/api_cxx/memp_fopen.html +++ /dev/null @@ -1,160 +0,0 @@ -<!--$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: DbMpoolFile::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>DbMpoolFile::open</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -static int -DbMpoolFile::open(DbEnv *env, const char *file, u_int32_t flags, int mode, - size_t pagesize, DB_MPOOL_FINFO *finfop, DbMpoolFile **mpf); -</pre></h3> -<h1>Description</h1> -<p>The DbMpoolFile::open method opens a file in the pool specified by the -<a href="../api_cxx/dbenv_class.html">DbEnv</a> <b>env</b>, copying the <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> 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_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a> method 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 DbMpoolFile::open -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 DbMpoolFile::open (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 -DbMpoolFile::open 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 DbMpoolFile::open 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_cxx/memp_register.html">DbEnv::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_cxx/memp_register.html">DbEnv::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_cxx/memp_register.html">DbEnv::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 DbMpoolFile::open 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_cxx/memp_sync.html">DbEnv::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_cxx/memp_fget.html">DbMpoolFile::get</a>. -If <b>finfop</b> is NULL or <b>clear_len</b> is 0, the entire page is -cleared. -</dl> -<p>The DbMpoolFile::open method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbMpoolFile::open method may fail and throw an exception or 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 DbMpoolFile::open method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbMpoolFile::open method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_fput.html b/bdb/docs/api_cxx/memp_fput.html deleted file mode 100644 index f49c809c093..00000000000 --- a/bdb/docs/api_cxx/memp_fput.html +++ /dev/null @@ -1,83 +0,0 @@ -<!--$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: DbMpoolFile::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>DbMpoolFile::put</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbMpoolFile::put(void *pgaddr, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbMpoolFile::put method 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_cxx/memp_fget.html">DbMpoolFile::get</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 DbMpoolFile::put method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbMpoolFile::put method may fail and throw an exception or 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_cxx/memp_fget.html">DbMpoolFile::get</a>. -<p>More than one of DB_MPOOL_CLEAN and DB_MPOOL_DIRTY flags was set. -</dl> -<p>The DbMpoolFile::put method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbMpoolFile::put method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_fset.html b/bdb/docs/api_cxx/memp_fset.html deleted file mode 100644 index 6e46d45c1f4..00000000000 --- a/bdb/docs/api_cxx/memp_fset.html +++ /dev/null @@ -1,76 +0,0 @@ -<!--$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: DbMpoolFile::set</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>DbMpoolFile::set</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbMpoolFile::set(void *pgaddr, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbMpoolFile::set method 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_cxx/memp_fget.html">DbMpoolFile::get</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 DbMpoolFile::set method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbMpoolFile::set method may fail and throw an exception or 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 DbMpoolFile::set method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbMpoolFile::set method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_fsync.html b/bdb/docs/api_cxx/memp_fsync.html deleted file mode 100644 index a38366f9e18..00000000000 --- a/bdb/docs/api_cxx/memp_fsync.html +++ /dev/null @@ -1,63 +0,0 @@ -<!--$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: DbMpoolFile::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>DbMpoolFile::sync</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbMpoolFile::sync(); -</pre></h3> -<h1>Description</h1> -<p>The DbMpoolFile::sync method writes all pages associated with the -<a href="../api_cxx/mempfile_class.html">DbMpoolFile</a>, that were marked as modified using <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a> -or <a href="../api_cxx/memp_fset.html">DbMpoolFile::set</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) DbMpoolFile::sync will ignore them. -<p>The DbMpoolFile::sync method either returns a non-zero error value or throws an exception that -encapsulates 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 DbMpoolFile::sync was unable to write immediately. -<h1>Errors</h1> -<p>The DbMpoolFile::sync method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbMpoolFile::sync method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_register.html b/bdb/docs/api_cxx/memp_register.html deleted file mode 100644 index 4c5f0748e98..00000000000 --- a/bdb/docs/api_cxx/memp_register.html +++ /dev/null @@ -1,102 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::memp_register</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef int (*pgin_fcn_type)(DB_ENV *dbenv, - db_pgno_t pgno, void *pgaddr, DBT *pgcookie); - typedef int (*pgout_fcn_type)(DB_ENV *dbenv, - db_pgno_t pgno, void *pgaddr, DBT *pgcookie); -}; -int -DbEnv::memp_register(int ftype, - pgin_fcn_type pgin_fcn, pgout_fcn_type pgout_fcn); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::memp_register method 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_cxx/memp_fget.html">DbMpoolFile::get</a> method). -<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_cxx/memp_fopen.html">DbMpoolFile::open</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 DbEnv::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 DbEnv::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_cxx/db_open.html">Db::open</a> registers them -separately.) -<p>If a thread or process does not call DbEnv::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, -DbEnv::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 DbEnv::memp_register method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::memp_register method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::memp_register method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_stat.html b/bdb/docs/api_cxx/memp_stat.html deleted file mode 100644 index 1c7f16a2a98..00000000000 --- a/bdb/docs/api_cxx/memp_stat.html +++ /dev/null @@ -1,125 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::memp_stat</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -DbEnv::memp_stat(DB_MPOOL_STAT **gsp, - DB_MPOOL_FSTAT *(*fsp)[], db_malloc_fcn_type db_malloc); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::memp_stat method 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_cxx/memp_trickle.html">DbEnv::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 DbEnv::memp_stat method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::memp_stat method may fail and throw an exception or 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 DbEnv::memp_stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::memp_stat method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_sync.html b/bdb/docs/api_cxx/memp_sync.html deleted file mode 100644 index fe63f1dffc4..00000000000 --- a/bdb/docs/api_cxx/memp_sync.html +++ /dev/null @@ -1,87 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::memp_sync</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::memp_sync(DbLsn *lsn); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::memp_sync method 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 DbEnv::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 DbEnv::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 DbEnv::memp_sync function -returns that all pages have been written. -<p>To support the DbEnv::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_cxx/memp_fopen.html">DbMpoolFile::open</a> function. It is not required that -the log sequence number be aligned on the page in any way. -<p>The DbEnv::memp_sync method either returns a non-zero error value or throws an exception that -encapsulates 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 DbEnv::memp_sync was unable to write immediately. -In addition, if DbEnv::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 DbEnv::memp_sync to satisfy this -request. -<h1>Errors</h1> -<p>The DbEnv::memp_sync method may fail and throw an exception or 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 DbEnv::memp_sync function was called without logging having been -initialized in the environment. -</dl> -<p>The DbEnv::memp_sync method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::memp_sync method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/memp_trickle.html b/bdb/docs/api_cxx/memp_trickle.html deleted file mode 100644 index 185bc5481a4..00000000000 --- a/bdb/docs/api_cxx/memp_trickle.html +++ /dev/null @@ -1,70 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::memp_trickle</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::memp_trickle(int pct, int *nwrotep); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::memp_trickle method 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 DbEnv::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 DbEnv::memp_trickle method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::memp_trickle method may fail and throw an exception or 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 DbEnv::memp_trickle method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::memp_trickle method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/mempfile_class.html b/bdb/docs/api_cxx/mempfile_class.html deleted file mode 100644 index ce10974d14d..00000000000 --- a/bdb/docs/api_cxx/mempfile_class.html +++ /dev/null @@ -1,62 +0,0 @@ -<!--$Id: mempfile_class.so,v 10.10 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbMpoolFile</title> -<meta name="description" content="Berkeley DB: An embedded database programmatic toolkit."> -<meta name="keywords" content="embedded,database,programmatic,toolkit,b+tree,btree,hash,hashing,transaction,transactions,locking,logging,access method,access methods,java,C,C++"> -</head> -<body bgcolor=white> - <a name="2"><!--meow--></a> -<table><tr valign=top> -<td> -<h1>DbMpoolFile</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class DbMpoolFile { ... }; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the specific details of the DbMpoolFile -class. -<p>The <a href="../api_cxx/dbenv_class.html">DbEnv</a> memory pool methods and the DbMpoolFile class -are the library interface that provide general-purpose, page-oriented -buffer management of one or more files. While designed to work with the -other Db classes, they are also useful for more general purposes. -The memory pools are referred to in this document as simply <i>pools</i>. -<p>Pools may be shared between processes. Pools are usually filled by pages -from one or more files. Pages in the pool are replaced in LRU -(least-recently-used) order, with each new page replacing the page that -has been unused the longest. Pages retrieved from the pool using -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a> are <i>pinned</i> in the pool until they are -returned to the control of the buffer pool using the <a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a> -method. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/mempfile_class.html">DbMpoolFile</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_mp_mmapsize.html">DbEnv::set_mp_mmapsize</a>, -<a href="../api_cxx/memp_fclose.html">DbMpoolFile::close</a>, -<a href="../api_cxx/memp_fget.html">DbMpoolFile::get</a>, -<a href="../api_cxx/memp_fopen.html">DbMpoolFile::open</a>, -<a href="../api_cxx/memp_fput.html">DbMpoolFile::put</a>, -<a href="../api_cxx/memp_fset.html">DbMpoolFile::set</a>, -<a href="../api_cxx/memp_fsync.html">DbMpoolFile::sync</a>, -<a href="../api_cxx/memp_register.html">DbEnv::memp_register</a>, -<a href="../api_cxx/memp_stat.html">DbEnv::memp_stat</a>, -<a href="../api_cxx/memp_sync.html">DbEnv::memp_sync</a> -and -<a href="../api_cxx/memp_trickle.html">DbEnv::memp_trickle</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/pindex.src b/bdb/docs/api_cxx/pindex.src deleted file mode 100644 index cf4a58836d0..00000000000 --- a/bdb/docs/api_cxx/pindex.src +++ /dev/null @@ -1,287 +0,0 @@ -__APIREL__/api_cxx/db_class.html#2 @Db -__APIREL__/api_cxx/db_class.html#DB_CXX_NO_EXCEPTIONS Db@DB_CXX_NO_EXCEPTIONS -__APIREL__/api_cxx/db_class.html#DB_XA_CREATE Db@DB_XA_CREATE -__APIREL__/api_cxx/db_err.html#2 @DbEnv::err -__APIREL__/api_cxx/db_set_errfile.html#2 @Db::set_errfile -__APIREL__/api_cxx/db_set_malloc.html#2 @Db::set_malloc -__APIREL__/api_cxx/db_set_paniccall.html#2 @Db::set_paniccall -__APIREL__/api_cxx/db_set_realloc.html#2 @Db::set_realloc -__APIREL__/api_cxx/dbc_class.html#2 @Dbc -__APIREL__/api_cxx/dbenv_class.html#2 @DbEnv -__APIREL__/api_cxx/dbenv_class.html#DB_CLIENT DbEnv@DB_CLIENT -__APIREL__/api_cxx/dbenv_class.html#DB_CXX_NO_EXCEPTIONS DbEnv@DB_CXX_NO_EXCEPTIONS -__APIREL__/api_cxx/dbt_class.html#2 @Dbt -__APIREL__/api_cxx/dbt_class.html#3 @key/data pairs -__APIREL__/api_cxx/dbt_class.html#data Dbt@data -__APIREL__/api_cxx/dbt_class.html#DB_DBT_MALLOC Dbt@DB_DBT_MALLOC -__APIREL__/api_cxx/dbt_class.html#DB_DBT_REALLOC Dbt@DB_DBT_REALLOC -__APIREL__/api_cxx/dbt_class.html#DB_DBT_USERMEM Dbt@DB_DBT_USERMEM -__APIREL__/api_cxx/dbt_class.html#DB_DBT_PARTIAL Dbt@DB_DBT_PARTIAL -__APIREL__/api_cxx/dbt_class.html#4 retrieved key/data @permanence -__APIREL__/api_cxx/dbt_class.html#5 retrieved @key/data permanence -__APIREL__/api_cxx/dbt_class.html#6 data @alignment -__APIREL__/api_cxx/dbt_class.html#7 logical @record number format -__APIREL__/api_cxx/env_set_errfile.html#2 @DbEnv::set_errfile -__APIREL__/api_cxx/env_set_error_stream.html#2 @DbEnv::set_error_stream -__APIREL__/api_cxx/env_set_paniccall.html#2 @DbEnv::set_paniccall -__APIREL__/api_cxx/except_class.html#2 @DbException -__APIREL__/api_cxx/get_errno.html#2 @DbException::get_errno -__APIREL__/api_cxx/lock_class.html#2 @DbLock -__APIREL__/api_cxx/lsn_class.html#2 @DbLsn -__APIREL__/api_cxx/mempfile_class.html#2 @DbMpoolFile -__APIREL__/api_cxx/txn_class.html#2 @DbTxn -__APIREL__/api_cxx/what.html#2 @DbException::what -__APIREL__/api_cxx/db_close.html#2 @Db::close -__APIREL__/api_cxx/db_close.html#DB_NOSYNC Db::close@DB_NOSYNC -__APIREL__/api_cxx/db_close.html#3 Db::close @DB_INCOMPLETE -__APIREL__/api_cxx/db_cursor.html#2 @Db::cursor -__APIREL__/api_cxx/db_cursor.html#DB_WRITECURSOR Db::cursor@DB_WRITECURSOR -__APIREL__/api_cxx/db_del.html#2 @Db::del -__APIREL__/api_cxx/db_fd.html#2 @Db::fd -__APIREL__/api_cxx/db_get.html#2 @Db::get -__APIREL__/api_cxx/db_get.html#DB_CONSUME Db::get@DB_CONSUME -__APIREL__/api_cxx/db_get.html#DB_CONSUME_WAIT Db::get@DB_CONSUME_WAIT -__APIREL__/api_cxx/db_get.html#DB_GET_BOTH Db::get@DB_GET_BOTH -__APIREL__/api_cxx/db_get.html#DB_SET_RECNO Db::get@DB_SET_RECNO -__APIREL__/api_cxx/db_get.html#DB_RMW Db::get@DB_RMW -__APIREL__/api_cxx/db_get_byteswapped.html#2 @Db::get_byteswapped -__APIREL__/api_cxx/db_get_type.html#2 @Db::get_type -__APIREL__/api_cxx/db_join.html#2 @Db::join -__APIREL__/api_cxx/db_join.html#DB_JOIN_NOSORT Db::join@DB_JOIN_NOSORT -__APIREL__/api_cxx/db_join.html#DB_JOIN_ITEM Db::join@DB_JOIN_ITEM -__APIREL__/api_cxx/db_join.html#DB_RMW Db::join@DB_RMW -__APIREL__/api_cxx/db_key_range.html#2 @Db::key_range -__APIREL__/api_cxx/db_open.html#2 @Db::open -__APIREL__/api_cxx/db_open.html#DB_CREATE Db::open@DB_CREATE -__APIREL__/api_cxx/db_open.html#DB_EXCL Db::open@DB_EXCL -__APIREL__/api_cxx/db_open.html#DB_NOMMAP Db::open@DB_NOMMAP -__APIREL__/api_cxx/db_open.html#DB_RDONLY Db::open@DB_RDONLY -__APIREL__/api_cxx/db_open.html#DB_THREAD Db::open@DB_THREAD -__APIREL__/api_cxx/db_open.html#DB_TRUNCATE Db::open@DB_TRUNCATE -__APIREL__/api_cxx/db_open.html#DB_OLD_VERSION Db::open@DB_OLD_VERSION -__APIREL__/api_cxx/db_put.html#2 @Db::put -__APIREL__/api_cxx/db_put.html#DB_APPEND Db::put@DB_APPEND -__APIREL__/api_cxx/db_put.html#DB_NODUPDATA Db::put@DB_NODUPDATA -__APIREL__/api_cxx/db_put.html#DB_NOOVERWRITE Db::put@DB_NOOVERWRITE -__APIREL__/api_cxx/db_remove.html#2 @Db::remove -__APIREL__/api_cxx/db_rename.html#2 @Db::rename -__APIREL__/api_cxx/db_set_append_recno.html#2 @Db::set_append_recno -__APIREL__/api_cxx/db_set_bt_compare.html#2 @Db::set_bt_compare -__APIREL__/api_cxx/db_set_bt_minkey.html#2 @Db::set_bt_minkey -__APIREL__/api_cxx/db_set_bt_prefix.html#2 @Db::set_bt_prefix -__APIREL__/api_cxx/db_set_cachesize.html#2 @Db::set_cachesize -__APIREL__/api_cxx/db_set_dup_compare.html#2 @Db::set_dup_compare -__APIREL__/api_cxx/db_set_errcall.html#2 @Db::set_errcall -__APIREL__/api_cxx/db_set_errpfx.html#2 @Db::set_errpfx -__APIREL__/api_cxx/db_set_feedback.html#2 @Db::set_feedback -__APIREL__/api_cxx/db_set_feedback.html#DB_UPGRADE Db::set_feedback@DB_UPGRADE -__APIREL__/api_cxx/db_set_feedback.html#DB_VERIFY Db::set_feedback@DB_VERIFY -__APIREL__/api_cxx/db_set_flags.html#2 @Db::set_flags -__APIREL__/api_cxx/db_set_flags.html#DB_DUP Db::set_flags@DB_DUP -__APIREL__/api_cxx/db_set_flags.html#DB_DUPSORT Db::set_flags@DB_DUPSORT -__APIREL__/api_cxx/db_set_flags.html#DB_RECNUM Db::set_flags@DB_RECNUM -__APIREL__/api_cxx/db_set_flags.html#DB_REVSPLITOFF Db::set_flags@DB_REVSPLITOFF -__APIREL__/api_cxx/db_set_flags.html#DB_DUP Db::set_flags@DB_DUP -__APIREL__/api_cxx/db_set_flags.html#DB_DUPSORT Db::set_flags@DB_DUPSORT -__APIREL__/api_cxx/db_set_flags.html#DB_RENUMBER Db::set_flags@DB_RENUMBER -__APIREL__/api_cxx/db_set_flags.html#DB_SNAPSHOT Db::set_flags@DB_SNAPSHOT -__APIREL__/api_cxx/db_set_h_ffactor.html#2 @Db::set_h_ffactor -__APIREL__/api_cxx/db_set_h_hash.html#2 @Db::set_h_hash -__APIREL__/api_cxx/db_set_h_nelem.html#2 @Db::set_h_nelem -__APIREL__/api_cxx/db_set_lorder.html#2 @Db::set_lorder -__APIREL__/api_cxx/db_set_pagesize.html#2 @Db::set_pagesize -__APIREL__/api_cxx/db_set_q_extentsize.html#2 @Db::set_q_extentsize -__APIREL__/api_cxx/db_set_re_delim.html#2 @Db::set_re_delim -__APIREL__/api_cxx/db_set_re_len.html#2 @Db::set_re_len -__APIREL__/api_cxx/db_set_re_pad.html#2 @Db::set_re_pad -__APIREL__/api_cxx/db_set_re_source.html#2 @Db::set_re_source -__APIREL__/api_cxx/db_stat.html#2 @Db::stat -__APIREL__/api_cxx/db_stat.html#DB_CACHED_COUNTS Db::stat@DB_CACHED_COUNTS -__APIREL__/api_cxx/db_stat.html#DB_RECORDCOUNT Db::stat@DB_RECORDCOUNT -__APIREL__/api_cxx/db_sync.html#2 @Db::sync -__APIREL__/api_cxx/db_upgrade.html#2 @Db::upgrade -__APIREL__/api_cxx/db_upgrade.html#DB_DUPSORT Db::upgrade@DB_DUPSORT -__APIREL__/api_cxx/db_upgrade.html#DB_OLD_VERSION Db::upgrade@DB_OLD_VERSION -__APIREL__/api_cxx/db_verify.html#2 @Db::verify -__APIREL__/api_cxx/db_verify.html#DB_SALVAGE Db::verify@DB_SALVAGE -__APIREL__/api_cxx/db_verify.html#DB_AGGRESSIVE Db::verify@DB_AGGRESSIVE -__APIREL__/api_cxx/db_verify.html#DB_NOORDERCHK Db::verify@DB_NOORDERCHK -__APIREL__/api_cxx/db_verify.html#DB_ORDERCHKONLY Db::verify@DB_ORDERCHKONLY -__APIREL__/api_cxx/dbc_close.html#2 @Dbc::close -__APIREL__/api_cxx/dbc_count.html#2 @Dbc::count -__APIREL__/api_cxx/dbc_del.html#2 @Dbc::del -__APIREL__/api_cxx/dbc_dup.html#2 @Dbc::dup -__APIREL__/api_cxx/dbc_dup.html#DB_POSITION Dbc::dup@DB_POSITION -__APIREL__/api_cxx/dbc_get.html#2 @Dbc::get -__APIREL__/api_cxx/dbc_get.html#DB_CURRENT Dbc::get@DB_CURRENT -__APIREL__/api_cxx/dbc_get.html#DB_FIRST Dbc::get@DB_FIRST -__APIREL__/api_cxx/dbc_get.html#DB_LAST Dbc::get@DB_LAST -__APIREL__/api_cxx/dbc_get.html#DB_GET_BOTH Dbc::get@DB_GET_BOTH -__APIREL__/api_cxx/dbc_get.html#DB_GET_RECNO Dbc::get@DB_GET_RECNO -__APIREL__/api_cxx/dbc_get.html#DB_JOIN_ITEM Dbc::get@DB_JOIN_ITEM -__APIREL__/api_cxx/dbc_get.html#DB_NEXT Dbc::get@DB_NEXT -__APIREL__/api_cxx/dbc_get.html#DB_PREV Dbc::get@DB_PREV -__APIREL__/api_cxx/dbc_get.html#DB_NEXT_DUP Dbc::get@DB_NEXT_DUP -__APIREL__/api_cxx/dbc_get.html#DB_NEXT_NODUP Dbc::get@DB_NEXT_NODUP -__APIREL__/api_cxx/dbc_get.html#DB_PREV_NODUP Dbc::get@DB_PREV_NODUP -__APIREL__/api_cxx/dbc_get.html#DB_SET Dbc::get@DB_SET -__APIREL__/api_cxx/dbc_get.html#DB_SET_RANGE Dbc::get@DB_SET_RANGE -__APIREL__/api_cxx/dbc_get.html#DB_SET_RECNO Dbc::get@DB_SET_RECNO -__APIREL__/api_cxx/dbc_get.html#DB_RMW Dbc::get@DB_RMW -__APIREL__/api_cxx/dbc_put.html#2 @Dbc::put -__APIREL__/api_cxx/dbc_put.html#DB_AFTER Dbc::put@DB_AFTER -__APIREL__/api_cxx/dbc_put.html#DB_BEFORE Dbc::put@DB_BEFORE -__APIREL__/api_cxx/dbc_put.html#DB_CURRENT Dbc::put@DB_CURRENT -__APIREL__/api_cxx/dbc_put.html#DB_KEYFIRST Dbc::put@DB_KEYFIRST -__APIREL__/api_cxx/dbc_put.html#DB_KEYLAST Dbc::put@DB_KEYLAST -__APIREL__/api_cxx/dbc_put.html#DB_NODUPDATA Dbc::put@DB_NODUPDATA -__APIREL__/api_cxx/env_close.html#2 @DbEnv::close -__APIREL__/api_cxx/env_open.html#2 @DbEnv::open -__APIREL__/api_cxx/env_open.html#DB_JOINENV DbEnv::open@DB_JOINENV -__APIREL__/api_cxx/env_open.html#DB_INIT_CDB DbEnv::open@DB_INIT_CDB -__APIREL__/api_cxx/env_open.html#DB_INIT_LOCK DbEnv::open@DB_INIT_LOCK -__APIREL__/api_cxx/env_open.html#DB_INIT_LOG DbEnv::open@DB_INIT_LOG -__APIREL__/api_cxx/env_open.html#DB_INIT_MPOOL DbEnv::open@DB_INIT_MPOOL -__APIREL__/api_cxx/env_open.html#DB_INIT_TXN DbEnv::open@DB_INIT_TXN -__APIREL__/api_cxx/env_open.html#DB_RECOVER DbEnv::open@DB_RECOVER -__APIREL__/api_cxx/env_open.html#DB_RECOVER_FATAL DbEnv::open@DB_RECOVER_FATAL -__APIREL__/api_cxx/env_open.html#DB_USE_ENVIRON DbEnv::open@DB_USE_ENVIRON -__APIREL__/api_cxx/env_open.html#DB_USE_ENVIRON_ROOT DbEnv::open@DB_USE_ENVIRON_ROOT -__APIREL__/api_cxx/env_open.html#DB_CREATE DbEnv::open@DB_CREATE -__APIREL__/api_cxx/env_open.html#DB_LOCKDOWN DbEnv::open@DB_LOCKDOWN -__APIREL__/api_cxx/env_open.html#DB_PRIVATE DbEnv::open@DB_PRIVATE -__APIREL__/api_cxx/env_open.html#DB_SYSTEM_MEM DbEnv::open@DB_SYSTEM_MEM -__APIREL__/api_cxx/env_open.html#DB_THREAD DbEnv::open@DB_THREAD -__APIREL__/api_cxx/env_remove.html#2 @DbEnv::remove -__APIREL__/api_cxx/env_remove.html#DB_FORCE DbEnv::remove@DB_FORCE -__APIREL__/api_cxx/env_remove.html#DB_USE_ENVIRON DbEnv::remove@DB_USE_ENVIRON -__APIREL__/api_cxx/env_remove.html#DB_USE_ENVIRON_ROOT DbEnv::remove@DB_USE_ENVIRON_ROOT -__APIREL__/api_cxx/env_set_cachesize.html#2 @DbEnv::set_cachesize -__APIREL__/api_cxx/env_set_data_dir.html#2 @DbEnv::set_data_dir -__APIREL__/api_cxx/env_set_errcall.html#2 @DbEnv::set_errcall -__APIREL__/api_cxx/env_set_errpfx.html#2 @DbEnv::set_errpfx -__APIREL__/api_cxx/env_set_feedback.html#2 @DbEnv::set_feedback -__APIREL__/api_cxx/env_set_feedback.html#DB_RECOVER DbEnv::set_feedback@DB_RECOVER -__APIREL__/api_cxx/env_set_flags.html#2 @DbEnv::set_flags -__APIREL__/api_cxx/env_set_flags.html#DB_CDB_ALLDB DbEnv::set_flags@DB_CDB_ALLDB -__APIREL__/api_cxx/env_set_flags.html#DB_NOMMAP DbEnv::set_flags@DB_NOMMAP -__APIREL__/api_cxx/env_set_flags.html#DB_TXN_NOSYNC DbEnv::set_flags@DB_TXN_NOSYNC -__APIREL__/api_cxx/env_set_lg_bsize.html#2 @DbEnv::set_lg_bsize -__APIREL__/api_cxx/env_set_lg_dir.html#2 @DbEnv::set_lg_dir -__APIREL__/api_cxx/env_set_lg_max.html#2 @DbEnv::set_lg_max -__APIREL__/api_cxx/env_set_lk_conflicts.html#2 @DbEnv::set_lk_conflicts -__APIREL__/api_cxx/env_set_lk_detect.html#2 @DbEnv::set_lk_detect -__APIREL__/api_cxx/env_set_lk_detect.html#DB_LOCK_DEFAULT DbEnv::set_lk_detect@DB_LOCK_DEFAULT -__APIREL__/api_cxx/env_set_lk_detect.html#DB_LOCK_OLDEST DbEnv::set_lk_detect@DB_LOCK_OLDEST -__APIREL__/api_cxx/env_set_lk_detect.html#DB_LOCK_RANDOM DbEnv::set_lk_detect@DB_LOCK_RANDOM -__APIREL__/api_cxx/env_set_lk_detect.html#DB_LOCK_YOUNGEST DbEnv::set_lk_detect@DB_LOCK_YOUNGEST -__APIREL__/api_cxx/env_set_lk_max.html#2 @DbEnv::set_lk_max -__APIREL__/api_cxx/env_set_lk_max_locks.html#2 @DbEnv::set_lk_max_locks -__APIREL__/api_cxx/env_set_lk_max_lockers.html#2 @DbEnv::set_lk_max_lockers -__APIREL__/api_cxx/env_set_lk_max_objects.html#2 @DbEnv::set_lk_max_objects -__APIREL__/api_cxx/env_set_mp_mmapsize.html#2 @DbEnv::set_mp_mmapsize -__APIREL__/api_cxx/env_set_mutexlocks.html#2 @DbEnv::set_mutexlocks -__APIREL__/api_cxx/env_set_pageyield.html#2 @DbEnv::set_pageyield -__APIREL__/api_cxx/env_set_panicstate.html#2 @DbEnv::set_panicstate -__APIREL__/api_cxx/env_set_rec_init.html#2 @DbEnv::set_recovery_init -__APIREL__/api_cxx/env_set_region_init.html#2 @DbEnv::set_region_init -__APIREL__/api_cxx/env_set_server.html#2 @DbEnv::set_server -__APIREL__/api_cxx/env_set_server.html#DB_NOSERVER DbEnv::set_server@DB_NOSERVER -__APIREL__/api_cxx/env_set_server.html#DB_NOSERVER_ID DbEnv::set_server@DB_NOSERVER_ID -__APIREL__/api_cxx/env_set_shm_key.html#2 @DbEnv::set_shm_key -__APIREL__/api_cxx/env_set_tas_spins.html#2 @DbEnv::set_tas_spins -__APIREL__/api_cxx/env_set_tmp_dir.html#2 @DbEnv::set_tmp_dir -__APIREL__/api_cxx/env_set_tx_max.html#2 @DbEnv::set_tx_max -__APIREL__/api_cxx/env_set_tx_recover.html#2 @DbEnv::set_tx_recover -__APIREL__/api_cxx/env_set_tx_recover.html#DB_TXN_BACKWARD_ROLL DbEnv::set_tx_recover@DB_TXN_BACKWARD_ROLL -__APIREL__/api_cxx/env_set_tx_recover.html#DB_TXN_FORWARD_ROLL DbEnv::set_tx_recover@DB_TXN_FORWARD_ROLL -__APIREL__/api_cxx/env_set_tx_recover.html#DB_TXN_ABORT DbEnv::set_tx_recover@DB_TXN_ABORT -__APIREL__/api_cxx/env_set_tx_timestamp.html#2 @DbEnv::set_tx_timestamp -__APIREL__/api_cxx/env_set_verbose.html#2 @DbEnv::set_verbose -__APIREL__/api_cxx/env_set_verbose.html#DB_VERB_CHKPOINT DbEnv::set_verbose@DB_VERB_CHKPOINT -__APIREL__/api_cxx/env_set_verbose.html#DB_VERB_DEADLOCK DbEnv::set_verbose@DB_VERB_DEADLOCK -__APIREL__/api_cxx/env_set_verbose.html#DB_VERB_RECOVERY DbEnv::set_verbose@DB_VERB_RECOVERY -__APIREL__/api_cxx/env_set_verbose.html#DB_VERB_WAITSFOR DbEnv::set_verbose@DB_VERB_WAITSFOR -__APIREL__/api_cxx/env_strerror.html#2 @DbEnv::strerror -__APIREL__/api_cxx/env_version.html#2 @DbEnv::version -__APIREL__/api_cxx/lock_detect.html#2 @DbEnv::lock_detect -__APIREL__/api_cxx/lock_detect.html#DB_LOCK_CONFLICT DbEnv::lock_detect@DB_LOCK_CONFLICT -__APIREL__/api_cxx/lock_get.html#2 @DbEnv::lock_get -__APIREL__/api_cxx/lock_get.html#DB_LOCK_NOWAIT DbEnv::lock_get@DB_LOCK_NOWAIT -__APIREL__/api_cxx/lock_get.html#DB_LOCK_NOTGRANTED DbEnv::lock_get@DB_LOCK_NOTGRANTED -__APIREL__/api_cxx/lock_id.html#2 @DbEnv::lock_id -__APIREL__/api_cxx/lock_put.html#2 @DbLock::put -__APIREL__/api_cxx/lock_stat.html#2 @DbEnv::lock_stat -__APIREL__/api_cxx/lock_vec.html#2 @DbEnv::lock_vec -__APIREL__/api_cxx/lock_vec.html#DB_LOCK_NOWAIT DbEnv::lock_vec@DB_LOCK_NOWAIT -__APIREL__/api_cxx/lock_vec.html#op DbEnv::lock_vec@op -__APIREL__/api_cxx/lock_vec.html#DB_LOCK_GET DbEnv::lock_vec@DB_LOCK_GET -__APIREL__/api_cxx/lock_vec.html#DB_LOCK_PUT DbEnv::lock_vec@DB_LOCK_PUT -__APIREL__/api_cxx/lock_vec.html#DB_LOCK_PUT_ALL DbEnv::lock_vec@DB_LOCK_PUT_ALL -__APIREL__/api_cxx/lock_vec.html#DB_LOCK_PUT_OBJ DbEnv::lock_vec@DB_LOCK_PUT_OBJ -__APIREL__/api_cxx/lock_vec.html#obj DbEnv::lock_vec@obj -__APIREL__/api_cxx/lock_vec.html#mode DbEnv::lock_vec@mode -__APIREL__/api_cxx/lock_vec.html#lock DbEnv::lock_vec@lock -__APIREL__/api_cxx/lock_vec.html#DB_LOCK_NOTGRANTED DbEnv::lock_vec@DB_LOCK_NOTGRANTED -__APIREL__/api_cxx/log_archive.html#2 @DbEnv::log_archive -__APIREL__/api_cxx/log_archive.html#DB_ARCH_ABS DbEnv::log_archive@DB_ARCH_ABS -__APIREL__/api_cxx/log_archive.html#DB_ARCH_DATA DbEnv::log_archive@DB_ARCH_DATA -__APIREL__/api_cxx/log_archive.html#DB_ARCH_LOG DbEnv::log_archive@DB_ARCH_LOG -__APIREL__/api_cxx/log_compare.html#2 @DbEnv::log_compare -__APIREL__/api_cxx/log_file.html#2 @DbEnv::log_file -__APIREL__/api_cxx/log_flush.html#2 @DbEnv::log_flush -__APIREL__/api_cxx/log_get.html#2 @DbEnv::log_get -__APIREL__/api_cxx/log_get.html#DB_CHECKPOINT DbEnv::log_get@DB_CHECKPOINT -__APIREL__/api_cxx/log_get.html#DB_FIRST DbEnv::log_get@DB_FIRST -__APIREL__/api_cxx/log_get.html#DB_LAST DbEnv::log_get@DB_LAST -__APIREL__/api_cxx/log_get.html#DB_NEXT DbEnv::log_get@DB_NEXT -__APIREL__/api_cxx/log_get.html#DB_PREV DbEnv::log_get@DB_PREV -__APIREL__/api_cxx/log_get.html#DB_CURRENT DbEnv::log_get@DB_CURRENT -__APIREL__/api_cxx/log_get.html#DB_SET DbEnv::log_get@DB_SET -__APIREL__/api_cxx/log_put.html#2 @DbEnv::log_put -__APIREL__/api_cxx/log_put.html#DB_CHECKPOINT DbEnv::log_put@DB_CHECKPOINT -__APIREL__/api_cxx/log_put.html#DB_CURLSN DbEnv::log_put@DB_CURLSN -__APIREL__/api_cxx/log_put.html#DB_FLUSH DbEnv::log_put@DB_FLUSH -__APIREL__/api_cxx/log_register.html#2 @DbEnv::log_register -__APIREL__/api_cxx/log_stat.html#2 @DbEnv::log_stat -__APIREL__/api_cxx/log_unregister.html#2 @DbEnv::log_unregister -__APIREL__/api_cxx/memp_fclose.html#2 @DbMpoolFile::close -__APIREL__/api_cxx/memp_fget.html#2 @DbMpoolFile::get -__APIREL__/api_cxx/memp_fget.html#DB_MPOOL_CREATE DbMpoolFile::get@DB_MPOOL_CREATE -__APIREL__/api_cxx/memp_fget.html#DB_MPOOL_LAST DbMpoolFile::get@DB_MPOOL_LAST -__APIREL__/api_cxx/memp_fget.html#DB_MPOOL_NEW DbMpoolFile::get@DB_MPOOL_NEW -__APIREL__/api_cxx/memp_fopen.html#2 @DbMpoolFile::open -__APIREL__/api_cxx/memp_fopen.html#DB_CREATE DbMpoolFile::open@DB_CREATE -__APIREL__/api_cxx/memp_fopen.html#DB_NOMMAP DbMpoolFile::open@DB_NOMMAP -__APIREL__/api_cxx/memp_fopen.html#DB_RDONLY DbMpoolFile::open@DB_RDONLY -__APIREL__/api_cxx/memp_fopen.html#ftype DbMpoolFile::open@ftype -__APIREL__/api_cxx/memp_fopen.html#pgcookie DbMpoolFile::open@pgcookie -__APIREL__/api_cxx/memp_fopen.html#fileid DbMpoolFile::open@fileid -__APIREL__/api_cxx/memp_fopen.html#lsn_offset DbMpoolFile::open@lsn_offset -__APIREL__/api_cxx/memp_fopen.html#clear_len DbMpoolFile::open@clear_len -__APIREL__/api_cxx/memp_fput.html#2 @DbMpoolFile::put -__APIREL__/api_cxx/memp_fput.html#DB_MPOOL_CLEAN DbMpoolFile::put@DB_MPOOL_CLEAN -__APIREL__/api_cxx/memp_fput.html#DB_MPOOL_DIRTY DbMpoolFile::put@DB_MPOOL_DIRTY -__APIREL__/api_cxx/memp_fput.html#DB_MPOOL_DISCARD DbMpoolFile::put@DB_MPOOL_DISCARD -__APIREL__/api_cxx/memp_fset.html#2 @DbMpoolFile::set -__APIREL__/api_cxx/memp_fset.html#DB_MPOOL_CLEAN DbMpoolFile::set@DB_MPOOL_CLEAN -__APIREL__/api_cxx/memp_fset.html#DB_MPOOL_DIRTY DbMpoolFile::set@DB_MPOOL_DIRTY -__APIREL__/api_cxx/memp_fset.html#DB_MPOOL_DISCARD DbMpoolFile::set@DB_MPOOL_DISCARD -__APIREL__/api_cxx/memp_fsync.html#2 @DbMpoolFile::sync -__APIREL__/api_cxx/memp_register.html#2 @DbEnv::memp_register -__APIREL__/api_cxx/memp_stat.html#2 @DbEnv::memp_stat -__APIREL__/api_cxx/memp_sync.html#2 @DbEnv::memp_sync -__APIREL__/api_cxx/memp_trickle.html#2 @DbEnv::memp_trickle -__APIREL__/api_cxx/txn_abort.html#2 @DbTxn::abort -__APIREL__/api_cxx/txn_begin.html#2 @DbEnv::txn_begin -__APIREL__/api_cxx/txn_begin.html#DB_TXN_NOSYNC DbEnv::txn_begin@DB_TXN_NOSYNC -__APIREL__/api_cxx/txn_begin.html#DB_TXN_NOWAIT DbEnv::txn_begin@DB_TXN_NOWAIT -__APIREL__/api_cxx/txn_begin.html#DB_TXN_SYNC DbEnv::txn_begin@DB_TXN_SYNC -__APIREL__/api_cxx/txn_checkpoint.html#2 @DbEnv::txn_checkpoint -__APIREL__/api_cxx/txn_checkpoint.html#DB_FORCE DbEnv::txn_checkpoint@DB_FORCE -__APIREL__/api_cxx/txn_commit.html#2 @DbTxn::commit -__APIREL__/api_cxx/txn_commit.html#DB_TXN_NOSYNC DbTxn::commit@DB_TXN_NOSYNC -__APIREL__/api_cxx/txn_commit.html#DB_TXN_SYNC DbTxn::commit@DB_TXN_SYNC -__APIREL__/api_cxx/txn_id.html#2 @DbTxn::id -__APIREL__/api_cxx/txn_prepare.html#2 @DbTxn::prepare -__APIREL__/api_cxx/txn_stat.html#2 @DbEnv::txn_stat diff --git a/bdb/docs/api_cxx/txn_abort.html b/bdb/docs/api_cxx/txn_abort.html deleted file mode 100644 index f9c863b3e87..00000000000 --- a/bdb/docs/api_cxx/txn_abort.html +++ /dev/null @@ -1,67 +0,0 @@ -<!--$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: DbTxn::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>DbTxn::abort</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbTxn::abort(); -</pre></h3> -<h1>Description</h1> -<p>The DbTxn::abort method 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_cxx/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_cxx/txn_commit.html">DbTxn::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 DbTxn::abort method returns, the <a href="../api_cxx/txn_class.html">DbTxn</a> handle may not -be accessed again. -<p>The DbTxn::abort method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbTxn::abort method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbTxn::abort method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_begin.html b/bdb/docs/api_cxx/txn_begin.html deleted file mode 100644 index 4cacec56088..00000000000 --- a/bdb/docs/api_cxx/txn_begin.html +++ /dev/null @@ -1,96 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::txn_begin</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::txn_begin(DbTxn *parent, DbTxn **tid, u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::txn_begin method creates a new transaction in the environment -and copies a pointer to a <a href="../api_cxx/txn_class.html">DbTxn</a> 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_cxx/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_cxx/env_open.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a> flag was specified to the <a href="../api_cxx/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 -DbEnv::txn_begin, <a href="../api_cxx/txn_abort.html">DbTxn::abort</a> and <a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, while it has -active child transactions (child transactions that have not yet been -committed or aborted).</b> -<p>The DbEnv::txn_begin method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::txn_begin method may fail and throw an exception or 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 DbEnv::txn_begin method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::txn_begin method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_checkpoint.html b/bdb/docs/api_cxx/txn_checkpoint.html deleted file mode 100644 index 3bac70bccbc..00000000000 --- a/bdb/docs/api_cxx/txn_checkpoint.html +++ /dev/null @@ -1,75 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::txn_checkpoint</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbEnv::txn_checkpoint(u_int32_t kbyte, u_int32_t min, u_int32_t flags) const; -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::txn_checkpoint method 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 DbEnv::txn_checkpoint method either returns a non-zero error value or throws an exception that -encapsulates 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_cxx/memp_sync.html">DbEnv::memp_sync</a> was unable -to write immediately. -<h1>Errors</h1> -<p>The DbEnv::txn_checkpoint method may fail and throw an exception or 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 DbEnv::txn_checkpoint method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::txn_checkpoint method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_class.html b/bdb/docs/api_cxx/txn_class.html deleted file mode 100644 index 7a335f92a1a..00000000000 --- a/bdb/docs/api_cxx/txn_class.html +++ /dev/null @@ -1,59 +0,0 @@ -<!--$Id: txn_class.so,v 10.13 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: DbTxn</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>DbTxn</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -class DbTxn { ... }; -</pre></h3> -<h1>Description</h1> -<p>This manual page describes the specific details of the DbTxn class. -<p>The <a href="../api_cxx/dbenv_class.html">DbEnv</a> transaction methods and the DbTxn class provide -transaction semantics. Full transaction support is provided by a -collection of modules that provide interfaces to the services required -for transaction processing. These services are recovery, concurrency -control and the management of shared data. -<p>Transaction semantics can be applied to the access methods described in -Db through method call parameters. -<p>The model intended for transactional use (and the one that is used by -the access methods) is write-ahead logging to record both before- and -after-images. Locking follows a two-phase protocol, with all locks being -released at transaction commit. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_commit.html b/bdb/docs/api_cxx/txn_commit.html deleted file mode 100644 index 16e20c2535c..00000000000 --- a/bdb/docs/api_cxx/txn_commit.html +++ /dev/null @@ -1,87 +0,0 @@ -<!--$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: DbTxn::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>DbTxn::commit</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbTxn::commit(u_int32_t flags); -</pre></h3> -<h1>Description</h1> -<p>The DbTxn::commit method 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_cxx/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_cxx/env_open.html#DB_TXN_NOSYNC">DB_TXN_NOSYNC</a> flag was specified to the <a href="../api_cxx/env_set_flags.html">DbEnv::set_flags</a> -or <a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a> interfaces. -</dl> -<p>Once the DbTxn::commit method returns, the <a href="../api_cxx/txn_class.html">DbTxn</a> handle may not -be accessed again. If DbTxn::commit encounters an error, the -transaction and all child transactions of the transaction are aborted. -<p>The DbTxn::commit method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbTxn::commit method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbTxn::commit method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_id.html b/bdb/docs/api_cxx/txn_id.html deleted file mode 100644 index 9c14adf1c59..00000000000 --- a/bdb/docs/api_cxx/txn_id.html +++ /dev/null @@ -1,52 +0,0 @@ -<!--$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: DbTxn::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>DbTxn::id</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -u_int32_t -DbTxn::id(); -</pre></h3> -<h1>Description</h1> -<p>The DbTxn::id method returns the unique transaction id associated with the -specified transaction. Locking calls made on behalf of this transaction -should use the value returned from DbTxn::id as the locker parameter -to the <a href="../api_cxx/lock_get.html">DbEnv::lock_get</a> or <a href="../api_cxx/lock_vec.html">DbEnv::lock_vec</a> calls. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_prepare.html b/bdb/docs/api_cxx/txn_prepare.html deleted file mode 100644 index de7db8e7611..00000000000 --- a/bdb/docs/api_cxx/txn_prepare.html +++ /dev/null @@ -1,67 +0,0 @@ -<!--$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: DbTxn::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>DbTxn::prepare</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -int -DbTxn::prepare(); -</pre></h3> -<h1>Description</h1> -<p>The DbTxn::prepare method 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 DbTxn::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 DbTxn::prepare method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbTxn::prepare method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbTxn::prepare method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/txn_stat.html b/bdb/docs/api_cxx/txn_stat.html deleted file mode 100644 index 9644a6ae889..00000000000 --- a/bdb/docs/api_cxx/txn_stat.html +++ /dev/null @@ -1,100 +0,0 @@ -<!--$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: DbEnv::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>DbEnv::txn_stat</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -extern "C" { - typedef void *(*db_malloc_fcn_type)(size_t); -}; -int -DbEnv::txn_stat(DB_TXN_STAT **statp, db_malloc_fcn_type db_malloc); -</pre></h3> -<h1>Description</h1> -<p>The DbEnv::txn_stat method -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_cxx/lsn_class.html">DbLsn</a> st_last_ckp;<dd>The LSN of the last checkpoint. -<dt><a href="../api_cxx/lsn_class.html">DbLsn</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_cxx/txn_begin.html">DbEnv::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_cxx/lsn_class.html">DbLsn</a> lsn;<dd>The log sequence number of the transaction-begin record. -</dl> -</dl> -<p>The DbEnv::txn_stat method either returns a non-zero error value or throws an exception that -encapsulates a non-zero error value on failure, and returns 0 on success. -<h1>Errors</h1> -<p>The DbEnv::txn_stat method may fail and throw an exception or return a non-zero error for errors specified for other Berkeley DB and C library or system methods. -If a catastrophic error has occurred, the DbEnv::txn_stat method may fail and either -return <a href="../ref/program/errorret.html#DB_RUNRECOVERY">DB_RUNRECOVERY</a> or throw an exception encapsulating -<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. -<h3>Classes</h3> -<a href="../api_cxx/dbenv_class.html">DbEnv</a>, <a href="../api_cxx/txn_class.html">DbTxn</a> -<h1>See Also</h1> -<a href="../api_cxx/env_set_tx_max.html">DbEnv::set_tx_max</a>, -<a href="../api_cxx/env_set_tx_recover.html">DbEnv::set_tx_recover</a>, -<a href="../api_cxx/env_set_tx_timestamp.html">DbEnv::set_tx_timestamp</a>, -<a href="../api_cxx/txn_abort.html">DbTxn::abort</a>, -<a href="../api_cxx/txn_begin.html">DbEnv::txn_begin</a>, -<a href="../api_cxx/txn_checkpoint.html">DbEnv::txn_checkpoint</a>, -<a href="../api_cxx/txn_commit.html">DbTxn::commit</a>, -<a href="../api_cxx/txn_id.html">DbTxn::id</a>, -<a href="../api_cxx/txn_prepare.html">DbTxn::prepare</a> -and -<a href="../api_cxx/txn_stat.html">DbEnv::txn_stat</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx/what.html b/bdb/docs/api_cxx/what.html deleted file mode 100644 index 9e0410c7684..00000000000 --- a/bdb/docs/api_cxx/what.html +++ /dev/null @@ -1,43 +0,0 @@ -<!--$Id: what.so,v 10.8 1999/12/20 08:52:33 bostic Exp $--> -<!--Copyright 1997, 1998, 1999, 2000 by Sleepycat Software, Inc.--> -<!--All rights reserved.--> -<html> -<head> -<title>Berkeley DB: DbException::what</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>DbException::what</h1> -</td> -<td width="1%"> -<a href="../api_cxx/cxx_index.html"><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_cxx.h> -<p> -virtual const char * -DbException::what() const; -</pre></h3> -<h1>Description</h1> -<p>A DbException object contains an informational string and an errno. -The errno can be obtained by using <a href="../api_cxx/get_errno.html">DbException::get_errno</a>. -The informational string can be obtained by using DbException::what. -<h3>Class</h3> -<a href="../api_cxx/except_class.html">DbException</a> -<h1>See Also</h1> -<a href="../api_cxx/get_errno.html">DbException::get_errno</a> -and -<a href="../api_cxx/what.html">DbException::what</a>. -</tt> -<table><tr><td><br></td><td width="1%"> -<a href="../api_cxx/cxx_index.html"><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> |