Mercurial > hg > xemacs-beta
annotate man/lispref/databases.texi @ 5791:9fae6227ede5
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up
pointers to all nodes. See xemacs-patches message with ID
<5315f7bf.sHpFD7lXYR05GH6E%james@xemacs.org>.
| author | Jerry James <james@xemacs.org> |
|---|---|
| date | Thu, 27 Mar 2014 08:59:03 -0600 |
| parents | 576fb035e263 |
| children |
| rev | line source |
|---|---|
| 428 | 1 @c -*-texinfo-*- |
| 2 @c This is part of the XEmacs Lisp Reference Manual. | |
| 3 @c Copyright (C) 1996 Ben Wing. | |
| 4 @c See the file lispref.texi for copying conditions. | |
| 5 @setfilename ../../info/databases.info | |
|
5791
9fae6227ede5
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up
Jerry James <james@xemacs.org>
parents:
444
diff
changeset
|
6 @node Databases, Processes, Range Tables, Top |
| 428 | 7 @chapter Databases |
| 8 @cindex database | |
| 9 | |
| 10 @defun databasep object | |
| 11 This function returns non-@code{nil} if @var{object} is a database. | |
| 12 @end defun | |
| 13 | |
| 14 @menu | |
| 15 * Connecting to a Database:: | |
| 16 * Working With a Database:: | |
| 17 * Other Database Functions:: | |
| 18 @end menu | |
| 19 | |
|
5791
9fae6227ede5
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up
Jerry James <james@xemacs.org>
parents:
444
diff
changeset
|
20 @node Connecting to a Database, Working With a Database, Databases, Databases |
| 428 | 21 @section Connecting to a Database |
| 22 | |
| 23 @defun open-database file &optional type subtype access mode | |
| 24 This function opens database @var{file}, using database method | |
| 25 @var{type} and @var{subtype}, with access rights @var{access} and | |
| 26 permissions @var{mode}. @var{access} can be any combination of @code{r} | |
| 27 @code{w} and @code{+}, for read, write, and creation flags. | |
| 28 | |
| 442 | 29 @var{type} can have the value @code{'dbm} or @code{'berkeley-db} to |
| 428 | 30 select the type of database file to use. (Note: XEmacs may not |
| 31 support both of these types.) | |
| 32 | |
| 33 For a @var{type} of @code{'dbm}, there are no subtypes, so | |
| 442 | 34 @var{subtype} should be @code{nil}. |
| 428 | 35 |
| 442 | 36 For a @var{type} of @code{'berkeley-db}, the following subtypes are |
| 428 | 37 available: @code{'hash}, @code{'btree}, and @code{'recno}. See the |
| 444 | 38 manpages for the Berkeley DB functions for more information about these |
| 428 | 39 types. |
| 40 @end defun | |
| 41 | |
| 444 | 42 @defun close-database database |
| 43 This function closes database @var{database}. | |
| 428 | 44 @end defun |
| 45 | |
| 444 | 46 @defun database-live-p object |
| 47 This function returns @code{t} if @var{object} is an active database, else | |
| 428 | 48 @code{nil}. |
| 49 @end defun | |
| 50 | |
|
5791
9fae6227ede5
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up
Jerry James <james@xemacs.org>
parents:
444
diff
changeset
|
51 @node Working With a Database, Other Database Functions, Connecting to a Database, Databases |
| 428 | 52 @section Working With a Database |
| 53 | |
| 444 | 54 @defun get-database key database &optional default |
| 428 | 55 This function finds the value for @var{key} in @var{database}. If there is no |
| 56 corresponding value, @var{default} is returned (@code{nil} if @var{default} is | |
| 57 omitted). | |
| 58 @end defun | |
| 59 | |
| 444 | 60 @defun map-database function database |
| 428 | 61 This function maps @var{function} over entries in @var{database}, |
| 62 calling it with two args, each key and value in the database. | |
| 63 @end defun | |
| 64 | |
| 444 | 65 @defun put-database key value database &optional replace |
| 66 This function stores @var{key} and @var{value} in @var{database}. | |
| 67 If optional fourth arg @var{replace} is non-@code{nil}, replace any | |
| 428 | 68 existing entry in the database. |
| 69 @end defun | |
| 70 | |
| 444 | 71 @defun remove-database key database |
| 428 | 72 This function removes @var{key} from @var{database}. |
| 73 @end defun | |
| 74 | |
|
5791
9fae6227ede5
Silence texinfo 5.2 warnings, primarily by adding next, prev, and up
Jerry James <james@xemacs.org>
parents:
444
diff
changeset
|
75 @node Other Database Functions, , Working With a Database, Databases |
| 428 | 76 @section Other Database Functions |
| 77 | |
| 444 | 78 @defun database-file-name database |
| 79 This function returns the filename associated with @var{database}. | |
| 428 | 80 @end defun |
| 81 | |
| 444 | 82 @defun database-last-error &optional database |
| 83 This function returns the last error associated with @var{database}. | |
| 428 | 84 @end defun |
| 85 | |
| 444 | 86 @defun database-subtype database |
| 87 This function returns the subtype of @var{database}, if any. | |
| 428 | 88 @end defun |
| 89 | |
| 444 | 90 @defun database-type database |
| 91 This function returns the type of @var{database}. | |
| 428 | 92 @end defun |