mirrors
/
cpython
mirror of https://github.com/python/cpython.git
2
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Include a link to the pybsddb web documentation for the modern object 

oriented DbEnv & Db object BerkeleyDB interface.

Include a note about Sleepycat's BerkeleyDB license with regards to
distributing it within non-opensource applications and include a link
to their website for license details.

Document that 'r' is the default flag for the legacy bsddb btopen(),
hashopen(), and rnopen() functions.  This is apparently different than the
dbm libraries in other languages according to Bug #732951.  Changing
the default from 'r' to 'c' would break backwards compatibility with
legacy bsddb applications; documenting the default should suffice.
This commit is contained in:
Gregory P. Smith 2003-05-28 07:56:45 +00:00
parent 62df044885
commit 5772513f0f
1 changed files with 25 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
Doc/lib/libbsddb.tex
View File

@ -14,17 +14,28 @@ dictionaries. Keys and values must be strings, however, so to use
other objects as keys or to store other kinds of objects the user must other objects as keys or to store other kinds of objects the user must
serialize them somehow, typically using marshal.dumps or pickle.dumps. serialize them somehow, typically using marshal.dumps or pickle.dumps.
There are two incompatible versions of the underlying library. Starting with Python 2.3 the \module{bsddb} module requires the
Version 1.85 is widely available, but has some known bugs. Version 2 Berkeley DB library version 3.1 or later (it is known to work with 3.1
is not quite as widely used, but does offer some improvements. The thru 4.1 at the time of this writing).
\module{bsddb} module uses the 1.85 interface. Starting with Python
2.0, the \program{configure} script can usually determine the NOTE: BerkeleyDB has its own license which may apply to you if you
version of the library which is available and build it correctly. If intend to distribute your application outside of your organization in
you have difficulty getting \program{configure} to do the right thing, a non-opensource manner. Visit Sleepycat Software's website to read
run it with the \longprogramopt{help} option to get information about the full license.
additional options that can help. On Windows, you will need to define
the \code{HAVE_DB_185_H} macro if you are building Python from source \begin{seealso}
and using version 2 of the DB library. \seeurl{http://pybsddb.sourceforge.net/}{Website with documentation
for the new python Berkeley DB interface that closely mirrors the
sleepycat object oriented interface provided in Berkeley DB 3 and 4.}
\seeurl{http://www.sleepycat.com/}{Sleepycat Software produces the
modern Berkeley DB library. They offer support and sell licenses for
proprietary software using BerkeleyDB.}
\end{seealso}
The following is a description of the legacy \module{bsddb} interface
compatible with the old python bsddb module. For details about the more
modern Db and DbEnv object oriented interface see the above mentioned
pybsddb URL.
The \module{bsddb} module defines the following functions that create The \module{bsddb} module defines the following functions that create
objects that access the appropriate type of Berkeley DB file. The objects that access the appropriate type of Berkeley DB file. The
@ -41,7 +52,7 @@ Open the hash format file named \var{filename}. Files never intended
to be preserved on disk may be created by passing \code{None} as the to be preserved on disk may be created by passing \code{None} as the
\var{filename}. The optional \var{filename}. The optional
\var{flag} identifies the mode used to open the file. It may be \var{flag} identifies the mode used to open the file. It may be
\character{r} (read only), \character{w} (read-write), \character{r} (read only, default), \character{w} (read-write) ,
\character{c} (read-write - create if necessary) or \character{c} (read-write - create if necessary) or
\character{n} (read-write - truncate to zero length). The other \character{n} (read-write - truncate to zero length). The other
arguments are rarely used and are just passed to the low-level arguments are rarely used and are just passed to the low-level
@ -57,7 +68,7 @@ Open the btree format file named \var{filename}. Files never intended
to be preserved on disk may be created by passing \code{None} as the to be preserved on disk may be created by passing \code{None} as the
\var{filename}. The optional \var{filename}. The optional
\var{flag} identifies the mode used to open the file. It may be \var{flag} identifies the mode used to open the file. It may be
\character{r} (read only), \character{w} (read-write), \character{r} (read only, default), \character{w} (read-write),
\character{c} (read-write - create if necessary) or \character{c} (read-write - create if necessary) or
\character{n} (read-write - truncate to zero length). The other \character{n} (read-write - truncate to zero length). The other
arguments are rarely used and are just passed to the low-level dbopen arguments are rarely used and are just passed to the low-level dbopen
@ -73,7 +84,7 @@ Open a DB record format file named \var{filename}. Files never intended
to be preserved on disk may be created by passing \code{None} as the to be preserved on disk may be created by passing \code{None} as the
\var{filename}. The optional \var{filename}. The optional
\var{flag} identifies the mode used to open the file. It may be \var{flag} identifies the mode used to open the file. It may be
\character{r} (read only), \character{w} (read-write), \character{r} (read only, default), \character{w} (read-write),
\character{c} (read-write - create if necessary) or \character{c} (read-write - create if necessary) or
\character{n} (read-write - truncate to zero length). The other \character{n} (read-write - truncate to zero length). The other
arguments are rarely used and are just passed to the low-level dbopen arguments are rarely used and are just passed to the low-level dbopen