berkdb open
|
|
berkdb open |
|
berkdb open
[-auto_commit]
[-btree | -hash | -recno | -queue | -unknown]
[-cachesize {gbytes bytes ncache}]
[-create]
[-delim delim]
[-dup]
[-dupsort]
[-encrypt]
[-encryptaes passwd]
[-encryptany passwd]
[-env env]
[-errfile filename]
[-excl]
[-extent size]
[-ffactor density]
[-len len]
[-mode mode]
[-nelem size]
[-pad pad]
[-pagesize pagesize]
[-rdonly]
[-recnum]
[-renumber]
[-snapshot]
[-source file]
[-truncate]
[-txn txnid]
[--]
[file [database]]
The berkdb open command opens and optionally creates a database. The returned database handle is bound to a Tcl command of the form dbN, where N is an integer starting at 0 (for example, db0 and db1). It is through this Tcl command that the script accesses the database methods.
The options are as follows:
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.
It is possible to specify caches to Berkeley DB that are large enough so that they cannot be allocated contiguously on some architectures; for example, some releases of Solaris limit the amount of memory that may be allocated contiguously by a process. If ncache 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 ncache equally sized separate pieces of memory.
For information on tuning the Berkeley DB cache size, see Selecting a cache size.
Because 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.
This byte is used for variable length records if the -source argument file is specified. If the -source argument file is specified and no delimiting byte was specified, <newline> characters (that is, ASCII 0x0a) are interpreted as end-of-record markers.
error to specify both -dup and -recnum.
If a -env argument is given, the database is created within the specified Berkeley DB environment. The database access methods automatically make calls to the other subsystems in Berkeley DB, based on the enclosing environment. For example, if the environment has been configured to use locking, the access methods will automatically acquire the correct locks when reading and writing pages of the database.
When an error occurs in the Berkeley DB library, a Berkeley DB error or an error return value is returned by the function. In some cases, however, the errno value may be insufficient to completely describe the cause of the error especially during initial application debugging.
The -errfile argument is used to enhance the mechanism for reporting error messages to the application by specifying a file to be used for displaying additional Berkeley DB error messages. In some cases, when an error occurs, Berkeley DB will output an additional error message to the specified file reference.
The error message will consist of a Tcl command name and a colon (":"), an error string, and a trailing <newline> character. If the database was opened in an environment, the Tcl command name will be the environment name (for example, env0), otherwise it will be the database command name (for example, db0).
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.
For database handles opened inside of Berkeley DB environments, specifying the -errfile argument affects the entire environment and is equivalent to specifying the same argument to the berkdb env command.
For information on tuning the extent size, see Selecting a extent size.
The density is an approximation of the number of keys allowed to accumulate in any one bucket
For the Recno access method, specify that the records are fixed-length, not byte-delimited, and are of length len.
Any records added to the database that are less than len bytes long are automatically padded (see the -pad argument for more information).
Any attempt to insert records into the database that are greater than len bytes long will cause the call to fail immediately and return an error.
On UNIX systems, or in IEEE/ANSI Std 1003.1 (POSIX) environments, all files created by the access methods are created with mode mode (as described in chmod(2)) and modified by the process' umask value at the time of creation (see umask(2)). The group ownership of created files is based on the system and directory defaults, and is not further specified by Berkeley DB. If mode is 0, files are created readable and writable by both owner and group. On Windows systems, the mode argument is ignored.
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.
If no pad character is specified, <space> characters (that is, ASCII 0x20) are used for padding.
For information on tuning the Berkeley DB page size, see Selecting a page size.
Logical record numbers in Btree databases are mutable in the face of record insertion or deletion. See the -renumber argument for further discussion.
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 -recnum can result in serious performance degradation for some applications and data sets.
It is an error to specify both -dup and -recnum.
Using the db put or dbc put 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.
If a created record is not at the end of the database, all records following the new record will be automatically renumbered upward by one. For example, the creation of a new record numbered 8 causes records numbered 8 and greater to be renumbered upward by one. If a cursor was positioned to record number 8 or greater before the insertion, it will be shifted upward one logical record, continuing to refer to the same record as it did before.
For these reasons, concurrent access to a Recno database with the -renumber flag specified may be largely meaningless, although it is supported.
If the -source argument is give, it specifies an underlying flat text database file that is read to initialize a transient record number index. In the case of variable length records, the records are separated as specified by -delim. For example, standard UNIX byte stream files can be interpreted as a sequence of variable length records separated by <newline> characters.
In addition, when cached data would normally be written back to the underlying database file (for example, when the db close or db sync commands are called), the in-memory copy of the database will be written back to the -source file.
By default, the backing source file is read lazily, that is, records are not read from the file until they are requested by the application. If multiple processes (not threads) are accessing a Recno database concurrently and either inserting or deleting records, the backing source file must be read in its entirety before more than a single process accesses the database, and only that process should specify the backing source argument as part of the berkdb open call. See the -snapshot argument for more information.
Reading and writing the backing source file specified by -source cannot be transaction protected because it involves filesystem operations that are not part of the Berkeley DB transaction methodology. For this reason, if a temporary database is used to hold the records, it is possible to lose the contents of the -file file, for example, if the system crashes at the right instant. If a file is used to hold the database, that is, a filename was specified as the file argument to berkdb open, normal database recovery on that file can be used to prevent information loss, although it is still possible that the contents of -source will be lost if the system crashes.
The -source file must already exist (but may be zero-length) when berkdb open is called.
It is not an error to specify a read-only -source 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 db close or db sync commands will fail, of course. Specify the -nosync argument to the db close command will stop it from attempting to write the changes to the backing file; instead, they will be silently discarded.
For all of the previous reasons, the -source file is generally used to specify databases that are read-only for Berkeley DB applications, and that are either generated on the fly by software tools, or modified using a different mechanism such as a text editor.
The -truncate argument cannot be transaction-protected, and it is an error to specify it in a transaction-protected environment.
Applications opening multiple databases in a single file will almost certainly need to create a shared database environment. See Opening multiple databases in a single file for more information.
The berkdb open command returns a database handle on success.
In the case of error, a Tcl error is thrown.
|
|
Copyright (c) 1996-2005 Sleepycat Software, Inc. - All rights reserved.