Mercurial > hg > xemacs-beta
diff man/lispref/databases.texi @ 0:376386a54a3c r19-14
Import from CVS: tag r19-14
author | cvs |
---|---|
date | Mon, 13 Aug 2007 08:45:50 +0200 |
parents | |
children | 850242ba4a81 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/man/lispref/databases.texi Mon Aug 13 08:45:50 2007 +0200 @@ -0,0 +1,80 @@ +@c -*-texinfo-*- +@c This is part of the XEmacs Lisp Reference Manual. +@c Copyright (C) 1996 Ben Wing. +@c See the file lispref.texi for copying conditions. +@setfilename ../../info/databases.info +@node Databases, Processes, Range Tables, top +@chapter Databases +@cindex database + +@defun databasep object +This function returns non-@code{nil} if @var{object} is a database. +@end defun + +@menu +* Connecting to a Database:: +* Working With a Database:: +* Other Database Functions:: +@end menu + +@node Connecting to a Database +@section Connecting to a Database + +@defun open-database file &optional type subtype access mode +This function opens database @var{file}, using database method +@var{type} and @var{subtype}, with access rights @var{access} and +permissions @var{mode}. @var{access} can be any combination of @code{r} +@code{w} and @code{+}, for read, write, and creation flags. +@end defun + +@defun close-database obj +This function closes database @var{obj}. +@end defun + +@defun database-live-p obj +This function returns @code{t} iff @var{obj} is an active database, else +@code{nil}. +@end defun + +@node Working With a Database +@section Working With a Database + +@defun get-database key dbase &optional default +This function finds the value for @var{key} in @var{database}. If there is no +corresponding value, @var{default} is returned (@code{nil} if @var{default} is +omitted). +@end defun + +@defun map-database function dbase +This function maps @var{function} over entries in @var{database}, +calling it with two args, each key and value in the database. +@end defun + +@defun put-database key val dbase &optional replace +This function stores @var{key} and @var{val} in @var{database}. If +optional fourth arg @var{replace} is non-@code{nil}, replace any +existing entry in the database. +@end defun + +@defun remove-database key dbase +This function removes @var{key} from @var{database}. +@end defun + +@node Other Database Functions +@section Other Database Functions + +@defun database-file-name obj +This function returns the filename associated with the database @var{obj}. +@end defun + +@defun database-last-error &optional obj +This function returns the last error associated with database @var{obj}. +@end defun + +@defun database-subtype obj +This function returns the subtype of database @var{obj}, if any. +@end defun + +@defun database-type obj +This function returns the type of database @var{obj}. +@end defun