diff options
| author | unknown <ram@mysql.r18.ru> | 2002-10-30 15:57:05 +0400 |
|---|---|---|
| committer | unknown <ram@mysql.r18.ru> | 2002-10-30 15:57:05 +0400 |
| commit | 155e78f014de1a2e259ae5119f4621fbb210a784 (patch) | |
| tree | 6881a3cca88bea0bb9eeffd5aae34be437152786 /bdb/tcl/docs | |
| parent | b8798d25ab71436bf690ee8ae48285a655c5487e (diff) | |
| download | mariadb-git-155e78f014de1a2e259ae5119f4621fbb210a784.tar.gz | |
BDB 4.1.24
BitKeeper/deleted/.del-ex_access.wpj~3df6ae8c99bf7c5f:
Delete: bdb/build_vxworks/ex_access/ex_access.wpj
BitKeeper/deleted/.del-ex_btrec.wpj~a7622f1c6f432dc6:
Delete: bdb/build_vxworks/ex_btrec/ex_btrec.wpj
BitKeeper/deleted/.del-ex_dbclient.wpj~7345440f3b204cdd:
Delete: bdb/build_vxworks/ex_dbclient/ex_dbclient.wpj
BitKeeper/deleted/.del-ex_env.wpj~fbe1ab10b04e8b74:
Delete: bdb/build_vxworks/ex_env/ex_env.wpj
BitKeeper/deleted/.del-ex_mpool.wpj~4479cfd5c45f327d:
Delete: bdb/build_vxworks/ex_mpool/ex_mpool.wpj
BitKeeper/deleted/.del-ex_tpcb.wpj~f78093006e14bf41:
Delete: bdb/build_vxworks/ex_tpcb/ex_tpcb.wpj
BitKeeper/deleted/.del-db_buildall.dsp~bd749ff6da11682:
Delete: bdb/build_win32/db_buildall.dsp
BitKeeper/deleted/.del-cxx_app.cpp~ad8df8e0791011ed:
Delete: bdb/cxx/cxx_app.cpp
BitKeeper/deleted/.del-cxx_log.cpp~a50ff3118fe06952:
Delete: bdb/cxx/cxx_log.cpp
BitKeeper/deleted/.del-cxx_table.cpp~ecd751e79b055556:
Delete: bdb/cxx/cxx_table.cpp
BitKeeper/deleted/.del-namemap.txt~796a3acd3885d8fd:
Delete: bdb/cxx/namemap.txt
BitKeeper/deleted/.del-Design.fileop~3ca4da68f1727373:
Delete: bdb/db/Design.fileop
BitKeeper/deleted/.del-db185_int.h~61bee3736e7959ef:
Delete: bdb/db185/db185_int.h
BitKeeper/deleted/.del-acconfig.h~411e8854d67ad8b5:
Delete: bdb/dist/acconfig.h
BitKeeper/deleted/.del-mutex.m4~a13383cde18a64e1:
Delete: bdb/dist/aclocal/mutex.m4
BitKeeper/deleted/.del-options.m4~b9d0ca637213750a:
Delete: bdb/dist/aclocal/options.m4
BitKeeper/deleted/.del-programs.m4~3ce7890b47732b30:
Delete: bdb/dist/aclocal/programs.m4
BitKeeper/deleted/.del-tcl.m4~f944e2db93c3b6db:
Delete: bdb/dist/aclocal/tcl.m4
BitKeeper/deleted/.del-types.m4~59cae158c9a32cff:
Delete: bdb/dist/aclocal/types.m4
BitKeeper/deleted/.del-script~d38f6d3a4f159cb4:
Delete: bdb/dist/build/script
BitKeeper/deleted/.del-configure.in~ac795a92c8fe049c:
Delete: bdb/dist/configure.in
BitKeeper/deleted/.del-ltconfig~66bbd007d8024af:
Delete: bdb/dist/ltconfig
BitKeeper/deleted/.del-rec_ctemp~a28554362534f00a:
Delete: bdb/dist/rec_ctemp
BitKeeper/deleted/.del-s_tcl~2ffe4326459fcd9f:
Delete: bdb/dist/s_tcl
BitKeeper/deleted/.del-.IGNORE_ME~d8148b08fa7d5d15:
Delete: bdb/dist/template/.IGNORE_ME
BitKeeper/deleted/.del-btree.h~179f2aefec1753d:
Delete: bdb/include/btree.h
BitKeeper/deleted/.del-cxx_int.h~6b649c04766508f8:
Delete: bdb/include/cxx_int.h
BitKeeper/deleted/.del-db.src~6b433ae615b16a8d:
Delete: bdb/include/db.src
BitKeeper/deleted/.del-db_185.h~ad8b373d9391d35c:
Delete: bdb/include/db_185.h
BitKeeper/deleted/.del-db_am.h~a714912b6b75932f:
Delete: bdb/include/db_am.h
BitKeeper/deleted/.del-db_cxx.h~fcafadf45f5d19e9:
Delete: bdb/include/db_cxx.h
BitKeeper/deleted/.del-db_dispatch.h~6844f20f7eb46904:
Delete: bdb/include/db_dispatch.h
BitKeeper/deleted/.del-db_int.src~419a3f48b6a01da7:
Delete: bdb/include/db_int.src
BitKeeper/deleted/.del-db_join.h~76f9747a42c3399a:
Delete: bdb/include/db_join.h
BitKeeper/deleted/.del-db_page.h~e302ca3a4db3abdc:
Delete: bdb/include/db_page.h
BitKeeper/deleted/.del-db_server_int.h~e1d20b6ba3bca1ab:
Delete: bdb/include/db_server_int.h
BitKeeper/deleted/.del-db_shash.h~5fbf2d696fac90f3:
Delete: bdb/include/db_shash.h
BitKeeper/deleted/.del-db_swap.h~1e60887550864a59:
Delete: bdb/include/db_swap.h
BitKeeper/deleted/.del-db_upgrade.h~c644eee73701fc8d:
Delete: bdb/include/db_upgrade.h
BitKeeper/deleted/.del-db_verify.h~b8d6c297c61f342e:
Delete: bdb/include/db_verify.h
BitKeeper/deleted/.del-debug.h~dc2b4f2cf27ccebc:
Delete: bdb/include/debug.h
BitKeeper/deleted/.del-hash.h~2aaa548b28882dfb:
Delete: bdb/include/hash.h
BitKeeper/deleted/.del-lock.h~a761c1b7de57b77f:
Delete: bdb/include/lock.h
BitKeeper/deleted/.del-log.h~ff20184238e35e4d:
Delete: bdb/include/log.h
BitKeeper/deleted/.del-mp.h~7e317597622f3411:
Delete: bdb/include/mp.h
BitKeeper/deleted/.del-mutex.h~d3ae7a2977a68137:
Delete: bdb/include/mutex.h
BitKeeper/deleted/.del-os.h~91867cc8757cd0e3:
Delete: bdb/include/os.h
BitKeeper/deleted/.del-os_jump.h~e1b939fa5151d4be:
Delete: bdb/include/os_jump.h
BitKeeper/deleted/.del-qam.h~6fad0c1b5723d597:
Delete: bdb/include/qam.h
BitKeeper/deleted/.del-queue.h~4c72c0826c123d5:
Delete: bdb/include/queue.h
BitKeeper/deleted/.del-region.h~513fe04d977ca0fc:
Delete: bdb/include/region.h
BitKeeper/deleted/.del-shqueue.h~525fc3e6c2025c36:
Delete: bdb/include/shqueue.h
BitKeeper/deleted/.del-tcl_db.h~c536fd61a844f23f:
Delete: bdb/include/tcl_db.h
BitKeeper/deleted/.del-txn.h~c8d94b221ec147e4:
Delete: bdb/include/txn.h
BitKeeper/deleted/.del-xa.h~ecc466493aae9d9a:
Delete: bdb/include/xa.h
BitKeeper/deleted/.del-DbRecoveryInit.java~756b52601a0b9023:
Delete: bdb/java/src/com/sleepycat/db/DbRecoveryInit.java
BitKeeper/deleted/.del-DbTxnRecover.java~74607cba7ab89d6d:
Delete: bdb/java/src/com/sleepycat/db/DbTxnRecover.java
BitKeeper/deleted/.del-lock_conflict.c~fc5e0f14cf597a2b:
Delete: bdb/lock/lock_conflict.c
BitKeeper/deleted/.del-log.src~53ac9e7b5cb023f2:
Delete: bdb/log/log.src
BitKeeper/deleted/.del-log_findckp.c~24287f008916e81f:
Delete: bdb/log/log_findckp.c
BitKeeper/deleted/.del-log_rec.c~d51711f2cac09297:
Delete: bdb/log/log_rec.c
BitKeeper/deleted/.del-log_register.c~b40bb4efac75ca15:
Delete: bdb/log/log_register.c
BitKeeper/deleted/.del-Design~b3d0f179f2767b:
Delete: bdb/mp/Design
BitKeeper/deleted/.del-os_finit.c~95dbefc6fe79b26c:
Delete: bdb/os/os_finit.c
BitKeeper/deleted/.del-os_abs.c~df95d1e7db81924:
Delete: bdb/os_vxworks/os_abs.c
BitKeeper/deleted/.del-os_finit.c~803b484bdb9d0122:
Delete: bdb/os_vxworks/os_finit.c
BitKeeper/deleted/.del-os_map.c~3a6d7926398b76d3:
Delete: bdb/os_vxworks/os_map.c
BitKeeper/deleted/.del-os_finit.c~19a227c6d3c78ad:
Delete: bdb/os_win32/os_finit.c
BitKeeper/deleted/.del-log-corruption.patch~1cf2ecc7c6408d5d:
Delete: bdb/patches/log-corruption.patch
BitKeeper/deleted/.del-Btree.pm~af6d0c5eaed4a98e:
Delete: bdb/perl.BerkeleyDB/BerkeleyDB/Btree.pm
BitKeeper/deleted/.del-BerkeleyDB.pm~7244036d4482643:
Delete: bdb/perl.BerkeleyDB/BerkeleyDB.pm
BitKeeper/deleted/.del-BerkeleyDB.pod~e7b18fd6132448e3:
Delete: bdb/perl.BerkeleyDB/BerkeleyDB.pod
BitKeeper/deleted/.del-Hash.pm~10292a26c06a5c95:
Delete: bdb/perl.BerkeleyDB/BerkeleyDB/Hash.pm
BitKeeper/deleted/.del-BerkeleyDB.pod.P~79f76a1495eda203:
Delete: bdb/perl.BerkeleyDB/BerkeleyDB.pod.P
BitKeeper/deleted/.del-BerkeleyDB.xs~80c99afbd98e392c:
Delete: bdb/perl.BerkeleyDB/BerkeleyDB.xs
BitKeeper/deleted/.del-Changes~729c1891efa60de9:
Delete: bdb/perl.BerkeleyDB/Changes
BitKeeper/deleted/.del-MANIFEST~63a1e34aecf157a0:
Delete: bdb/perl.BerkeleyDB/MANIFEST
BitKeeper/deleted/.del-Makefile.PL~c68797707d8df87a:
Delete: bdb/perl.BerkeleyDB/Makefile.PL
BitKeeper/deleted/.del-README~5f2f579b1a241407:
Delete: bdb/perl.BerkeleyDB/README
BitKeeper/deleted/.del-Todo~dca3c66c193adda9:
Delete: bdb/perl.BerkeleyDB/Todo
BitKeeper/deleted/.del-config.in~ae81681e450e0999:
Delete: bdb/perl.BerkeleyDB/config.in
BitKeeper/deleted/.del-dbinfo~28ad67d83be4f68e:
Delete: bdb/perl.BerkeleyDB/dbinfo
BitKeeper/deleted/.del-mkconsts~543ab60669c7a04e:
Delete: bdb/perl.BerkeleyDB/mkconsts
BitKeeper/deleted/.del-mkpod~182c0ca54e439afb:
Delete: bdb/perl.BerkeleyDB/mkpod
BitKeeper/deleted/.del-5.004~e008cb5a48805543:
Delete: bdb/perl.BerkeleyDB/patches/5.004
BitKeeper/deleted/.del-irix_6_5.pl~61662bb08afcdec8:
Delete: bdb/perl.BerkeleyDB/hints/irix_6_5.pl
BitKeeper/deleted/.del-solaris.pl~6771e7182394e152:
Delete: bdb/perl.BerkeleyDB/hints/solaris.pl
BitKeeper/deleted/.del-typemap~783b8f5295b05f3d:
Delete: bdb/perl.BerkeleyDB/typemap
BitKeeper/deleted/.del-5.004_01~6081ce2fff7b0bc:
Delete: bdb/perl.BerkeleyDB/patches/5.004_01
BitKeeper/deleted/.del-5.004_02~87214eac35ad9e6:
Delete: bdb/perl.BerkeleyDB/patches/5.004_02
BitKeeper/deleted/.del-5.004_03~9a672becec7cb40f:
Delete: bdb/perl.BerkeleyDB/patches/5.004_03
BitKeeper/deleted/.del-5.004_04~e326cb51af09d154:
Delete: bdb/perl.BerkeleyDB/patches/5.004_04
BitKeeper/deleted/.del-5.004_05~7ab457a1e41a92fe:
Delete: bdb/perl.BerkeleyDB/patches/5.004_05
BitKeeper/deleted/.del-5.005~f9e2d59b5964cd4b:
Delete: bdb/perl.BerkeleyDB/patches/5.005
BitKeeper/deleted/.del-5.005_01~3eb9fb7b5842ea8e:
Delete: bdb/perl.BerkeleyDB/patches/5.005_01
BitKeeper/deleted/.del-5.005_02~67477ce0bef717cb:
Delete: bdb/perl.BerkeleyDB/patches/5.005_02
BitKeeper/deleted/.del-5.005_03~c4c29a1fb21e290a:
Delete: bdb/perl.BerkeleyDB/patches/5.005_03
BitKeeper/deleted/.del-5.6.0~e1fb9897d124ee22:
Delete: bdb/perl.BerkeleyDB/patches/5.6.0
BitKeeper/deleted/.del-btree.t~e4a1a3c675ddc406:
Delete: bdb/perl.BerkeleyDB/t/btree.t
BitKeeper/deleted/.del-db-3.0.t~d2c60991d84558f2:
Delete: bdb/perl.BerkeleyDB/t/db-3.0.t
BitKeeper/deleted/.del-db-3.1.t~6ee88cd13f55e018:
Delete: bdb/perl.BerkeleyDB/t/db-3.1.t
BitKeeper/deleted/.del-db-3.2.t~f73b6461f98fd1cf:
Delete: bdb/perl.BerkeleyDB/t/db-3.2.t
BitKeeper/deleted/.del-destroy.t~cc6a2ae1980a2ecd:
Delete: bdb/perl.BerkeleyDB/t/destroy.t
BitKeeper/deleted/.del-env.t~a8604a4499c4bd07:
Delete: bdb/perl.BerkeleyDB/t/env.t
BitKeeper/deleted/.del-examples.t~2571b77c3cc75574:
Delete: bdb/perl.BerkeleyDB/t/examples.t
BitKeeper/deleted/.del-examples.t.T~8228bdd75ac78b88:
Delete: bdb/perl.BerkeleyDB/t/examples.t.T
BitKeeper/deleted/.del-examples3.t.T~66a186897a87026d:
Delete: bdb/perl.BerkeleyDB/t/examples3.t.T
BitKeeper/deleted/.del-examples3.t~fe3822ba2f2d7f83:
Delete: bdb/perl.BerkeleyDB/t/examples3.t
BitKeeper/deleted/.del-filter.t~f87b045c1b708637:
Delete: bdb/perl.BerkeleyDB/t/filter.t
BitKeeper/deleted/.del-hash.t~616bfb4d644de3a3:
Delete: bdb/perl.BerkeleyDB/t/hash.t
BitKeeper/deleted/.del-join.t~29fc39f74a83ca22:
Delete: bdb/perl.BerkeleyDB/t/join.t
BitKeeper/deleted/.del-mldbm.t~31f5015341eea040:
Delete: bdb/perl.BerkeleyDB/t/mldbm.t
BitKeeper/deleted/.del-queue.t~8f338034ce44a641:
Delete: bdb/perl.BerkeleyDB/t/queue.t
BitKeeper/deleted/.del-recno.t~d4ddbd3743add63e:
Delete: bdb/perl.BerkeleyDB/t/recno.t
BitKeeper/deleted/.del-strict.t~6885cdd2ea71ca2d:
Delete: bdb/perl.BerkeleyDB/t/strict.t
BitKeeper/deleted/.del-subdb.t~aab62a5d5864c603:
Delete: bdb/perl.BerkeleyDB/t/subdb.t
BitKeeper/deleted/.del-txn.t~65033b8558ae1216:
Delete: bdb/perl.BerkeleyDB/t/txn.t
BitKeeper/deleted/.del-unknown.t~f3710458682665e1:
Delete: bdb/perl.BerkeleyDB/t/unknown.t
BitKeeper/deleted/.del-Changes~436f74a5c414c65b:
Delete: bdb/perl.DB_File/Changes
BitKeeper/deleted/.del-DB_File.pm~ae0951c6c7665a82:
Delete: bdb/perl.DB_File/DB_File.pm
BitKeeper/deleted/.del-DB_File.xs~89e49a0b5556f1d8:
Delete: bdb/perl.DB_File/DB_File.xs
BitKeeper/deleted/.del-DB_File_BS~290fad5dbbb87069:
Delete: bdb/perl.DB_File/DB_File_BS
BitKeeper/deleted/.del-MANIFEST~90ee581572bdd4ac:
Delete: bdb/perl.DB_File/MANIFEST
BitKeeper/deleted/.del-Makefile.PL~ac0567bb5a377e38:
Delete: bdb/perl.DB_File/Makefile.PL
BitKeeper/deleted/.del-README~77e924a5a9bae6b3:
Delete: bdb/perl.DB_File/README
BitKeeper/deleted/.del-config.in~ab4c2792b86a810b:
Delete: bdb/perl.DB_File/config.in
BitKeeper/deleted/.del-dbinfo~461c43b30fab2cb:
Delete: bdb/perl.DB_File/dbinfo
BitKeeper/deleted/.del-dynixptx.pl~50dcddfae25d17e9:
Delete: bdb/perl.DB_File/hints/dynixptx.pl
BitKeeper/deleted/.del-typemap~55cffb3288a9e587:
Delete: bdb/perl.DB_File/typemap
BitKeeper/deleted/.del-version.c~a4df0e646f8b3975:
Delete: bdb/perl.DB_File/version.c
BitKeeper/deleted/.del-5.004_01~d6830d0082702af7:
Delete: bdb/perl.DB_File/patches/5.004_01
BitKeeper/deleted/.del-5.004_02~78b082dc80c91031:
Delete: bdb/perl.DB_File/patches/5.004_02
BitKeeper/deleted/.del-5.004~4411ec2e3c9e008b:
Delete: bdb/perl.DB_File/patches/5.004
BitKeeper/deleted/.del-sco.pl~1e795fe14fe4dcfe:
Delete: bdb/perl.DB_File/hints/sco.pl
BitKeeper/deleted/.del-5.004_03~33f274648b160d95:
Delete: bdb/perl.DB_File/patches/5.004_03
BitKeeper/deleted/.del-5.004_04~8f3d1b3cf18bb20a:
Delete: bdb/perl.DB_File/patches/5.004_04
BitKeeper/deleted/.del-5.004_05~9c0f02e7331e142:
Delete: bdb/perl.DB_File/patches/5.004_05
BitKeeper/deleted/.del-5.005~c2108cb2e3c8d951:
Delete: bdb/perl.DB_File/patches/5.005
BitKeeper/deleted/.del-5.005_01~3b45e9673afc4cfa:
Delete: bdb/perl.DB_File/patches/5.005_01
BitKeeper/deleted/.del-5.005_02~9fe5766bb02a4522:
Delete: bdb/perl.DB_File/patches/5.005_02
BitKeeper/deleted/.del-5.005_03~ffa1c38c19ae72ea:
Delete: bdb/perl.DB_File/patches/5.005_03
BitKeeper/deleted/.del-5.6.0~373be3a5ce47be85:
Delete: bdb/perl.DB_File/patches/5.6.0
BitKeeper/deleted/.del-db-btree.t~3231595a1c241eb3:
Delete: bdb/perl.DB_File/t/db-btree.t
BitKeeper/deleted/.del-db-hash.t~7c4ad0c795c7fad2:
Delete: bdb/perl.DB_File/t/db-hash.t
BitKeeper/deleted/.del-db-recno.t~6c2d3d80b9ba4a50:
Delete: bdb/perl.DB_File/t/db-recno.t
BitKeeper/deleted/.del-db_server.sed~cdb00ebcd48a64e2:
Delete: bdb/rpc_server/db_server.sed
BitKeeper/deleted/.del-db_server_proc.c~d46c8f409c3747f4:
Delete: bdb/rpc_server/db_server_proc.c
BitKeeper/deleted/.del-db_server_svc.sed~3f5e59f334fa4607:
Delete: bdb/rpc_server/db_server_svc.sed
BitKeeper/deleted/.del-db_server_util.c~a809f3a4629acda:
Delete: bdb/rpc_server/db_server_util.c
BitKeeper/deleted/.del-log.tcl~ff1b41f1355b97d7:
Delete: bdb/test/log.tcl
BitKeeper/deleted/.del-mpool.tcl~b0df4dc1b04db26c:
Delete: bdb/test/mpool.tcl
BitKeeper/deleted/.del-mutex.tcl~52fd5c73a150565:
Delete: bdb/test/mutex.tcl
BitKeeper/deleted/.del-txn.tcl~c4ff071550b5446e:
Delete: bdb/test/txn.tcl
BitKeeper/deleted/.del-README~e800a12a5392010a:
Delete: bdb/test/upgrade/README
BitKeeper/deleted/.del-pack-2.6.6.pl~89d5076d758d3e98:
Delete: bdb/test/upgrade/generate-2.X/pack-2.6.6.pl
BitKeeper/deleted/.del-test-2.6.patch~4a52dc83d447547b:
Delete: bdb/test/upgrade/generate-2.X/test-2.6.patch
Diffstat (limited to 'bdb/tcl/docs')
| -rw-r--r-- | bdb/tcl/docs/db.html | 403 | ||||
| -rw-r--r-- | bdb/tcl/docs/env.html | 607 | ||||
| -rw-r--r-- | bdb/tcl/docs/historic.html | 3 | ||||
| -rw-r--r-- | bdb/tcl/docs/index.html | 6 | ||||
| -rw-r--r-- | bdb/tcl/docs/library.html | 3 | ||||
| -rw-r--r-- | bdb/tcl/docs/lock.html | 308 | ||||
| -rw-r--r-- | bdb/tcl/docs/log.html | 24 | ||||
| -rw-r--r-- | bdb/tcl/docs/mpool.html | 3 | ||||
| -rw-r--r-- | bdb/tcl/docs/rep.html | 51 | ||||
| -rw-r--r-- | bdb/tcl/docs/test.html | 3 | ||||
| -rw-r--r-- | bdb/tcl/docs/txn.html | 93 |
11 files changed, 812 insertions, 692 deletions
diff --git a/bdb/tcl/docs/db.html b/bdb/tcl/docs/db.html index c75ab6ecf4f..4f04c2c4f96 100644 --- a/bdb/tcl/docs/db.html +++ b/bdb/tcl/docs/db.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> @@ -8,184 +9,154 @@ <H2> <A NAME="Database Commands"></A>Database Commands</H2> -The database commands provide a conduit into the DB method functions. -They are all fairly straightforward and I describe them in terms of their -DB functions briefly here, with a link to the DB page where appropriate. -The first set of commands are those I believe will be the primary functions -used by most databases. Some are directly related to their DB counterparts, -and some are higher level functions that are useful to provide the user. -<P><B>> berkdb open [-env <I>env</I>]</B> -<BR><B> [-btree|-hash|-recno|-queue|-unknown]</B> -<BR><B> [-create] [-excl] [-nommap] [-rdonly] [-truncate] -[-mode -<I>mode</I>] [-errfile <I>filename</I>]</B> -<BR><B> [-dup] [-dupsort] [-recnum] [-renumber] [-revsplitoff] -[-snapshot]</B> -<BR><B> [-extent <I>size</I>]</B> -<BR><B> [-ffactor <I>density</I>]</B> -<BR><B> [-nelem <I>size</I>]</B> -<BR><B> [-lorder <I>order</I>]</B> -<BR><B> [-delim <I>delim</I>]</B> -<BR><B> [-len <I>len</I>]</B> -<BR><B> [-pad <I>pad</I>]</B> -<BR><B> [-source <I>file</I>]</B> -<BR><B> [-minkey <I>minkey</I>]</B> -<BR><B> [-cachesize {<I>gbytes bytes ncaches</I>}]</B> -<BR><B> [-pagesize <I>pagesize</I>]</B> -<BR><B> [--]</B> -<BR><B> [<I>filename </I>[<I>subdbname</I>]]</B> -<P>This command will invoke the <A HREF="../../docs/api_c/db_create.html">db_create</A> -function. If the command is given the <B>-env</B> option, then we -will accordingly creating the database within the context of that environment. -After it successfully gets a handle to a database, we bind it to a new -Tcl command of the form <B><I>dbX, </I></B>where X is an integer starting -at 0 (e.g. <B>db0, db1, </B>etc). We use the <I>Tcl_CreateObjCommand() </I> -to create the top level database function. It is through this handle -that the user can access all of the commands described in the <A HREF="#Database Commands">Database -Commands</A> section. Internally, the database handle is sent as -the <I>ClientData</I> portion of the new command set so that all future -database calls access the appropriate handle. -<P>After parsing all of the optional arguments affecting the setup of the -database and making the appropriate calls to DB to manipulate those values, -we open the database for the user. It translates to the -<A HREF="../../docs/api_c/db_open.html">DB->open</A> -method call after parsing all of the various optional arguments. -We automatically set the DB_THREAD flag. The arguments are: -<UL> -<LI> -<B>-- </B>- Terminate the list of options and use remaining arguments as -the file or subdb names (thus allowing the use of filenames beginning with -a dash '-')</LI> - -<LI> -<B>-btree</B> - DB_BTREE database</LI> - -<LI> -<B>-hash</B> - DB_HASH database</LI> - -<LI> -<B>-recno </B> - DB_RECNO database</LI> - -<LI> -<B>-queue</B> - DB_QUEUE database</LI> - -<LI> -<B>-create</B> selects the DB_CREATE flag to create underlying files</LI> - -<LI> -<B>-excl</B> selects the DB_EXCL flag to exclusively create underlying -files</LI> - -<LI> -<B>-nommap</B> selects the DB_NOMMAP flag to forbid mmaping of files</LI> - -<LI> -<B>-rdonly</B> selects the DB_RDONLY flag for opening in read-only mode</LI> - -<LI> -<B>-truncate</B> selects the DB_TRUNCATE flag to truncate the database</LI> - -<LI> -<B>-mode<I> mode</I></B> specifies the mode for created files</LI> - -<LI> -<B>-errfile </B>specifies the error file to use for this environment to -<B><I>filename</I></B> -by calling <A HREF="../../docs/api_c/db_set_errfile.html">DB->set_errfile</A><B><I>. -</I></B>If -the file already exists then we will append to the end of the file</LI> - -<LI> -<B>-dup </B>selects the DB_DUP flag to permit duplicates in the database</LI> - -<LI> -<B>-dupsort</B> selects the DB_DUPSORT flag to support sorted duplicates</LI> - -<LI> -<B>-recnum</B> selects the DB_RECNUM flag to support record numbers in -btrees</LI> - -<LI> -<B>-renumber </B>selects the DB_RENUMBER flag to support mutable record -numbers</LI> +The database commands provide a fairly straightforward mapping to the +DB method functions. -<LI> -<B>-revsplitoff </B>selects the DB_REVSPLITOFF flag to suppress reverse -splitting of pages on deletion</LI> - -<LI> -<B>-snapshot </B>selects the DB_SNAPSHOT flag to support database snapshots</LI> - -<LI> -<B>-extent </B>sets the size of a Queue database extent to the given <B><I>size -</I></B>using -the <A HREF="../../docs/api_c/db_set_q_extentsize.html">DB->set_q_extentsize</A> -method</LI> - -<LI> -<B>-ffactor</B> sets the hash table key density to the given <B><I>density -</I></B>using -the <A HREF="../../docs/api_c/db_set_h_ffactor.html">DB->set_h_ffactor</A> -method</LI> - -<LI> -<B>-nelem </B>sets the hash table size estimate to the given <B><I>size -</I></B>using -the <A HREF="../../docs/api_c/db_set_h_nelem.html">DB->set_h_nelem</A> -method</LI> - -<LI> -<B>-lorder </B>sets the byte order for integers stored in the database -meta-data to the given <B><I>order</I></B> using the <A HREF="../../docs/api_c/db_set_lorder.html">DB->set_lorder</A> -method</LI> - -<LI> -<B>-delim </B>sets the delimiting byte for variable length records to -<B><I>delim</I></B> -using the <A HREF="../../docs/api_c/db_set_re_delim.html">DB->set_re_delim</A> -method</LI> - -<LI> -<B>-len </B>sets the length of fixed-length records to <B><I>len</I></B> -using the <A HREF="../../docs/api_c/db_set_re_len.html">DB->set_re_len</A> -method</LI> - -<LI> -<B>-pad </B>sets the pad character used for fixed length records to -<B><I>pad</I></B> -using the <A HREF="../../docs/db_set_re_pad.html">DB->set_re_pad</A> method</LI> - -<LI> -<B>-source </B>sets the backing source file name to <B><I>file</I></B> -using the <A HREF="../../docs/api_c/db_set_re_source.html">DB->set_re_source</A> -method</LI> - -<LI> -<B>-minkey </B>sets the minimum number of keys per Btree page to <B><I>minkey</I></B> -using the <A HREF="../../docs/api_c/db_set_bt_minkey.html">DB->set_bt_minkey</A> -method</LI> - -<LI> -<B>-cachesize </B>sets the size of the database cache to the size -specified by <B><I>gbytes </I></B>and <B><I>bytes, </I></B>broken up into -<B><I>ncaches</I></B> -number of caches using the <A HREF="../../docs/api_c/db_set_cachesize.html">DB->set_cachesize</A> -method</LI> - -<LI> -<B>-pagesize </B>sets the size of the database page to <B><I>pagesize </I></B>using -the <A HREF="../../docs/api_c/db_set_pagesize.html">DB->set_pagesize</A> -method</LI> - -<LI> -<B><I>filename</I></B> indicates the name of the database</LI> - -<LI> -<B><I>subdbname</I></B> indicate the name of the sub-database</LI> -</UL> +<P> +<B>> berkdb open</B> +<dl> + +<dt><B>[-btcompare <I>proc</I>]</B><dd> +Sets the Btree comparison function to the Tcl procedure named +<I>proc</I> using the +<A HREF="../../docs/api_c/db_set_bt_compare.html">DB->set_bt_compare</A> +method. + +<dt><B>[-btree|-hash|-recno|-queue|-unknown]</B><dd> +</td><td> +Select the database type:<br> +DB_BTREE, DB_HASH, DB_RECNO, DB_QUEUE or DB_UNKNOWN. + + +<dt><B>[-cachesize {<I>gbytes bytes ncaches</I>}]</B><dd> +Sets the size of the database cache to the size specified by +<I>gbytes</I> and <I>bytes</I>, broken up into <I>ncaches</I> number of +caches using the +<A HREF="../../docs/api_c/db_set_cachesize.html">DB->set_cachesize</A> +method. + +<dt><B>[-create]</B><dd> +Selects the DB_CREATE flag to create underlying files. + +<dt><B>[-delim <I>delim</I>]</B><dd> +Sets the delimiting byte for variable length records to <I>delim</I> +using the +<A HREF="../../docs/api_c/db_set_re_delim.html">DB->set_re_delim</A> +method. + +<dt><B>[-dup]</B><dd> +Selects the DB_DUP flag to permit duplicates in the database. + +<dt><B>[-dupcompare <I>proc</I>]</B><dd> +Sets the duplicate data comparison function to the Tcl procedure named +<I>proc</I> using the +<A HREF="../../docs/api_c/db_set_dup_compare.html">DB->set_dup_compare</A> +method. + +<dt><B>[-dupsort]</B><dd> +Selects the DB_DUPSORT flag to support sorted duplicates. + +<dt><B>[-env <I>env</I>]</B><dd> +The database environment. + +<dt><B>[-errfile <I>filename</I>]</B><dd> +Specifies the error file to use for this environment to <I>filename</I> +by calling +<A HREF="../../docs/api_c/db_set_errfile.html">DB->set_errfile</A>. +If the file already exists then we will append to the end of the file. + +<dt><B>[-excl]</B><dd> +Selects the DB_EXCL flag to exclusively create underlying files. + +<dt><B>[-extent <I>size</I>]</B><dd> +Sets the size of a Queue database extent to the given <I>size</I> using +the +<A HREF="../../docs/api_c/db_set_q_extentsize.html">DB->set_q_extentsize</A> +method. + +<dt><B>[-ffactor <I>density</I>]</B><dd> +Sets the hash table key density to the given <I>density</I> using the +<A HREF="../../docs/api_c/db_set_h_ffactor.html">DB->set_h_ffactor</A> +method. + +<dt><B>[-hashproc <I>proc</I>]</B><dd> +Sets a user-defined hash function to the Tcl procedure named <I>proc</I> +using the +<A HREF="../../docs/api_c/db_set_h_hash.html">DB->set_h_hash</A> method. + +<dt><B>[-len <I>len</I>]</B><dd> +Sets the length of fixed-length records to <I>len</I> using the +<A HREF="../../docs/api_c/db_set_re_len.html">DB->set_re_len</A> +method. + +<dt><B>[-lorder <I>order</I>]</B><dd> +Sets the byte order for integers stored in the database meta-data to +the given <I>order</I> using the +<A HREF="../../docs/api_c/db_set_lorder.html">DB->set_lorder</A> +method. + +<dt><B>[-minkey <I>minkey</I>]</B><dd> +Sets the minimum number of keys per Btree page to <I>minkey</I> using +the +<A HREF="../../docs/api_c/db_set_bt_minkey.html">DB->set_bt_minkey</A> +method. + +<dt><B>[-mode <I>mode</I>]</B><dd> +Specifies the mode for created files. + +<dt><B>[-nelem <I>size</I>]</B><dd> +Sets the hash table size estimate to the given <I>size</I> using the +<A HREF="../../docs/api_c/db_set_h_nelem.html">DB->set_h_nelem</A> +method. + +<dt><B>[-nommap]</B><dd> +Selects the DB_NOMMAP flag to forbid mmaping of files. + +<dt><B>[-pad <I>pad</I>]</B><dd> +Sets the pad character used for fixed length records to <I>pad</I> using +the +<A HREF="../../docs/db_set_re_pad.html">DB->set_re_pad</A> method. + +<dt><B>[-pagesize <I>pagesize</I>]</B><dd> +Sets the size of the database page to <I>pagesize</I> using the +<A HREF="../../docs/api_c/db_set_pagesize.html">DB->set_pagesize</A> +method. + +<dt><B>[-rdonly]</B><dd> +Selects the DB_RDONLY flag for opening in read-only mode. + +<dt><B>[-recnum]</B><dd> +Selects the DB_RECNUM flag to support record numbers in Btrees. + +<dt><B>[-renumber]</B><dd> +Selects the DB_RENUMBER flag to support mutable record numbers. + +<dt><B>[-revsplitoff]</B><dd> +Selects the DB_REVSPLITOFF flag to suppress reverse splitting of pages +on deletion. + +<dt><B>[-snapshot]</B><dd> +Selects the DB_SNAPSHOT flag to support database snapshots. + +<dt><B>[-source <I>file</I>]</B><dd> +Sets the backing source file name to <I>file</I> using the +<A HREF="../../docs/api_c/db_set_re_source.html">DB->set_re_source</A> +method. + +<dt><B>[-truncate]</B><dd> +Selects the DB_TRUNCATE flag to truncate the database. + +<dt><B>[--]</B><dd> +Terminate the list of options and use remaining arguments as the file +or subdb names (thus allowing the use of filenames beginning with a dash +'-'). + +<dt><B>[<I>filename </I>[<I>subdbname</I>]]</B><dd> +The names of the database and sub-database. +</dl> <HR WIDTH="100%"> -<BR><B> berkdb upgrade [-dupsort] [-env <I>env</I>] [--] [<I>filename</I>]</B> +<B>> berkdb upgrade [-dupsort] [-env <I>env</I>] [--] [<I>filename</I>]</B> <P>This command will invoke the <A HREF="../../docs/api_c/db_upgrade.html">DB->upgrade</A> function. If the command is given the <B>-env</B> option, then we will accordingly upgrade the database filename within the context of that @@ -193,14 +164,21 @@ environment. The <B>-dupsort</B> option selects the DB_DUPSORT flag for upgrading. The use of --<B> </B>terminates the list of options, thus allowing filenames beginning with a dash. <P> -<HR WIDTH="100%"><B>> berkdb verify [-env <I>env</I>] [--] [<I>filename</I>]</B> + +<HR WIDTH="100%"> +<B>> berkdb verify [-env <I>env</I>] [--] [<I>filename</I>]</B> <P>This command will invoke the <A HREF="../../docs/api_c/db_verify.html">DB->verify</A> function. If the command is given the <B>-env</B> option, then we will accordingly verify the database filename within the context of that environment. The use of --<B> </B>terminates the list of options, thus allowing filenames beginning with a dash. <P> -<HR WIDTH="100%"><B>> <I>db</I> join [-nosort] <I>db0.c0 db1.c0</I> ...</B> + +<HR WIDTH="100%"><B>> <I>db</I> del</B> +<P>There are no undocumented options. + +<HR WIDTH="100%"> +<B>> <I>db</I> join [-nosort] <I>db0.c0 db1.c0</I> ...</B> <P>This command will invoke the <A HREF="../../docs/api_c/db_join.html">db_join</A> function. After it successfully joins a database, we bind it to a new Tcl command of the form <B><I>dbN.cX, </I></B>where X is an integer @@ -215,7 +193,33 @@ number of data items they reference. It results in the DB_JOIN_NOSORT flag being set.</LI> </UL> -<HR WIDTH="100%"><B>> <I>db</I> get_join [-nosort] {db key} {db key} ...</B> +<P> +This command will invoke the +<A HREF="../../docs/api_c/db_create.html">db_create</A> function. If +the command is given the <B>-env</B> option, then we will accordingly +creating the database within the context of that environment. After it +successfully gets a handle to a database, we bind it to a new Tcl +command of the form <B><I>dbX, </I></B>where X is an integer starting +at 0 (e.g. <B>db0, db1, </B>etc). + +<p> +We use the <I>Tcl_CreateObjCommand()</I> to create the top level +database function. It is through this handle that the user can access +all of the commands described in the <A HREF="#Database Commands"> +Database Commands</A> section. Internally, the database handle +is sent as the <I>ClientData</I> portion of the new command set so that +all future database calls access the appropriate handle. + +<P> +After parsing all of the optional arguments affecting the setup of the +database and making the appropriate calls to DB to manipulate those +values, we open the database for the user. It translates to the +<A HREF="../../docs/api_c/db_open.html">DB->open</A> method call after +parsing all of the various optional arguments. We automatically set the +DB_THREAD flag. The arguments are: + +<HR WIDTH="100%"> +<B>> <I>db</I> get_join [-nosort] {db key} {db key} ...</B> <P>This command performs a join operation on the keys specified and returns a list of the joined {key data} pairs. <P>The options are: @@ -226,41 +230,34 @@ number of data items they reference. It results in the DB_JOIN_NOSORT flag being set.</LI> </UL> -<HR WIDTH="100%"><B>> <I>db</I> keyrange [-txn <I>id</I>] key</B> +<HR WIDTH="100%"> +<B>> <I>db</I> keyrange [-txn <I>id</I>] key</B> <P>This command returns the range for the given <B>key</B>. It returns a list of 3 double elements of the form {<B><I>less equal greater</I></B>} where <B><I>less</I></B> is the percentage of keys less than the given key, <B><I>equal</I></B> is the percentage equal to the given key and <B><I>greater</I></B> is the percentage greater than the given key. If the -txn option is specified it performs this operation under transaction protection. -<BR> -<HR WIDTH="100%"><B>> <I>db</I> put</B> -<P>The <B>undocumented</B> options are: -<UL> -<LI> -<B>-nodupdata</B> This flag causes DB not to insert the key/data pair if -it already exists, that is, both the key and data items are already in -the database. The -nodupdata flag may only be specified if the underlying -database has been configured to support sorted duplicates.</LI> -</UL> -<HR WIDTH="100%"><B>> <I>db</I> stat</B> +<HR WIDTH="100%"><B>> <I>db</I> put</B> <P>The <B>undocumented</B> options are: -<UL> -<LI> -<B>-cachedcounts</B> This flag causes DB to return the cached key/record -counts, similar to the DB_CACHED_COUNTS flags to DB->stat.</LI> -</UL> +<dl> +<dt><B>-nodupdata</B><dd> +This flag causes DB not to insert the key/data pair if it already +exists, that is, both the key and data items are already in the +database. The -nodupdata flag may only be specified if the underlying +database has been configured to support sorted duplicates. +</dl> <HR WIDTH="100%"><B>> <I>dbc</I> put</B> <P>The <B>undocumented</B> options are: -<UL> -<LI> -<B>-nodupdata</B> This flag causes DB not to insert the key/data pair if -it already exists, that is, both the key and data items are already in -the database. The -nodupdata flag may only be specified if the underlying -database has been configured to support sorted duplicates.</LI> -</UL> +<dl> +<dt><B>-nodupdata</B><dd> +This flag causes DB not to insert the key/data pair if it already +exists, that is, both the key and data items are already in the +database. The -nodupdata flag may only be specified if the underlying +database has been configured to support sorted duplicates. +</dl> </BODY> </HTML> diff --git a/bdb/tcl/docs/env.html b/bdb/tcl/docs/env.html index a1bd08fd163..79c349841ac 100644 --- a/bdb/tcl/docs/env.html +++ b/bdb/tcl/docs/env.html @@ -1,303 +1,354 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<HTML> -<HEAD> - <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> - <META NAME="GENERATOR" CONTENT="Mozilla/4.08 [en] (X11; I; FreeBSD 3.3-RELEASE i386) [Netscape]"> -</HEAD> -<BODY> - -<H2> -Environment Commands</H2> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.75 [en] (X11; U; Linux 2.2.16-22 i686) [Netscape]"> +</head> +<body> + +<h2> +Environment Commands</h2> Environments provide a structure for creating a consistent environment for processes using one or more of the features of Berkeley DB. Unlike some of the database commands, the environment commands are very low level. -<BR> -<HR WIDTH="100%"> -<P>The user may create and open a new DB environment by invoking: -<P><B>> berkdb env</B> -<BR><B> [-cdb] [-cdb_alldb] [-lock] [-log] [-txn [nosync]]</B> -<BR><B> [-create] [-home<I> directory</I>] [-mode <I>mode</I>]</B> -<BR><B> [-data_dir <I>directory</I>] [-log_dir <I>directory</I>] -[-tmp_dir <I>directory</I>]</B> -<BR><B> [-nommap] [-private] [-recover] [-recover_fatal] -[-system_mem] [-errfile <I>filename</I>]</B> -<BR><B> [-use_environ] [-use_environ_root] [-verbose -{<I>which </I>on|off}]</B> -<BR><B> [-region_init]</B> -<BR><B> [-cachesize {<I>gbytes bytes ncaches</I>}]</B> -<BR><B> [-mmapsize<I> size</I>]</B> -<BR><B> [-log_max <I>max</I>]</B> -<BR><B> [-log_buffer <I>size</I>]</B> -<BR><B> [-lock_conflict {<I>nmodes </I>{<I>matrix</I>}}]</B> -<BR><B> [-lock_detect default|oldest|random|youngest]</B> -<BR><B> [-lock_max <I>max</I>]</B> -<BR><B> [-lock_max_locks <I>max</I>]</B> -<BR><B> [-lock_max_lockers <I>max</I>]</B> -<BR><B> [-lock_max_objects <I>max</I>]</B> -<BR><B> [-txn_max <I>max</I>]</B> -<BR><B> [-client_timeout <I>seconds</I>]</B> -<BR><B> [-server_timeout <I>seconds</I>]</B> -<BR><B> [-server <I>hostname</I>]</B> -<BR> -<P>This command opens up an environment. We automatically set +<br> +<hr WIDTH="100%"> +<p>The user may create and open a new DB environment by invoking: +<p><b>> berkdb env</b> +<br><b> [-cdb] [-cdb_alldb] [-lock] [-log] [-txn [nosync]]</b> +<br><b> [-create] [-home<i> directory</i>] [-mode <i>mode</i>]</b> +<br><b> [-data_dir <i>directory</i>] [-log_dir <i>directory</i>] +[-tmp_dir <i>directory</i>]</b> +<br><b> [-nommap] [-private] [-recover] [-recover_fatal] +[-system_mem] [-errfile <i>filename</i>]</b> +<br><b> [-use_environ] [-use_environ_root] [-verbose +{<i>which </i>on|off}]</b> +<br><b> [-region_init]</b> +<br><b> [-cachesize {<i>gbytes bytes ncaches</i>}]</b> +<br><b> [-mmapsize<i> size</i>]</b> +<br><b> [-log_max <i>max</i>]</b> +<br><b> [-log_buffer <i>size</i>]</b> +<br><b> [-lock_conflict {<i>nmodes </i>{<i>matrix</i>}}]</b> +<br><b> [-lock_detect default|oldest|random|youngest]</b> +<br><b> [-lock_max <i>max</i>]</b> +<br><b> [-lock_max_locks <i>max</i>]</b> +<br><b> [-lock_max_lockers <i>max</i>]</b> +<br><b> [-lock_max_objects <i>max</i>]</b> +<br><b> [-lock_timeout <i>timeout</i>]</b> +<br><b> [-overwrite]</b> +<br><b> [-txn_max <i>max</i>]</b> +<br><b> [-txn_timeout <i>timeout</i>]</b> +<br><b> [-client_timeout <i>seconds</i>]</b> +<br><b> [-server_timeout <i>seconds</i>]</b> +<br><b> [-server <i>hostname</i>]</b> +<br><b> [-rep_master] [-rep_client]</b> +<br><b> [-rep_transport <i>{ machineid sendproc }</i>]</b> +<br> +<p>This command opens up an environment. We automatically set the DB_THREAD and the DB_INIT_MPOOL flags. The arguments are: -<UL> -<LI> -<B>-cdb</B> selects the DB_INIT_CDB flag for Concurrent Data Store</LI> - -<LI> -<B>-cdb_alldb</B> selects the DB_CDB_ALLDB flag for Concurrent Data Store</LI> - -<LI> -<B>-lock</B> selects the DB_INIT_LOCK flag for the locking subsystem</LI> - -<LI> -<B>-log</B> selects the DB_INIT_LOG flag for the logging subsystem</LI> - -<LI> -<B>-txn</B> selects the DB_INIT_TXN, DB_INIT_LOCK and DB_INIT_LOG flags -for the transaction subsystem. If <B>nosync</B> is specified, then -it will also select DB_TXN_NOSYNC to indicate no flushes of log on commits</LI> - -<LI> -<B>-create </B>selects the DB_CREATE flag to create underlying files</LI> - -<LI> -<B>-home <I>directory </I></B>selects the home directory of the environment</LI> - -<LI> -<B>-data_dir <I>directory </I></B>selects the data file directory of the -environment by calling <A HREF="../../docs/api_c/env_set_data_dir.html">DBENV->set_data_dir</A>.</LI> - -<LI> -<B>-log_dir <I>directory </I></B>selects the log file directory of the -environment by calling <A HREF="../../docs/api_c/env_set_lg_dir.html">DBENV->set_lg_dir</A>.</LI> - -<LI> -<B>-tmp_dir <I>directory </I></B>selects the temporary file directory of -the environment by calling <A HREF="../../docs/api_c/env_set_tmp_dir.so">DBENV->set_tmp_dir</A>.</LI> - -<LI> -<B>-mode <I>mode </I></B>sets the permissions of created files to <B><I>mode</I></B></LI> - -<LI> -<B>-nommap</B> selects the DB_NOMMAP flag to disallow using mmap'ed files</LI> - -<LI> -<B>-private</B> selects the DB_PRIVATE flag for a private environment</LI> - -<LI> -<B>-recover</B> selects the DB_RECOVER flag for recovery</LI> - -<LI> -<B>-recover_fatal</B> selects the DB_RECOVER_FATAL flag for catastrophic -recovery</LI> - -<LI> -<B>-system_mem</B> selects the DB_SYSTEM_MEM flag to use system memory</LI> - -<LI> -<B>-errfile </B>specifies the error file to use for this environment to -<B><I>filename</I></B> -by calling <A HREF="../../docs/api_c/env_set_errfile.html">DBENV->set_errfile</A><B><I>. -</I></B>If -the file already exists then we will append to the end of the file</LI> - -<LI> -<B>-use_environ</B> selects the DB_USE_ENVIRON flag to affect file naming</LI> - -<LI> -<B>-use_environ_root</B> selects the DB_USE_ENVIRON_ROOT flag to have the -root environment affect file naming</LI> - -<LI> -<B>-verbose</B> produces verbose error output for the given which subsystem, -using the <A HREF="../../docs/api_c/dbenv_set_verbose.html">DBENV->set_verbose</A> -method. See the description of <A HREF="#> <env> verbose which on|off">verbose</A> -below for valid <B><I>which </I></B>values</LI> - -<LI> -<B>-region_init </B>specifies that the user wants to page fault the region -in on startup using the <A HREF="../../docs/api_c/env_set_region_init.html">DBENV->set_region_init</A> -method call</LI> - -<LI> -<B>-cachesize </B>sets the size of the database cache to the size -specified by <B><I>gbytes </I></B>and <B><I>bytes, </I></B>broken up into -<B><I>ncaches</I></B> -number of caches using the <A HREF="../../docs/api_c/env_set_cachesize.html">DBENV->set_cachesize</A> -method</LI> - -<LI> -<B>-mmapsize </B>sets the size of the database page to <B><I>size </I></B>using -the <A HREF="../../docs/api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</A> -method</LI> - -<LI> -<B>-log_max </B>sets the maximum size of the log file to <B><I>max</I></B> -using the <A HREF="../../docs/api_c/env_set_lg_max.html">DBENV->set_lg_max</A> -call</LI> - -<LI> -<B>-log_buffer </B>sets the size of the log file in bytes to <B><I>size</I></B> -using the <A HREF="../../docs/api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</A> -call</LI> - -<LI> -<B>-lock_conflict </B>sets the number of lock modes to <B><I>nmodes</I></B> -and sets the locking policy for those modes to the <B><I>conflict_matrix</I></B> -given using the <A HREF="../../docs/api_c/env_set_lk_conflict.html">DBENV->set_lk_conflict</A> -method call</LI> - -<LI> -<B>-lock_detect </B>sets the deadlock detection policy to the given policy -using the <A HREF="../../docs/env_set_lk_detect.html">DBENV->set_lk_detect</A> -method call. The policy choices are:</LI> - -<UL> -<LI> -<B>default</B> selects the DB_LOCK_DEFAULT policy for default detection</LI> - -<LI> -<B>oldest </B>selects DB_LOCK_OLDEST to abort the oldest locker on a deadlock</LI> - -<LI> -<B>random</B> selects DB_LOCK_RANDOM to abort a random locker on a deadlock</LI> - -<LI> -<B>youngest</B> selects DB_LOCK_YOUNGEST to abort the youngest locker on -a deadlock</LI> -</UL> - -<LI> -<B>-lock_max </B>sets the maximum size of the lock table to <B><I>max </I></B>using -the <A HREF="../../docs/api_c/env_set_lk_max.html">DBENV->set_lk_max</A> -method call</LI> - -<LI> -<B>-lock_max_locks </B>sets the maximum number of locks to <B><I>max </I></B>using -the <A HREF="../../docs/api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</A> -method call</LI> - -<LI> -<B>-lock_max_lockers </B>sets the maximum number of locking entities to -<B><I>max </I></B>using the <A HREF="../../docs/api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</A> -method call</LI> - -<LI> -<B>-lock_max_objects </B>sets the maximum number of simultaneously locked -objects to <B><I>max </I></B>using the <A HREF="../../docs/api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</A> -method call</LI> - -<LI> -<B>-txn_max </B>sets the maximum size of the transaction table to <B><I>max</I></B> -using the <A HREF="../../docs/api_c/env_set_txn_max.html">DBENV->set_txn_max</A> -method call</LI> - -<LI> -<B>-client_timeout</B> sets the timeout value for the client waiting for -a reply from the server for RPC operations to <B><I>seconds</I></B>.</LI> - -<LI> -<B>-server_timeout</B> sets the timeout value for the server to determine -an idle client is gone to <B><I>seconds</I></B>.</LI> - -<LI> -<B> -server </B>specifies the <B><I>hostname</I></B> of the server -to connect to in the <A HREF="../../docs/api_c/env_set_server.html">DBENV->set_server</A> -call.</LI> -</UL> -This command will invoke the <A HREF="../../docs/api_c/env_create.html">db_env_create</A> +<ul> +<li> +<b>-cdb</b> selects the DB_INIT_CDB flag for Concurrent Data Store</li> + +<li> +<b>-cdb_alldb</b> selects the DB_CDB_ALLDB flag for Concurrent Data Store</li> + +<li> +<b>-lock</b> selects the DB_INIT_LOCK flag for the locking subsystem</li> + +<li> +<b>-log</b> selects the DB_INIT_LOG flag for the logging subsystem</li> + +<li> +<b>-txn</b> selects the DB_INIT_TXN, DB_INIT_LOCK and DB_INIT_LOG flags +for the transaction subsystem. If <b>nosync</b> is specified, then +it will also select DB_TXN_NOSYNC to indicate no flushes of log on commits</li> + +<li> +<b>-create </b>selects the DB_CREATE flag to create underlying files</li> + +<li> +<b>-home <i>directory </i></b>selects the home directory of the environment</li> + +<li> +<b>-data_dir <i>directory </i></b>selects the data file directory of the +environment by calling <a href="../../docs/api_c/env_set_data_dir.html">DBENV->set_data_dir</a>.</li> + +<li> +<b>-log_dir <i>directory </i></b>selects the log file directory of the +environment by calling <a href="../../docs/api_c/env_set_lg_dir.html">DBENV->set_lg_dir</a>.</li> + +<li> +<b>-tmp_dir <i>directory </i></b>selects the temporary file directory of +the environment by calling <a href="../../docs/api_c/env_set_tmp_dir.so">DBENV->set_tmp_dir</a>.</li> + +<li> +<b>-mode <i>mode </i></b>sets the permissions of created files to <b><i>mode</i></b></li> + +<li> +<b>-nommap</b> selects the DB_NOMMAP flag to disallow using mmap'ed files</li> + +<li> +<b>-private</b> selects the DB_PRIVATE flag for a private environment</li> + +<li> +<b>-recover</b> selects the DB_RECOVER flag for recovery</li> + +<li> +<b>-recover_fatal</b> selects the DB_RECOVER_FATAL flag for catastrophic +recovery</li> + +<li> +<b>-system_mem</b> selects the DB_SYSTEM_MEM flag to use system memory</li> + +<li> +<b>-errfile </b>specifies the error file to use for this environment to +<b><i>filename</i></b> +by calling <a href="../../docs/api_c/env_set_errfile.html">DBENV->set_errfile</a><b><i>. +</i></b>If +the file already exists then we will append to the end of the file</li> + +<li> +<b>-use_environ</b> selects the DB_USE_ENVIRON flag to affect file naming</li> + +<li> +<b>-use_environ_root</b> selects the DB_USE_ENVIRON_ROOT flag to have the +root environment affect file naming</li> + +<li> +<b>-verbose</b> produces verbose error output for the given which subsystem, +using the <a href="../../docs/api_c/dbenv_set_verbose.html">DBENV->set_verbose</a> +method. See the description of <a href="#> <env> verbose which on|off">verbose</a> +below for valid <b><i>which </i></b>values</li> + +<li> +<b>-region_init </b>specifies that the user wants to page fault the region +in on startup using the <a href="../../docs/api_c/env_set_region_init.html">DBENV->set_region_init</a> +method call</li> + +<li> +<b>-cachesize </b>sets the size of the database cache to the size +specified by <b><i>gbytes </i></b>and <b><i>bytes, </i></b>broken up into +<b><i>ncaches</i></b> +number of caches using the <a href="../../docs/api_c/env_set_cachesize.html">DBENV->set_cachesize</a> +method</li> + +<li> +<b>-mmapsize </b>sets the size of the database page to <b><i>size </i></b>using +the <a href="../../docs/api_c/env_set_mp_mmapsize.html">DBENV->set_mp_mmapsize</a> +method</li> + +<li> +<b>-log_max </b>sets the maximum size of the log file to <b><i>max</i></b> +using the <a href="../../docs/api_c/env_set_lg_max.html">DBENV->set_lg_max</a> +call</li> + +<li> +<b>-log_regionmax </b>sets the size of the log region to <b><i>max</i></b> +using the <a href="../../docs/api_c/env_set_lg_regionmax.html">DBENV->set_lg_regionmax</a> +call</li> + +<li> +<b>-log_buffer </b>sets the size of the log file in bytes to <b><i>size</i></b> +using the <a href="../../docs/api_c/env_set_lg_bsize.html">DBENV->set_lg_bsize</a> +call</li> + +<li> +<b>-lock_conflict </b>sets the number of lock modes to <b><i>nmodes</i></b> +and sets the locking policy for those modes to the <b><i>conflict_matrix</i></b> +given using the <a href="../../docs/api_c/env_set_lk_conflict.html">DBENV->set_lk_conflict</a> +method call</li> + +<li> +<b>-lock_detect </b>sets the deadlock detection policy to the given policy +using the <a href="../../docs/env_set_lk_detect.html">DBENV->set_lk_detect</a> +method call. The policy choices are:</li> + +<ul> +<li> +<b>default</b> selects the DB_LOCK_DEFAULT policy for default detection</li> + +<li> +<b>oldest </b>selects DB_LOCK_OLDEST to abort the oldest locker on a deadlock</li> + +<li> +<b>random</b> selects DB_LOCK_RANDOM to abort a random locker on a deadlock</li> + +<li> +<b>youngest</b> selects DB_LOCK_YOUNGEST to abort the youngest locker on +a deadlock</li> +</ul> + +<li> +<b>-lock_max </b>sets the maximum size of the lock table to <b><i>max </i></b>using +the <a href="../../docs/api_c/env_set_lk_max.html">DBENV->set_lk_max</a> +method call</li> + +<li> +<b>-lock_max_locks </b>sets the maximum number of locks to <b><i>max </i></b>using +the <a href="../../docs/api_c/env_set_lk_max_locks.html">DBENV->set_lk_max_locks</a> +method call</li> + +<li> +<b>-lock_max_lockers </b>sets the maximum number of locking entities to +<b><i>max +</i></b>using the <a href="../../docs/api_c/env_set_lk_max_lockers.html">DBENV->set_lk_max_lockers</a> +method call</li> + +<li> +<b>-lock_max_objects </b>sets the maximum number of simultaneously locked +objects to <b><i>max </i></b>using the <a href="../../docs/api_c/env_set_lk_max_objects.html">DBENV->set_lk_max_objects</a> +method call</li> + +<li> +<b>-lock_timeout </b>sets the timeout for locks in the environment</li> + +<li> +<b>-overwrite </b>sets DB_OVERWRITE flag</li> + +<li> +<b>-txn_max </b>sets the maximum size of the transaction table to <b><i>max</i></b> +using the <a href="../../docs/api_c/env_set_txn_max.html">DBENV->set_txn_max</a> +method call</li> + +<li> +<b>-txn_timeout </b>sets the timeout for transactions in the environment</li> + +<li> +<b>-client_timeout</b> sets the timeout value for the client waiting for +a reply from the server for RPC operations to <b><i>seconds</i></b>.</li> + +<li> +<b>-server_timeout</b> sets the timeout value for the server to determine +an idle client is gone to <b><i>seconds</i></b>.</li> + +<li> +<b>-server </b>specifies the <b><i>hostname</i></b> of the server +to connect to in the <a href="../../docs/api_c/env_set_server.html">DBENV->set_server</a> +call.</li> + +<li> +<b>-rep_client </b>sets the newly created environment to be a +replication client, using the <a href="../../docs/api_c/rep_client.html"> +DBENV->rep_client</a> call.</li> + +<li> +<b>-rep_master </b>sets the newly created environment to be a +replication master, using the <a href="../../docs/api_c/rep_master.html"> +DBENV->rep_master</a> call.</li> + +<li> +<b>-rep_transport </b>specifies the replication transport function, +using the +<a href="../../docs/api_c/rep_transport.html">DBENV->set_rep_transport</a> +call. This site's machine ID is set to <b><i>machineid</i></b> and +the send function, a Tcl proc, is set to <b><i>sendproc</i></b>.</li> + +</ul> + +This command will invoke the <a href="../../docs/api_c/env_create.html">db_env_create</a> function. After it successfully gets a handle to an environment, -we bind it to a new Tcl command of the form <B><I>envX</I></B>, where X -is an integer starting at 0 (e.g. <B>env0, env1, </B>etc). -We use the <I>Tcl_CreateObjCommand()</I> to create the top level environment +we bind it to a new Tcl command of the form <b><i>envX</i></b>, where X +is an integer starting at 0 (e.g. <b>env0, env1, </b>etc). +We use the <i>Tcl_CreateObjCommand()</i> to create the top level environment command function. It is through this handle that the user can access -all the commands described in the <A HREF="#Environment Commands">Environment -Commands</A> section. Internally, the handle we get back from DB -will be stored as the <I>ClientData</I> portion of the new command set +all the commands described in the <a href="#Environment Commands">Environment +Commands</a> section. Internally, the handle we get back from DB +will be stored as the <i>ClientData</i> portion of the new command set so that all future environment calls will have that handle readily available. -Then we call the <A HREF="../../docs/api_c/env_open.html">DBENV->open</A> +Then we call the <a href="../../docs/api_c/env_open.html">DBENV->open</a> method call and possibly some number of setup calls as described above. -<P> -<HR WIDTH="100%"> -<BR><A NAME="> <env> verbose which on|off"></A><B>> <env> verbose <I>which</I> -on|off</B> -<P>This command controls the use of debugging output for the environment. -This command directly translates to a call to the <A HREF="../../docs/api_c/dbenv_set_verbose.html">DBENV->set_verbose</A> +<p> +<hr WIDTH="100%"> +<br><a NAME="> <env> verbose which on|off"></a><b>> <env> verbose <i>which</i> +on|off</b> +<p>This command controls the use of debugging output for the environment. +This command directly translates to a call to the <a href="../../docs/api_c/dbenv_set_verbose.html">DBENV->set_verbose</a> method call. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. The user specifies -<B><I>which</I></B> +<b><i>which</i></b> subsystem to control, and indicates whether debug messages should be turned -<B>on</B> -or <B>off</B> for that subsystem. The value of <B><I>which</I></B> +<b>on</b> +or <b>off</b> for that subsystem. The value of <b><i>which</i></b> must be one of the following: -<UL> -<LI> -<B>chkpt</B> - Chooses the checkpointing code by using the DB_VERB_CHKPOINT -value</LI> - -<LI> -<B>deadlock </B>- Chooses the deadlocking code by using the DB_VERB_DEADLOCK -value</LI> - -<LI> -<B>recovery </B>- Chooses the recovery code by using the DB_VERB_RECOVERY -value</LI> - -<LI> -<B>wait </B>- Chooses the waitsfor code by using the DB_VERB_WAITSFOR value</LI> -</UL> - -<HR WIDTH="100%"> -<P><A NAME="> <env> close"></A><B>> <env> close</B> -<P>This command closes an environment and deletes the handle. This -command directly translates to a call to the <A HREF="../../docs/api_c/env_close.html">DBENV->close</A> +<ul> +<li> +<b>chkpt</b> - Chooses the checkpointing code by using the DB_VERB_CHKPOINT +value</li> + +<li> +<b>deadlock </b>- Chooses the deadlocking code by using the DB_VERB_DEADLOCK +value</li> + +<li> +<b>recovery </b>- Chooses the recovery code by using the DB_VERB_RECOVERY +value</li> + +<li> +<b>wait </b>- Chooses the waitsfor code by using the DB_VERB_WAITSFOR value</li> +</ul> + +<hr WIDTH="100%"> +<p><a NAME="> <env> close"></a><b>> <env> close</b> +<p>This command closes an environment and deletes the handle. This +command directly translates to a call to the <a href="../../docs/api_c/env_close.html">DBENV->close</a> method call. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. -<P>Additionally, since the handle is no longer valid, we will call <I>Tcl_DeleteCommand() -</I>so +<p>Additionally, since the handle is no longer valid, we will call <i>Tcl_DeleteCommand() +</i>so that further uses of the handle will be dealt with properly by Tcl itself. -<P>Also, the close command will automatically abort any <A HREF="txn.html">transactions</A> -and close any <A HREF="mpool.html">mpool</A> memory files. As such +<p>Also, the close command will automatically abort any <a href="txn.html">transactions</a> +and close any <a href="mpool.html">mpool</a> memory files. As such we must maintain a list of open transaction and mpool handles so that we -can call <I>Tcl_DeleteCommand</I> on those as well. -<P> -<HR WIDTH="100%"> -<BR><B>> berkdb envremove [-data_dir <I>directory</I>] [-force] [-home -<I>directory</I>] --log_dir <I>directory</I>] [-tmp_dir <I>directory</I>] [-use_environ] [-use_environ_root]</B> -<P>This command removes the environment if it is not in use and deletes -the handle. This command directly translates to a call to the <A HREF="../../docs/api_c/env_remove.html">DBENV->remove</A> +can call <i>Tcl_DeleteCommand</i> on those as well. +<p> +<hr WIDTH="100%"> + +<b>> berkdb envremove<br> +[-data_dir <i>directory</i>]<br> +[-force]<br> +[-home <i>directory</i>]<br> +[-log_dir <i>directory</i>]<br> +[-overwrite]<br> +[-tmp_dir <i>directory</i>]<br> +[-use_environ]<br> +[-use_environ_root]</b> + +<p>This command removes the environment if it is not in use and deletes +the handle. This command directly translates to a call to the <a href="../../docs/api_c/env_remove.html">DBENV->remove</a> method call. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. The arguments are: -<UL> -<LI> -<B>-force</B> selects the DB_FORCE flag to remove even if other processes -have the environment open</LI> +<ul> +<li> +<b>-force</b> selects the DB_FORCE flag to remove even if other processes +have the environment open</li> + +<li> +<b>-home <i>directory</i> </b>specifies the home directory of the environment</li> -<LI> -<B>-home <I>directory</I> </B>specifies the home directory of the environment</LI> +<li> +<b>-data_dir <i>directory </i></b>selects the data file directory of the +environment by calling <a href="../../docs/api_c/env_set_data_dir.html">DBENV->set_data_dir</a>.</li> -<LI> -<B>-data_dir <I>directory </I></B>selects the data file directory of the -environment by calling <A HREF="../../docs/api_c/env_set_data_dir.html">DBENV->set_data_dir</A>.</LI> +<li> +<b>-log_dir <i>directory </i></b>selects the log file directory of the +environment by calling <a href="../../docs/api_c/env_set_lg_dir.html">DBENV->set_lg_dir</a>.</li> -<LI> -<B>-log_dir <I>directory </I></B>selects the log file directory of the -environment by calling <A HREF="../../docs/api_c/env_set_lg_dir.html">DBENV->set_lg_dir</A>.</LI> +<li> +<b>-overwrite </b>sets DB_OVERWRITE flag</li> -<LI> -<B>-tmp_dir <I>directory </I></B>selects the temporary file directory of -the environment by calling <A HREF="../../docs/api_c/env_set_tmp_dir.so">DBENV->set_tmp_dir</A>.</LI> +<li> +<b>-tmp_dir <i>directory </i></b>selects the temporary file directory of +the environment by calling <a href="../../docs/api_c/env_set_tmp_dir.so">DBENV->set_tmp_dir</a>.</li> -<LI> -<B>-use_environ </B>selects the DB_USE_ENVIRON flag to affect file naming</LI> +<li> +<b>-use_environ </b>selects the DB_USE_ENVIRON flag to affect file naming</li> -<LI> -<B>-use_environ_root</B> selects the DB_USE_ENVIRON_ROOT flag to affect -file naming</LI> -</UL> +<li> +<b>-use_environ_root</b> selects the DB_USE_ENVIRON_ROOT flag to affect +file naming</li> +</ul> -</BODY> -</HTML> +</body> +</html> diff --git a/bdb/tcl/docs/historic.html b/bdb/tcl/docs/historic.html index 216dc456b72..85f474fbc0f 100644 --- a/bdb/tcl/docs/historic.html +++ b/bdb/tcl/docs/historic.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> diff --git a/bdb/tcl/docs/index.html b/bdb/tcl/docs/index.html index 2866c1e23db..845b6ca81e2 100644 --- a/bdb/tcl/docs/index.html +++ b/bdb/tcl/docs/index.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> @@ -29,6 +30,9 @@ Complete Tcl Interface for Berkeley DB</H1></CENTER> <A HREF="./mpool.html">Memory Pool commands</A></LI> <LI> +<A HREF="./rep.html">Replication commands</A></LI> + +<LI> <A HREF="./txn.html">Transaction commands</A></LI> </UL> diff --git a/bdb/tcl/docs/library.html b/bdb/tcl/docs/library.html index abd656d8e5d..bfb1588c3f2 100644 --- a/bdb/tcl/docs/library.html +++ b/bdb/tcl/docs/library.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> diff --git a/bdb/tcl/docs/lock.html b/bdb/tcl/docs/lock.html index 87a20e9a6bf..d65142b798b 100644 --- a/bdb/tcl/docs/lock.html +++ b/bdb/tcl/docs/lock.html @@ -1,187 +1,207 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<HTML> -<HEAD> - <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> - <META NAME="GENERATOR" CONTENT="Mozilla/4.08 [en] (X11; I; FreeBSD 2.2.8-19990120-SNAP i386) [Netscape]"> -</HEAD> -<BODY> - -<H2> -<A NAME="Locking Commands"></A>Locking Commands</H2> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.75 [en] (X11; U; Linux 2.2.16-22 i686) [Netscape]"> +</head> +<body> + +<h2> +<a NAME="Locking Commands"></a>Locking Commands</h2> Most locking commands work with the environment handle. However, when a user gets a lock we create a new lock handle that they then use with in a similar manner to all the other handles to release the lock. We present the general locking functions first, and then those that manipulate locks. -<P><B>> <env> lock_detect [-lock_conflict] [default|oldest|youngest|random]</B> -<P>This command runs the deadlock detector. It directly translates -to the <A HREF="../../docs/api_c/lock_detect.html">lock_detect</A> DB call. +<p><b>> <env> lock_detect [default|oldest|youngest|random]</b> +<p>This command runs the deadlock detector. It directly translates +to the <a href="../../docs/api_c/lock_detect.html">lock_detect</a> DB call. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. The first argument sets the policy for deadlock as follows: -<UL> -<LI> -<B>default</B> selects the DB_LOCK_DEFAULT policy for default detection -(default if not specified)</LI> - -<LI> -<B>oldest </B>selects DB_LOCK_OLDEST to abort the oldest locker on a deadlock</LI> - -<LI> -<B>random</B> selects DB_LOCK_RANDOM to abort a random locker on a deadlock</LI> - -<LI> -<B>youngest</B> selects DB_LOCK_YOUNGEST to abort the youngest locker on -a deadlock</LI> -</UL> -The second argument, <B>-lock_conflict</B>, selects the DB_LOCK_CONFLICT -flag to only run the detector if a lock conflict has occurred since the -last time the detector was run. -<HR WIDTH="100%"> -<BR><B>> <env> lock_stat</B> -<P>This command returns a list of name/value pairs where the names correspond +<ul> +<li> +<b>default</b> selects the DB_LOCK_DEFAULT policy for default detection +(default if not specified)</li> + +<li> +<b>oldest </b>selects DB_LOCK_OLDEST to abort the oldest locker on a deadlock</li> + +<li> +<b>random</b> selects DB_LOCK_RANDOM to abort a random locker on a deadlock</li> + +<li> +<b>youngest</b> selects DB_LOCK_YOUNGEST to abort the youngest locker on +a deadlock</li> +</ul> + +<hr WIDTH="100%"> +<br><b>> <env> lock_stat</b> +<p>This command returns a list of name/value pairs where the names correspond to the C-structure field names of DB_LOCK_STAT and the values are the data -returned. This command is a direct translation of the <A HREF="../../docs/api_c/lock_stat.html">lock_stat</A> +returned. This command is a direct translation of the <a href="../../docs/api_c/lock_stat.html">lock_stat</a> DB call. -<HR WIDTH="100%"> -<BR><A NAME="> <env> lock_id"></A><B>> <env> lock_id</B> -<P>This command returns a unique locker ID value. It directly translates -to the <A HREF="../../docs/api_c/lock_id.html">lock_id</A> DB call. -<HR WIDTH="100%"> -<BR><A NAME="> <env> lock_get"></A><B>> <env> lock_get [-nowait]<I>lockmode -locker obj</I></B> -<P>This command gets a lock. It will invoke the <A HREF="../../docs/api_c/lock_get.html">lock_get</A> +<hr WIDTH="100%"> +<br><a NAME="> <env> lock_id"></a><b>> <env> lock_id</b> +<p>This command returns a unique locker ID value. It directly translates +to the <a href="../../docs/api_c/lock_id.html">lock_id</a> DB call. +<br> +<hr WIDTH="100%"> +<br><a NAME="> <env> lock_id"></a><b>> <env> lock_id_free </b><i>locker</i> +<p>This command frees the locker allockated by the lock_id call. It directly +translates to the <a href="../../docs/api_c/lock_id.html">lock_id_free +</a>DB +call. +<hr WIDTH="100%"> +<br><a NAME="> <env> lock_id"></a><b>> <env> lock_id_set </b><i>current +max</i> +<p>This is a diagnostic command to set the locker id that will get +allocated next and the maximum id that +<br>will trigger the id reclaim algorithm. +<hr WIDTH="100%"> +<br><a NAME="> <env> lock_get"></a><b>> <env> lock_get [-nowait]<i>lockmode +locker obj</i></b> +<p>This command gets a lock. It will invoke the <a href="../../docs/api_c/lock_get.html">lock_get</a> function. After it successfully gets a handle to a lock, we bind -it to a new Tcl command of the form <B><I>$env.lockX</I></B>, where X is -an integer starting at 0 (e.g. <B>$env.lock0, $env.lock1, </B>etc). -We use the <I>Tcl_CreateObjCommand()</I> to create the top level locking +it to a new Tcl command of the form <b><i>$env.lockX</i></b>, where X is +an integer starting at 0 (e.g. <b>$env.lock0, $env.lock1, </b>etc). +We use the <i>Tcl_CreateObjCommand()</i> to create the top level locking command function. It is through this handle that the user can release the lock. Internally, the handle we get back from DB will be stored -as the <I>ClientData</I> portion of the new command set so that future +as the <i>ClientData</i> portion of the new command set so that future locking calls will have that handle readily available. -<P>The arguments are: -<UL> -<LI> -<B><I>locker</I></B> specifies the locker ID returned from the <A HREF="#> <env> lock_id">lock_id</A> -command</LI> +<p>The arguments are: +<ul> +<li> +<b><i>locker</i></b> specifies the locker ID returned from the <a href="#> <env> lock_id">lock_id</a> +command</li> -<LI> -<B><I>obj</I></B> specifies an object to lock</LI> +<li> +<b><i>obj</i></b> specifies an object to lock</li> -<LI> -the <B><I>lock mode</I></B> is specified as one of the following:</LI> +<li> +the <b><i>lock mode</i></b> is specified as one of the following:</li> -<UL> -<LI> -<B>ng </B>specifies DB_LOCK_NG for not granted (always 0)</LI> +<ul> +<li> +<b>ng </b>specifies DB_LOCK_NG for not granted (always 0)</li> -<LI> -<B>read</B> specifies DB_LOCK_READ for a read (shared) lock</LI> +<li> +<b>read</b> specifies DB_LOCK_READ for a read (shared) lock</li> -<LI> -<B>write</B> specifies DB_LOCK_WRITE for an exclusive write lock</LI> +<li> +<b>write</b> specifies DB_LOCK_WRITE for an exclusive write lock</li> -<LI> -<B>iwrite </B>specifies DB_LOCK_IWRITE for intent for exclusive write lock</LI> +<li> +<b>iwrite </b>specifies DB_LOCK_IWRITE for intent for exclusive write lock</li> -<LI> -<B>iread </B>specifies DB_LOCK_IREAD for intent for shared read lock</LI> +<li> +<b>iread </b>specifies DB_LOCK_IREAD for intent for shared read lock</li> -<LI> -<B>iwr </B>specifies DB_LOCK_IWR for intent for eread and write lock</LI> -</UL> +<li> +<b>iwr </b>specifies DB_LOCK_IWR for intent for eread and write lock</li> +</ul> -<LI> -<B>-nowait</B> selects the DB_LOCK_NOWAIT to indicate that we do not want -to wait on the lock</LI> -</UL> +<li> +<b>-nowait</b> selects the DB_LOCK_NOWAIT to indicate that we do not want +to wait on the lock</li> +</ul> -<HR WIDTH="100%"> -<BR><B>> <lock> put</B> -<P>This command releases the lock referenced by the command. It is -a direct translation of the <A HREF="../../docs/api_c/lock_put.html">lock_put</A> +<hr WIDTH="100%"> +<br><b>> <lock> put</b> +<p>This command releases the lock referenced by the command. It is +a direct translation of the <a href="../../docs/api_c/lock_put.html">lock_put</a> function. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. Additionally, since the handle is no longer valid, we will call -<I>Tcl_DeleteCommand() -</I>so +<i>Tcl_DeleteCommand() +</i>so that further uses of the handle will be dealt with properly by Tcl itself. -<BR> -<HR WIDTH="100%"> -<BR><A NAME="> <env> lock_vec"></A><B>> <env> lock_vec [-nowait] <I>locker -</I>{get|put|put_all|put_obj -[<I>obj</I>] [<I>lockmode</I>] [<I>lock</I>]} ...</B> -<P>This command performs a series of lock calls. It is a direct translation -of the <A HREF="../../docs/api_c/lock_vec.html">lock_vec</A> function. +<br> +<hr WIDTH="100%"> +<br><a NAME="> <env> lock_vec"></a><b>> <env> lock_vec [-nowait] <i>locker +</i>{get|put|put_all|put_obj +[<i>obj</i>] [<i>lockmode</i>] [<i>lock</i>]} ...</b> +<p>This command performs a series of lock calls. It is a direct translation +of the <a href="../../docs/api_c/lock_vec.html">lock_vec</a> function. This command will return a list of the return values from each operation specified in the argument list. For the 'put' operations the entry in the return value list is either a 0 (for success) or an error. -For the 'get' operation, the entry is the lock widget handle, <B>$env.lockN</B> -(as described above in <A HREF="#> <env> lock_get"><env> lock_get</A>) +For the 'get' operation, the entry is the lock widget handle, <b>$env.lockN</b> +(as described above in <a href="#> <env> lock_get"><env> lock_get</a>) or an error. If an error occurs, the return list will contain the return values for all the successful operations up the erroneous one and the error code for that operation. Subsequent operations will be ignored. -<P>As for the other operations, if we are doing a 'get' we will create +<p>As for the other operations, if we are doing a 'get' we will create the commands and if we are doing a 'put' we will have to delete the commands. Additionally, we will have to do this after the call to the DB lock_vec and iterate over the results, creating and/or deleting Tcl commands. It is possible that we may return a lock widget from a get operation that -is considered invalid, if, for instance, there was a <B>put_all</B> operation +is considered invalid, if, for instance, there was a <b>put_all</b> operation performed later in the vector of operations. The arguments are: -<UL> -<LI> -<B><I>locker</I></B> specifies the locker ID returned from the <A HREF="#> <env> lock_id">lock_id</A> -command</LI> +<ul> +<li> +<b><i>locker</i></b> specifies the locker ID returned from the <a href="#> <env> lock_id">lock_id</a> +command</li> -<LI> -<B>-nowait</B> selects the DB_LOCK_NOWAIT to indicate that we do not want -to wait on the lock</LI> +<li> +<b>-nowait</b> selects the DB_LOCK_NOWAIT to indicate that we do not want +to wait on the lock</li> -<LI> +<li> the lock vectors are tuple consisting of {an operation, lock object, lock -mode, lock handle} where what is required is based on the operation desired:</LI> - -<UL> -<LI> -<B>get</B> specifes DB_LOCK_GET to get a lock. Requires a tuple <B>{get -<I>obj</I> -<I>mode</I>} -</B>where -<B><I>mode</I></B> -is:</LI> - -<UL> -<LI> -<B>ng </B>specifies DB_LOCK_NG for not granted (always 0)</LI> - -<LI> -<B>read</B> specifies DB_LOCK_READ for a read (shared) lock</LI> - -<LI> -<B>write</B> specifies DB_LOCK_WRITE for an exclusive write lock</LI> - -<LI> -<B>iwrite </B>specifies DB_LOCK_IWRITE for intent for exclusive write lock</LI> - -<LI> -<B>iread </B>specifies DB_LOCK_IREAD for intent for shared read lock</LI> - -<LI> -<B>iwr </B>specifies DB_LOCK_IWR for intent for eread and write lock</LI> -</UL> - -<LI> -<B>put</B> specifies DB_LOCK_PUT to release a <B><I>lock</I></B>. -Requires a tuple <B>{put <I>lock}</I></B></LI> - -<LI> -<B>put_all </B>specifies DB_LOCK_PUT_ALL to release all locks held by <B><I>locker</I></B>. -Requires a tuple <B>{put_all}</B></LI> - -<LI> -<B>put_obj</B> specifies DB_LOCK_PUT_OBJ to release all locks held by <B><I>locker</I></B> -associated with the given <B><I>obj</I></B>. Requires a tuple <B>{put_obj -<I>obj</I>}</B></LI> -</UL> -</UL> +mode, lock handle} where what is required is based on the operation desired:</li> + +<ul> +<li> +<b>get</b> specifes DB_LOCK_GET to get a lock. Requires a tuple <b>{get +<i>objmode</i>} +</b>where +<b><i>mode</i></b> +is:</li> + +<ul> +<li> +<b>ng </b>specifies DB_LOCK_NG for not granted (always 0)</li> + +<li> +<b>read</b> specifies DB_LOCK_READ for a read (shared) lock</li> + +<li> +<b>write</b> specifies DB_LOCK_WRITE for an exclusive write lock</li> + +<li> +<b>iwrite </b>specifies DB_LOCK_IWRITE for intent for exclusive write lock</li> + +<li> +<b>iread </b>specifies DB_LOCK_IREAD for intent for shared read lock</li> + +<li> +<b>iwr </b>specifies DB_LOCK_IWR for intent for eread and write lock</li> +</ul> + +<li> +<b>put</b> specifies DB_LOCK_PUT to release a <b><i>lock</i></b>. +Requires a tuple <b>{put <i>lock}</i></b></li> + +<li> +<b>put_all </b>specifies DB_LOCK_PUT_ALL to release all locks held by <b><i>locker</i></b>. +Requires a tuple <b>{put_all}</b></li> + +<li> +<b>put_obj</b> specifies DB_LOCK_PUT_OBJ to release all locks held by <b><i>locker</i></b> +associated with the given <b><i>obj</i></b>. Requires a tuple <b>{put_obj +<i>obj}</i></b></li> +</ul> +</ul> + +<hr WIDTH="100%"> +<br><a NAME="> <env> lock_vec"></a><b>> <env> lock_timeout <i>timeout</i></b> +<p>This command sets the lock timeout for all future locks in this environment. +The timeout is in micorseconds. +<br> +<br> +</body> +</html> diff --git a/bdb/tcl/docs/log.html b/bdb/tcl/docs/log.html index 35ecfc2f5f5..49f2f0ad2e0 100644 --- a/bdb/tcl/docs/log.html +++ b/bdb/tcl/docs/log.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> @@ -100,7 +101,7 @@ given <B><I>lsn</I></B></LI> <HR WIDTH="100%"> <BR><A NAME="> <env> log_put"></A><B>> <env> log_put<I> </I>[-checkpoint] -[-curlsn] [-flush] <I>record</I></B> +[-flush] <I>record</I></B> <P>This command stores a <B><I>record</I></B> into the log and returns the LSN of the log record. It is a direct call to the <A HREF="../../docs/api_c/log_put.html">log_put</A> function. It returns either an LSN or it throws a Tcl error with @@ -110,29 +111,10 @@ a system message. <B> </B>The arguments are: <B>-checkpoint </B>selects the DB_CHECKPOINT flag</LI> <LI> -<B>-curlsn</B> selects the DB_CURLSN flag to return the LSN of the next -record</LI> - -<LI> <B>-flush </B>selects the DB_FLUSH flag to flush the log to disk.</LI> </UL> <HR WIDTH="100%"> -<BR><A NAME="> <env> log_register"></A><B>> <env> log_register <I>db</I> -<I>file</I></B> -<P>This command registers a <B><I>file</I></B> and <B><I>db</I></B> with -the log manager. It is a direct call to the <A HREF="../../docs/api_c/log_register.html">log_register</A> -function. It returns either a 0 (for success), a DB error message -or it throws a Tcl error with a system message. -<BR> -<HR WIDTH="100%"> -<BR><A NAME="> <env> log_unregister"></A><B>> <env> log_unregister <I>db</I></B> -<P>This command unregisters the file specified by the database handle <B><I>db -</I></B>from the log manager. It is a direct call to the <A HREF="../../docs/api_c/log_unregister.html">log_unregister</A> -function. It returns either a 0 (for success), a DB error message -or it throws a Tcl error with a system message. -<BR> -<HR WIDTH="100%"> <BR><B>> <env> log_stat</B> <P>This command returns the statistics associated with the logging subsystem. It is a direct call to the <A HREF="../../docs/api_c/log_stat.html">log_stat</A> diff --git a/bdb/tcl/docs/mpool.html b/bdb/tcl/docs/mpool.html index 666219306ca..7f2359b36e9 100644 --- a/bdb/tcl/docs/mpool.html +++ b/bdb/tcl/docs/mpool.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> diff --git a/bdb/tcl/docs/rep.html b/bdb/tcl/docs/rep.html new file mode 100644 index 00000000000..079fe443a63 --- /dev/null +++ b/bdb/tcl/docs/rep.html @@ -0,0 +1,51 @@ +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <title>Replication commands</title> +</head> +<body> + +<h2> +<a NAME="Replication Commands"></a>Replication Commands</h2> +Replication commands are invoked from the environment handle, after +it has been opened with the appropriate flags defined +<a href="./env.html">here</a>.<br> +<hr WIDTH="100%"> +<p><b>> <env> rep_process_message <i>machid</i> <i>control</i> +<i>rec</i></b> +<p>This command processes a single incoming replication message. It +is a direct translation of the <a +href="../../docs/api_c/rep_process_message.html">rep_process_message</a> +function. +It returns either a 0 (for success), a DB error message or it throws a +Tcl error with a system message. The arguments are: +<ul> +<li> +<b>machid </b>is the machine ID of the machine that <i>sent</i> this +message.</li> + +<li> +<b>control</b> is a binary string containing the exact contents of the +<b><i>control</i></b> argument to the <b><i>sendproc</i></b> function +that was passed this message on another site.</li> + +<li> +<b>rec</b> is a binary string containing the exact contents of the +<b><i>rec</i></b> argument to the <b><i>sendproc</i></b> function +that was passed this message on another site.</li> +</ul> + +<hr WIDTH="100%"> +<br><b>> <env> rep_elect <i>nsites</i> <i>pri</i> <i>wait</i> +<i>sleep</i></b> +<p>This command causes a replication election. It is a direct translation +of the <a href="../../docs/api_c/rep_elect.html">rep_elect</a> function. +Its arguments, all integers, correspond exactly to that C function's +parameters. +It will return a list containing two integers, which contain, +respectively, the integer values returned in the C function's +<i><b>midp</b></i> and <i><b>selfp</b></i> parameters. +</body> +</html> diff --git a/bdb/tcl/docs/test.html b/bdb/tcl/docs/test.html index 10cf09efba7..603ae56a51e 100644 --- a/bdb/tcl/docs/test.html +++ b/bdb/tcl/docs/test.html @@ -1,4 +1,5 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> <HTML> <HEAD> <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> diff --git a/bdb/tcl/docs/txn.html b/bdb/tcl/docs/txn.html index 863c9a875e6..07c88c0fe1d 100644 --- a/bdb/tcl/docs/txn.html +++ b/bdb/tcl/docs/txn.html @@ -1,56 +1,67 @@ -<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> -<HTML> -<HEAD> - <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1"> - <META NAME="GENERATOR" CONTENT="Mozilla/4.08 [en] (X11; I; FreeBSD 2.2.8-19990120-SNAP i386) [Netscape]"> -</HEAD> -<BODY> +<!--Copyright 1999-2002 by Sleepycat Software, Inc.--> +<!--All rights reserved.--> +<html> +<head> + <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> + <meta name="GENERATOR" content="Mozilla/4.75 [en] (X11; U; Linux 2.2.16-22 i686) [Netscape]"> +</head> +<body> -<H2> -<A NAME="Transaction Commands"></A>Transaction Commands</H2> +<h2> +<a NAME="Transaction Commands"></a>Transaction Commands</h2> Transactions are used in a manner similar to the other subsystems. We create a handle to the transaction and then use it for a variety of operations. Some of the transaction commands use the environment instead. Those are presented first. The transaction command handle returned is the handle used by the various commands that can be -transaction protected, such as <A HREF="../../docs/api_tcl/db_cursor.html">cursors</A>.<BR> - -<HR WIDTH="100%"> -<P><B>> <env> txn_checkpoint [-kbyte <I>kb</I>] [-min <I>min</I>]</B> -<P>This command causes a checkpoint of the transaction region. It -is a direct translation of the <A HREF="../../docs/api_c/txn_checkpoint.html">txn_checkpoint -</A>function. +transaction protected, such as <a href="../../docs/api_tcl/db_cursor.html">cursors</a>. +<br> +<hr WIDTH="100%"> +<p><b>> <env> txn_checkpoint [-kbyte <i>kb</i>] [-min <i>min</i>]</b> +<p>This command causes a checkpoint of the transaction region. It +is a direct translation of the <a href="../../docs/api_c/txn_checkpoint.html">txn_checkpoint +</a>function. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. The arguments are: -<UL> -<LI> -<B>-kbyte </B>causes the checkpoint to occur only if <B><I>kb</I></B> kilobytes -of log data has been written since the last checkpoint</LI> +<ul> +<li> +<b>-kbyte </b>causes the checkpoint to occur only if <b><i>kb</i></b> kilobytes +of log data has been written since the last checkpoint</li> -<LI> -<B>-min</B> causes the checkpoint to occur only if <B><I>min</I></B> minutes -have passed since the last checkpoint</LI> -</UL> +<li> +<b>-min</b> causes the checkpoint to occur only if <b><i>min</i></b> minutes +have passed since the last checkpoint</li> +</ul> -<HR WIDTH="100%"> -<BR><B>> <env> txn_stat</B> -<P>This command returns transaction statistics. It is a direct translation -of the <A HREF="../../docs/api_c/txn_stat.html">txn_stat</A> function. +<hr WIDTH="100%"> +<br><b>> <env> txn_stat</b> +<p>This command returns transaction statistics. It is a direct translation +of the <a href="../../docs/api_c/txn_stat.html">txn_stat</a> function. It will return a list of name/value pairs that correspond to the DB_TXN_STAT structure. -<HR WIDTH="100%"> -<BR><B>> <txn> id</B> -<P>This command returns the transaction id. It is a direct call to -the <A HREF="../../docs/api_c/txn_id.html">txn_id</A> function. The -typical use of this identifier is as the <B><I>locker</I></B> value for -the <A HREF="lock.html">lock_get</A> and <A HREF="lock.html">lock_vec</A> +<hr WIDTH="100%"> +<br><b>> <env> txn_id_set </b><i> current max</i> +<p>This is a diagnosic command that sets the next transaction id to be +allocated and the maximum transaction +<br>id, which is the point at which the relcaimation algorthm is triggered. +<hr WIDTH="100%"> +<br><b>> <txn> id</b> +<p>This command returns the transaction id. It is a direct call to +the <a href="../../docs/api_c/txn_id.html">txn_id</a> function. The +typical use of this identifier is as the <b><i>locker</i></b> value for +the <a href="lock.html">lock_get</a> and <a href="lock.html">lock_vec</a> calls. -<HR WIDTH="100%"> -<BR><B>> <txn> prepare</B> -<P>This command initiates a two-phase commit. It is a direct call -to the <A HREF="../../docs/api_c/txn_prepare.html">txn_prepare</A> function. +<hr WIDTH="100%"> +<br><b>> <txn> prepare</b> +<p>This command initiates a two-phase commit. It is a direct call +to the <a href="../../docs/api_c/txn_prepare.html">txn_prepare</a> function. It returns either a 0 (for success), a DB error message or it throws a Tcl error with a system message. -<HR WIDTH="100%"> -</BODY> -</HTML> +<hr WIDTH="100%"><a NAME="> <env> lock_vec"></a><b>> <env> txn_timeout +<i>timeout</i></b> +<p>This command sets thetransaction timeout for transactions started in +the future in this environment. The timeout is in micorseconds. +<br> +<br> +</body> +</html> |