The cl-tokyo-cabinet Reference Manual

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-tokyo-cabinet Reference Manual

This is the cl-tokyo-cabinet Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 04:14:23 2022 GMT+0.

Table of Contents


1 Introduction


Introduction

The cl-tokyo-cabinet system provides access to the Tokyo Cabinet DBM
library by Mikio Hirabayashi, via CFFI. See http://fallabs.com/tokyocabinet/

This project started as an experiment to see what Tokyo Cabinet
performance would be like when used from Common Lisp. Most of the BDB
and hash database functionality are implemented. The API is divided
into two parts; a low-level FFI package which is a direct CFFI
translation of the Tokyo Cabinet functions and a higher level, more
Lisp-centric generic function API on top of that.

Having now benchmarked insertion speed against equivalent code using
the C BDB API, the results are encouraging (see the perf directory for
results). The Lisp API produced a byte-identical database in a
wall-time of between 1.1x and 1.6x that taken by the C API (median
of 7 runs each).


Future work

 - Duplicated record API for B+ tree databases (requires TCLIST C API).
 - Range operations for B+ tree databases (requires TCLIST C API).
 - Implement the table database API.


Installation

cl-tokyo-cabinet uses ASDF for system definition. Copy or symlink
cl-tokyo-cabinet.asd (and optionally cl-tokyo-cabinet-test.asd) to
your asdf:*central-registry* and load cl-tokyo-cabinet with the
asdf:operate function:

 (asdf:operate 'asdf:load-op :cl-tokyo-cabinet)

or with the equivalent deoxybyte-systems:load-system function:

 (dxs:load-system :cl-tokyo-cabinet)


Tests

To run the unit and regression tests you need to have LIFT,
deoxybyte-io and deoxybyte-utilities installed. Run the tests with the
asdf:operate function:

 (asdf:operate 'asdf:test-op :cl-tokyo-cabinet)

or with the equivalent deoxybyte-systems:test-system function:

 (dxs:test-system :cl-tokyo-cabinet)

cl-tokyo-cabinet is tested using:

 - SBCL 1.1.14 x86_64
 - Tokyo Cabinet 1.4.48


Documentation

See the Lisp docstrings, particularly the package docstrings for an
overview. HTML documentation may be generated with the command:

 (dxs:document-system :cl-tokyo-cabinet)

at the REPL, provided that CLDOC is installed.


Dependencies

deoxybyte-systems       git://github.com/keithj/deoxybyte-systems.git

CFFI                    http://common-lisp.net/project/cffi/


Optional dependencies

deoxybyte-utilities     git://github.com/keithj/deoxybyte-utilities.git
deoxybyte-io            git://github.com/keithj/deoxybyte-io.git

LIFT                    http://common-lisp.net/project/lift/
CLDOC                   http://common-lisp.net/project/cldoc/


2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 cl-tokyo-cabinet

Author

Keith James

License

New BSD

Version

0.3.0

Dependencies
  • deoxybyte-systems (system)., at least version "1.0.0"
  • cffi (system)., at least version "0.10.3"
Source

cl-tokyo-cabinet.asd.

Child Component

cl-tokyo-cabinet (module).


3 Modules

Modules are listed depth-first from the system components tree.


Previous: , Up: Modules   [Contents][Index]

3.1 cl-tokyo-cabinet/cl-tokyo-cabinet

Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (system).

Child Components

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


4.1.1 cl-tokyo-cabinet/cl-tokyo-cabinet.asd

Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (system).

ASDF Systems

cl-tokyo-cabinet.


4.1.2 cl-tokyo-cabinet/cl-tokyo-cabinet/package.lisp

Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (module).

Packages

4.1.3 cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-ffi.lisp

Dependency

package.lisp (file).

Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (module).

Public Interface

4.1.4 cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet.lisp

Dependencies
Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (module).

Public Interface
Internals

4.1.5 cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-bdb.lisp

Dependencies
Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (module).

Public Interface
Internals

4.1.6 cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-hdb.lisp

Dependencies
Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (module).

Public Interface
Internals

4.1.7 cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-fdb.lisp

Dependencies
Source

cl-tokyo-cabinet.asd.

Parent Component

cl-tokyo-cabinet (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

5.1 tokyo-cabinet-ffi

CFFI interface to Tokyo Cabinet functions. The original C function names are preserved.

Source

package.lisp.

Use List
  • cffi.
  • common-lisp.
Used By List

tokyo-cabinet.

Public Interface

Previous: , Up: Packages   [Contents][Index]

5.2 tokyo-cabinet

A Lisp-style abstract interface to Tokyo
Cabinet. The original C function names are not preserved (see the :tokyo-cabinet-ffi package for functions that do preserve the nomenclature).

Source

package.lisp.

Nickname

tc

Use List
Public Interface
Internals

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

6.1 Public Interface


Next: , Previous: , Up: Public Interface   [Contents][Index]

6.1.1 Constants

Constant: +bdbcpafter+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +bdbcpbefore+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +bdbcpcurrent+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tceclose+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tceinvalid+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcekeep+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcelock+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcemeta+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcemisc+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcemkdir+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcemmap+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcenofile+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcenoperm+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcenorec+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tceopen+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tceread+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcerename+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcerhead+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcermdir+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tceseek+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcestat+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcesuccess+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcesync+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcethread+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcetrunc+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Constant: +tcewrite+
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.


6.1.2 Macros

Macro: with-database ((var filespec type &rest mode) &body body)

Evaluates BODY with VAR bound to an open database.

Arguments:

- var (symbol): The binding for the new database object.
- filespec (filespec): The database file.
- type (symbol): A symbol that names a TC database class.

Rest:

- mode (symbols): :READ :WRITE :CREATE :TRUNCATE
:NOLOCK :NOBLOCK and :TSYNC

See the TC documentation for the meaning of the mode arguments.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Macro: with-iterator ((var db) &body body)

Evaluates BODY on with VAR bound to a new, open iterator on DB.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Macro: with-transaction ((db) &body body)

Evaluates BODY in the context of a transaction on DB. If no transaction is in progress, a new one is started. If a transaction is already in progress, BODY is evaluated in its context. If an error occurs, the transaction will rollback, otherwise it will commit.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.


6.1.3 Ordinary functions

Function: tcbdbclose (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcopy (bdb path)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurdel (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurfirst (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurjump (cur kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurjump2 (cur kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurkey (cur sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurkey2 (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurkey3 (cur sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurlast (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurnew (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurnext (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurout (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurprev (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurput (cur vbuf vsiz cpmode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurput2 (cur vstr cpmode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurrec (cur kxstr vxstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurval (cur sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurval2 (cur)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbcurval3 (cur sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbdel (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbecode (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdberrmsg (ecode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbfsiz (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbget (bdb kbuf ksiz sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbget2 (bdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbnew ()
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbopen (bdb path mode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdboptimize (bdb lmemb nmemb bnum apow fpow opts)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbout (bdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbout2 (bdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbout3 (bdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbpath (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbput (bdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbput2 (bdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputcat (bdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputcat2 (bdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputdup (bdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputdup2 (bdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputdup3 (bdb kbuf ksiz vals)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputkeep (bdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbputkeep2 (bdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbrnum (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbsetcache (bdb lcnum ncnum)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbsetcmpfunc (bdb cmp cmpop)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbsetxmsiz (bdb xmsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbsync (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbtranabort (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbtranbegin (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbtrancommit (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbtune (bdb lmemb nmemb bnum apow fpow opts)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbvanish (bdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbvnum (bdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbvnum2 (bdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbvsiz (bdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcbdbvsiz2 (bdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbadddouble (fdb id num)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbaddint (fdb id num)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbclose (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbcopy (fdb path)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbdel (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbecode (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdberrmsg (ecode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbfsiz (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbget (fdb id sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbget2 (fdb kbuf ksiz sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbget3 (fdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbiterinit (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbiternext (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbiternext2 (fdb sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbiternext3 (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbnew ()
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbopen (fdb path omode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdboptimize (fdb width limsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbout (fdb id)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbout2 (fdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbout3 (fdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbpath (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbput (fdb id vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbput2 (fdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbput3 (fdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbputcat (fdb id vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbputcat2 (fdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbputcat3 (fdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbputkeep (fdb id vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbputkeep2 (fdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbputkeep3 (fdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbrange (fdb lower upper max np)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbrnum (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbsync (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbtranabort (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbtranbegin (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbtrancommit (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbtune (fdb width limsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbvanish (fdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbvsiz (fdb id)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbvsiz2 (fdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tcfdbvsiz3 (fdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbclose (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbcopy (hdb path)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbdel (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbecode (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdberrmsg (ecode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbfsiz (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbget (hdb kbuf ksiz sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbget2 (hdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbiterinit (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbiternext (hdb sp)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbiternext2 (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbiternext3 (hdb kxstr vxstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbnew ()
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbopen (hdb path mode)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdboptimize (hdb bnum apow fpow opts)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbout (hdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbout2 (hdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbpath (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbput (hdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbput2 (hdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbputasync (hdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbputasync2 (hdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbputcat (hdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbputcat2 (hdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbputkeep (hdb kbuf ksiz vbuf vsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbputkeep2 (hdb kstr vstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbrnum (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbsetcache (hdb rcnum)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbsetxmsiz (hdb xmsiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbsync (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbtranabort (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbtranbegin (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbtrancommit (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbtune (hdb bnum apow fpow opts)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbvanish (hdb)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbvsiz (hdb kbuf ksiz)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.

Function: tchdbvsiz2 (hdb kstr)
Package

tokyo-cabinet-ffi.

Source

tokyo-cabinet-ffi.lisp.


6.1.4 Generic functions

Generic Function: dbm-begin (db)

Begins a transaction with DB.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-begin ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-begin ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-begin ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-cache (db &rest args &key records leaf non-leaf)

Sets the caching parameters of DB. These are
described in the TC documentation.

The keyword arguments for B+ tree databases are:

- :LEAF : The number of leaf nodes to cache. Defaults to 1024.
- :NON-LEAF : The number of non-leaf nodes to cache. Defaults to 512.

The keyword arguments for hash databases are:

- :RECORDS : The number of records to cache. Defaults to 0.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-cache ((db tc-hdb) &key records)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-cache ((db tc-bdb) &key leaf non-leaf)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-close (db)

Closes an open TC database.

Arguments:

- db (object): A TC dbm object.

Returns:

- T on success, or NIL otherwise.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-close ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-close ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-close ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-commit (db)

Commits a transaction with DB.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-commit ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-commit ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-commit ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-delete (db)

Deletes a TC database. If open, implicitly closes it first.

Arguments:

- db (object): A TC dbm object.

Returns:

- NIL .

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-delete ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-delete ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-delete ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-file-size (db)

Returns the size of the DB file in bytes.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-file-size ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-file-size ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-file-size ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-get (db key &optional type)

Returns the value under KEY in DB. Type may be one
of :STRING or :OCTETS , depending on how the value is to be treated. :STRING indicates that the value should be converted to a Lisp string, while :OCTETS indicates that the byte vector should be returned.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-get ((db tc-fdb) (key vector) &optional type)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-get ((db tc-fdb) (key integer) &optional type)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-get ((db tc-fdb) (key string) &optional type)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-get ((db tc-hdb) (key vector) &optional type)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-get ((db tc-hdb) (key integer) &optional type)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-get ((db tc-hdb) (key string) &optional type)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-get ((db tc-bdb) (key vector) &optional type)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-get ((db tc-bdb) (key integer) &optional type)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-get ((db tc-bdb) (key string) &optional type)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-num-records (db)

Returns the number of records in DB.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-num-records ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-num-records ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-num-records ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-open (db filespec &rest mode)

Opens a new, or existing TC database.

Arguments:

- db (object): A TC dbm object.
- filespec (string): A pathname designator for the database file.

Rest:

- mode (list symbol): A list of mode keywords used when opening the file. The modes are :READ :WRITE :CREATE :TRUNCATE :NOBLOCK :NOLOCK and :TSYNC which correspond to those described in the TC specification.

Returns:

- The TC dbm object, now open.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-open ((db tc-fdb) filename &rest mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-open ((db tc-hdb) filename &rest mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-open ((db tc-bdb) filespec &rest mode)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-optimize (db &rest args &key width limsiz bucket-size rec-align free-pool options leaf non-leaf opts &allow-other-keys)

Sets the DB optimization parameters on an open
database. These are described in the TC documentation.

The keyword arguments for B+ tree databases are:

- :LEAF (fixnum) : Sets the number of leaf nodes.
- :NON-LEAF (fixnum) : Sets the number of non-leaf nodes.
- :BUCKET-SIZE (fixnum) : Sets the bucket
- :REC-ALIGN (fixnum) : A power of 2 indicating record alignment.
- :FREE-POOL (fixnum): A power of 2 indicating the size of the free record pool.

- :OPTS (list symbol): A list of keywords indicating optional database parameters.

The keyword arguments for hash databases are:

:BUCKET-SIZE :REC-ALIGN :FREE-POOL and :OPTS , as above.

In both cases the :OPTS value is a list of one or more of

- :LARGE : Use a 64-bit bucket array to allow datbases > 2Gb.
- :DEFLATE : Use deflate compression.
- :BZIP : Use bzip compression.
- :TCBS : Use tcbs compression.
- :DEFAULTS : Use the current settings.

For example:

;;; (dbm-optimize db :leaf 512 :non-leaf 256 :bucket-size 100000000 ;;; :rec-align 4 :free-pool 10 :opts ’(:large :deflate))

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-optimize ((db tc-fdb) &key width limsiz &allow-other-keys)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-optimize ((db tc-hdb) &key bucket-size rec-align free-pool options &allow-other-keys)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-optimize ((db tc-bdb) &key leaf non-leaf bucket-size rec-align free-pool opts &allow-other-keys)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-put (db key value &key mode)

Inserts KEY and VALUE into DB. MODE varies with DB
class.

Arguments:

- db (object): A TC database object.
- key (object): A key under which to insert.
- value (object): A value to insert under key.

Key:

- :mode (symbol): A symbol designating one of the TC insertion modes: replace, keep, concat, duplicate, async etc.

Valid modes for B+ tree databases are:

- :REPLACE : If a record with the same key exists in the database, it is overwritten.
- :KEEP : If a record with the same key exists in the database, this function has no effect.
- :CONCAT : Concatenates a value at the end of the existing record in the database. If there is no corresponding record, a new record is created.
- :DUPLICATE : Adds a record to the database, allowing duplication of keys. If a record with the same key exists in the database, the new record is placed after the existing one.

Valid modes for hash databases are:

:REPLACE , :KEEP and :CONCAT , as above. Additionally:

- :ASYNC : Collects inserts into a buffer and then inserts them asynchronously, in one operation.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-put ((db tc-fdb) (key integer) (value vector) &key mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-put ((db tc-fdb) (key integer) (value string) &key mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-put ((db tc-fdb) (key string) (value vector) &key mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-put ((db tc-fdb) (key string) (value string) &key mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-put ((db tc-fdb) (key vector) (value string) &key mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-put ((db tc-fdb) (key vector) (value vector) &key mode)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-put ((db tc-hdb) (key integer) (value vector) &key mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-put ((db tc-hdb) (key integer) (value string) &key mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-put ((db tc-hdb) (key string) (value vector) &key mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-put ((db tc-hdb) (key string) (value string) &key mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-put ((db tc-hdb) (key vector) (value string) &key mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-put ((db tc-hdb) (key vector) (value vector) &key mode)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-put ((db tc-bdb) (key integer) (value vector) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-put ((db tc-bdb) (key integer) (value string) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-put ((db tc-bdb) (key string) (value vector) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-put ((db tc-bdb) (key string) (value string) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-put ((db tc-bdb) (key vector) (value string) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-put ((db tc-bdb) (key vector) (value vector) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-rem (db key &key remove-dups)

Removes the value under KEY in DB. If REMOVE-DUPS
is T, duplicate values will be removed from a B+ tree database.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-rem ((db tc-fdb) (key integer) &key remove-dups)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-rem ((db tc-fdb) (key string) &key remove-dups)
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-rem ((db tc-hdb) (key integer) &key remove-dups)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-rem ((db tc-hdb) (key string) &key remove-dups)
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-rem ((db tc-bdb) (key vector) &key remove-dups)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-rem ((db tc-bdb) (key integer) &key remove-dups)
Source

tokyo-cabinet-bdb.lisp.

Method: dbm-rem ((db tc-bdb) (key string) &key remove-dups)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-vanish (db)

Removes all records from DB.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-vanish ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-vanish ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-vanish ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-xmsize (db size)

Sets the DB extra mapped memory to SIZE bytes.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-xmsize ((db tc-hdb) (size integer))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-xmsize ((db tc-bdb) (size integer))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-close (iterator)

Closes ITERATOR. Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-close ((iter fdb-iterator))
Source

tokyo-cabinet-fdb.lisp.

Method: iter-close ((iter hdb-iterator))
Source

tokyo-cabinet-hdb.lisp.

Method: iter-close ((iter bdb-iterator))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-first (iterator)

Moves ITERATOR to the first record and returns T,
or NIL if the database is empty. Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-first ((iter fdb-iterator))
Source

tokyo-cabinet-fdb.lisp.

Method: iter-first ((iter hdb-iterator))
Source

tokyo-cabinet-hdb.lisp.

Method: iter-first ((iter bdb-iterator))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-get (iterator &optional type)

Returns the current value at ITERATOR. Type may be
one of :STRING or :OCTETS , depending on how the value is to be treated. :STRING indicates that the value should be converted to a Lisp string, while :OCTETS indicates that the byte vector should be returned.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-get ((iter fdb-iterator) &optional type)
Source

tokyo-cabinet-fdb.lisp.

Method: iter-get ((iter hdb-iterator) &optional type)
Source

tokyo-cabinet-hdb.lisp.

Method: iter-get ((iter bdb-iterator) &optional type)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-jump (iterator key)

Moves ITERATOR to the record at KEY. Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-jump ((iter bdb-iterator) (key vector))
Source

tokyo-cabinet-bdb.lisp.

Method: iter-jump ((iter bdb-iterator) (key integer))
Source

tokyo-cabinet-bdb.lisp.

Method: iter-jump ((iter bdb-iterator) (key string))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-key (iterator &optional type)

Returns current key at the ITERATOR position. Type
may be one of :STRING or :OCTETS , depending on how the value is to be treated. :STRING indicates that the value should be converted to a Lisp string, while :OCTETS indicates that the byte vector should be returned.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-key ((iter fdb-iterator) &optional type)
Source

tokyo-cabinet-fdb.lisp.

Method: iter-key ((iter hdb-iterator) &optional type)
Source

tokyo-cabinet-hdb.lisp.

Method: iter-key ((iter bdb-iterator) &optional type)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-last (iterator)

Moves ITERATOR to the last record and returns T, or
NIL if the database is empty. Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-last ((iter bdb-iterator))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-next (iterator)

Moves ITERATOR to the next record and returns T, or NIL if already at the last record.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-next ((iter fdb-iterator))
Source

tokyo-cabinet-fdb.lisp.

Method: iter-next ((iter hdb-iterator))
Source

tokyo-cabinet-hdb.lisp.

Method: iter-next ((iter bdb-iterator))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-open (db)

Opens an iterator on DB.

Arguments:

- db (object): A TC dbm object.

Returns:
- A TC iterator object.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-open ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: iter-open ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: iter-open ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-prev (iterator)

Moves ITERATOR to the previous record and returns
T, or NIL if already at the first record. Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-prev ((iter bdb-iterator))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-put (iterator value &key mode)

Inserts VALUE around ITERATOR. Mode may be one
of :CURRENT , :BEFORE or :AFTER . Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-put ((iter bdb-iterator) (value vector) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Method: iter-put ((iter bdb-iterator) (value string) &key mode)
Source

tokyo-cabinet-bdb.lisp.

Generic Function: iter-rem (iterator)

Removed the record at the ITERATOR position and advances ITERATOR, if possible. Only effective for B+ tree databases.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: iter-rem ((iter bdb-iterator))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: set-comparator (db fn)

Sets the DB comparator function to that given by symbol FN.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: set-comparator ((db tc-bdb) (comparator symbol))
Source

tokyo-cabinet-bdb.lisp.


6.1.5 Standalone methods

Method: initialize-instance :after ((db tc-bdb) &key)
Source

tokyo-cabinet-bdb.lisp.

Method: initialize-instance :after ((db tc-hdb) &key)
Source

tokyo-cabinet-hdb.lisp.

Method: initialize-instance :after ((db tc-fdb) &key)
Source

tokyo-cabinet-fdb.lisp.


6.1.6 Conditions

Condition: dbm-error
Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: error-code

The error code provided by TC.

Initform

(quote nil)

Initargs

:error-code

Readers

error-code-of.

Writers

This slot is read-only.

Slot: error-msg

The error message provided by TC.

Initform

(quote nil)

Initargs

:error-msg

Readers

error-msg-of.

Writers

This slot is read-only.

Slot: text

Any additional message provided by the CL API.

Initform

(quote nil)

Initargs

:text

Readers

text.

Writers

This slot is read-only.


6.2 Internals


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.1 Special variables

Special Variable: *in-transaction-p*

Bound when in a transaction.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.


6.2.2 Macros

Macro: with-string-value ((value-ptr initform) &body body)

Helper macro for managing string values.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.3 Ordinary functions

Function: %bdb-iter-mode (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-bdb.lisp.

Function: %bdb-put-fn (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-bdb.lisp.

Function: %bdb-str-put-fn (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-bdb.lisp.

Function: %builtin-comparator (type)
Package

tokyo-cabinet.

Source

tokyo-cabinet-bdb.lisp.

Function: %fdb-put-fn (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-fdb.lisp.

Function: %fdb-str-put-fn (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-fdb.lisp.

Function: %hdb-put-fn (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-hdb.lisp.

Function: %hdb-str-put-fn (mode)
Package

tokyo-cabinet.

Source

tokyo-cabinet-hdb.lisp.

Function: check-open-mode (mode)

Checks the list MODE for valid and consistent database opening arguments.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: copy-foreign-value (value-ptr size-ptr)
Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: get-int32->octets (db key fn)

Returns a value from DB under KEY using FN where the key is a 32-bit integer and the value an octet vector.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: get-int32->string (db key fn)

Returns a value from DB under KEY using FN where the key is a 32-but integer and the value a string.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: get-octets->octets (db key fn)

Returns a value from DB under KEY using FN where the key and value are octet vectors.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: get-octets->string (db key fn)

Returns a value from DB under KEY using FN where the key is a vector of octets and value is a string.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: get-string->octets (db key fn)

Returns a value from DB under KEY using FN where the key is a string and the value an octet vector. Note that for the key we allocate a foreign string that is not null-terminated.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: get-string->string (db key fn)

Returns a value from DB under KEY using FN where the key and value are strings.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: put-int32->octets (db key value fn)

Inserts VALUE into DB under KEY using FN where the key is a 32-bit integer and the value is an octet vector.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: put-int32->string (db key value fn)

Inserts VALUE into DB under KEY using FN where the key is a 32-bit integer and the value is a string.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: put-octets->octets (db key value fn)

Inserts VALUE into DB under KEY using FN where the key and value are octet vectors.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: put-octets->string (db key value fn)

Inserts VALUE into DB under KEY using FN where the key is an octet vector and the value is a string.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: put-string->octets (db key value fn)

Inserts VALUE into DB under KEY using FN where the key is a string and the value an octet vector. Note that for the key we allocate a foreign string that is not null-terminated.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: put-string->string (db key value fn)

Inserts VALUE into DB under KEY using FN where the key and value are strings.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: rem-int32->value (db key fn)

Removes value from DB under KEY using FN where the key is a 32-bit integer.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: rem-octets->value (db key fn)

Removes value from DB under KEY using FN where the key is a vector of octets.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: rem-string->duplicates (db key fn)

Removes all values from DB under KEY using FN where the key is a string.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Function: rem-string->value (db key fn)

Removes value from DB under KEY using FN where the key is a string.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.4 Generic functions

Generic Reader: current-id-of (object)
Package

tokyo-cabinet.

Methods
Reader Method: current-id-of ((fdb-iterator fdb-iterator))

automatically generated reader method

Source

tokyo-cabinet.lisp.

Target Slot

current-id.

Generic Writer: (setf current-id-of) (object)
Package

tokyo-cabinet.

Methods
Writer Method: (setf current-id-of) ((fdb-iterator fdb-iterator))

automatically generated writer method

Source

tokyo-cabinet.lisp.

Target Slot

current-id.

Generic Function: dbm-abort (db)

Aborts a transaction with DB.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-abort ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-abort ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-abort ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Function: dbm-file-namestring (db)

Returns the name of the DB file.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: dbm-file-namestring ((db tc-fdb))
Source

tokyo-cabinet-fdb.lisp.

Method: dbm-file-namestring ((db tc-hdb))
Source

tokyo-cabinet-hdb.lisp.

Method: dbm-file-namestring ((db tc-bdb))
Source

tokyo-cabinet-bdb.lisp.

Generic Reader: error-code-of (condition)
Package

tokyo-cabinet.

Methods
Reader Method: error-code-of ((condition dbm-error))
Source

tokyo-cabinet.lisp.

Target Slot

error-code.

Generic Reader: error-msg-of (condition)
Package

tokyo-cabinet.

Methods
Reader Method: error-msg-of ((condition dbm-error))
Source

tokyo-cabinet.lisp.

Target Slot

error-msg.

Generic Reader: key-size-of (object)
Package

tokyo-cabinet.

Methods
Reader Method: key-size-of ((hdb-iterator hdb-iterator))

automatically generated reader method

Source

tokyo-cabinet.lisp.

Target Slot

key-size.

Generic Writer: (setf key-size-of) (object)
Package

tokyo-cabinet.

Methods
Writer Method: (setf key-size-of) ((hdb-iterator hdb-iterator))

automatically generated writer method

Source

tokyo-cabinet.lisp.

Target Slot

key-size.

Generic Function: maybe-raise-error (db &optional message &rest message-arguments)

Checks the DB handle for any error reported by TC
and raises a {define-condition dbm-error} if one has occurred by calling {defun raise-error} .

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: maybe-raise-error ((db tc-fdb) &optional message &rest message-arguments)
Source

tokyo-cabinet-fdb.lisp.

Method: maybe-raise-error ((db tc-hdb) &optional message &rest message-arguments)
Source

tokyo-cabinet-hdb.lisp.

Method: maybe-raise-error ((db tc-bdb) &optional message &rest message-arguments)
Source

tokyo-cabinet-bdb.lisp.

Generic Reader: next-key-of (object)
Package

tokyo-cabinet.

Methods
Reader Method: next-key-of ((hdb-iterator hdb-iterator))

automatically generated reader method

Source

tokyo-cabinet.lisp.

Target Slot

next-key.

Generic Writer: (setf next-key-of) (object)
Package

tokyo-cabinet.

Methods
Writer Method: (setf next-key-of) ((hdb-iterator hdb-iterator))

automatically generated writer method

Source

tokyo-cabinet.lisp.

Target Slot

next-key.

Generic Reader: ptr-of (object)
Generic Writer: (setf ptr-of) (object)
Package

tokyo-cabinet.

Methods
Reader Method: ptr-of ((tc-iterator tc-iterator))
Writer Method: (setf ptr-of) ((tc-iterator tc-iterator))

A TC pointer.

Source

tokyo-cabinet.lisp.

Target Slot

ptr.

Reader Method: ptr-of ((tc-dbm tc-dbm))
Writer Method: (setf ptr-of) ((tc-dbm tc-dbm))

A pointer to a TC native database object.

Source

tokyo-cabinet.lisp.

Target Slot

ptr.

Generic Function: raise-error (db &optional message &rest message-arguments)

Raises a {define-condition dbm-error} with
MESSAGE. MESSAGE may be a format template, in which case the rest of the arguments are taken to be format arguments for that template. The error code and TC error message are automatically obtained from the DB handle.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Methods
Method: raise-error ((db tc-fdb) &optional message &rest message-arguments)
Source

tokyo-cabinet-fdb.lisp.

Method: raise-error ((db tc-hdb) &optional message &rest message-arguments)
Source

tokyo-cabinet-hdb.lisp.

Method: raise-error ((db tc-bdb) &optional message &rest message-arguments)
Source

tokyo-cabinet-bdb.lisp.

Generic Reader: text (condition)
Package

tokyo-cabinet.

Methods
Reader Method: text ((condition dbm-error))
Source

tokyo-cabinet.lisp.

Target Slot

text.


Next: , Previous: , Up: Internals   [Contents][Index]

6.2.5 Classes

Class: bdb-iterator

A B+ tree database cursor.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Direct superclasses

tc-iterator.

Direct methods
Class: fdb-iterator

A fixed-length database iterator.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Direct superclasses

tc-iterator.

Direct methods
Direct slots
Slot: current-id
Readers

current-id-of.

Writers

(setf current-id-of).

Class: hdb-iterator

A hash database iterator.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Direct superclasses

tc-iterator.

Direct methods
Direct slots
Slot: next-key
Readers

next-key-of.

Writers

(setf next-key-of).

Slot: key-size
Readers

key-size-of.

Writers

(setf key-size-of).

Class: tc-dbm

A TC database.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: ptr

A pointer to a TC native database object.

Initargs

:ptr

Readers

ptr-of.

Writers

(setf ptr-of).

Class: tc-iterator

A TC database iterator, the superclass of both B+ tree cursors, hash and fixed-length iterators.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: ptr

A TC pointer.

Initargs

:ptr

Readers

ptr-of.

Writers

(setf ptr-of).


Previous: , Up: Internals   [Contents][Index]

6.2.6 Types

Type: int32 ()

The 32bit built-in DBM key type.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Type: int64 ()

The 64bit built-in DBM key type.

Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.

Type: octet ()
Package

tokyo-cabinet.

Source

tokyo-cabinet.lisp.


Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts


Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   %   (  
C   D   E   F   G   I   K   M   N   P   R   S   T   W  
Index Entry  Section

%
%bdb-iter-mode: Private ordinary functions
%bdb-put-fn: Private ordinary functions
%bdb-str-put-fn: Private ordinary functions
%builtin-comparator: Private ordinary functions
%fdb-put-fn: Private ordinary functions
%fdb-str-put-fn: Private ordinary functions
%hdb-put-fn: Private ordinary functions
%hdb-str-put-fn: Private ordinary functions

(
(setf current-id-of): Private generic functions
(setf current-id-of): Private generic functions
(setf key-size-of): Private generic functions
(setf key-size-of): Private generic functions
(setf next-key-of): Private generic functions
(setf next-key-of): Private generic functions
(setf ptr-of): Private generic functions
(setf ptr-of): Private generic functions
(setf ptr-of): Private generic functions

C
check-open-mode: Private ordinary functions
copy-foreign-value: Private ordinary functions
current-id-of: Private generic functions
current-id-of: Private generic functions

D
dbm-abort: Private generic functions
dbm-abort: Private generic functions
dbm-abort: Private generic functions
dbm-abort: Private generic functions
dbm-begin: Public generic functions
dbm-begin: Public generic functions
dbm-begin: Public generic functions
dbm-begin: Public generic functions
dbm-cache: Public generic functions
dbm-cache: Public generic functions
dbm-cache: Public generic functions
dbm-close: Public generic functions
dbm-close: Public generic functions
dbm-close: Public generic functions
dbm-close: Public generic functions
dbm-commit: Public generic functions
dbm-commit: Public generic functions
dbm-commit: Public generic functions
dbm-commit: Public generic functions
dbm-delete: Public generic functions
dbm-delete: Public generic functions
dbm-delete: Public generic functions
dbm-delete: Public generic functions
dbm-file-namestring: Private generic functions
dbm-file-namestring: Private generic functions
dbm-file-namestring: Private generic functions
dbm-file-namestring: Private generic functions
dbm-file-size: Public generic functions
dbm-file-size: Public generic functions
dbm-file-size: Public generic functions
dbm-file-size: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-get: Public generic functions
dbm-num-records: Public generic functions
dbm-num-records: Public generic functions
dbm-num-records: Public generic functions
dbm-num-records: Public generic functions
dbm-open: Public generic functions
dbm-open: Public generic functions
dbm-open: Public generic functions
dbm-open: Public generic functions
dbm-optimize: Public generic functions
dbm-optimize: Public generic functions
dbm-optimize: Public generic functions
dbm-optimize: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-put: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-rem: Public generic functions
dbm-vanish: Public generic functions
dbm-vanish: Public generic functions
dbm-vanish: Public generic functions
dbm-vanish: Public generic functions
dbm-xmsize: Public generic functions
dbm-xmsize: Public generic functions
dbm-xmsize: Public generic functions

E
error-code-of: Private generic functions
error-code-of: Private generic functions
error-msg-of: Private generic functions
error-msg-of: Private generic functions

F
Function, %bdb-iter-mode: Private ordinary functions
Function, %bdb-put-fn: Private ordinary functions
Function, %bdb-str-put-fn: Private ordinary functions
Function, %builtin-comparator: Private ordinary functions
Function, %fdb-put-fn: Private ordinary functions
Function, %fdb-str-put-fn: Private ordinary functions
Function, %hdb-put-fn: Private ordinary functions
Function, %hdb-str-put-fn: Private ordinary functions
Function, check-open-mode: Private ordinary functions
Function, copy-foreign-value: Private ordinary functions
Function, get-int32->octets: Private ordinary functions
Function, get-int32->string: Private ordinary functions
Function, get-octets->octets: Private ordinary functions
Function, get-octets->string: Private ordinary functions
Function, get-string->octets: Private ordinary functions
Function, get-string->string: Private ordinary functions
Function, put-int32->octets: Private ordinary functions
Function, put-int32->string: Private ordinary functions
Function, put-octets->octets: Private ordinary functions
Function, put-octets->string: Private ordinary functions
Function, put-string->octets: Private ordinary functions
Function, put-string->string: Private ordinary functions
Function, rem-int32->value: Private ordinary functions
Function, rem-octets->value: Private ordinary functions
Function, rem-string->duplicates: Private ordinary functions
Function, rem-string->value: Private ordinary functions
Function, tcbdbclose: Public ordinary functions
Function, tcbdbcopy: Public ordinary functions
Function, tcbdbcurdel: Public ordinary functions
Function, tcbdbcurfirst: Public ordinary functions
Function, tcbdbcurjump: Public ordinary functions
Function, tcbdbcurjump2: Public ordinary functions
Function, tcbdbcurkey: Public ordinary functions
Function, tcbdbcurkey2: Public ordinary functions
Function, tcbdbcurkey3: Public ordinary functions
Function, tcbdbcurlast: Public ordinary functions
Function, tcbdbcurnew: Public ordinary functions
Function, tcbdbcurnext: Public ordinary functions
Function, tcbdbcurout: Public ordinary functions
Function, tcbdbcurprev: Public ordinary functions
Function, tcbdbcurput: Public ordinary functions
Function, tcbdbcurput2: Public ordinary functions
Function, tcbdbcurrec: Public ordinary functions
Function, tcbdbcurval: Public ordinary functions
Function, tcbdbcurval2: Public ordinary functions
Function, tcbdbcurval3: Public ordinary functions
Function, tcbdbdel: Public ordinary functions
Function, tcbdbecode: Public ordinary functions
Function, tcbdberrmsg: Public ordinary functions
Function, tcbdbfsiz: Public ordinary functions
Function, tcbdbget: Public ordinary functions
Function, tcbdbget2: Public ordinary functions
Function, tcbdbnew: Public ordinary functions
Function, tcbdbopen: Public ordinary functions
Function, tcbdboptimize: Public ordinary functions
Function, tcbdbout: Public ordinary functions
Function, tcbdbout2: Public ordinary functions
Function, tcbdbout3: Public ordinary functions
Function, tcbdbpath: Public ordinary functions
Function, tcbdbput: Public ordinary functions
Function, tcbdbput2: Public ordinary functions
Function, tcbdbputcat: Public ordinary functions
Function, tcbdbputcat2: Public ordinary functions
Function, tcbdbputdup: Public ordinary functions
Function, tcbdbputdup2: Public ordinary functions
Function, tcbdbputdup3: Public ordinary functions
Function, tcbdbputkeep: Public ordinary functions
Function, tcbdbputkeep2: Public ordinary functions
Function, tcbdbrnum: Public ordinary functions
Function, tcbdbsetcache: Public ordinary functions
Function, tcbdbsetcmpfunc: Public ordinary functions
Function, tcbdbsetxmsiz: Public ordinary functions
Function, tcbdbsync: Public ordinary functions
Function, tcbdbtranabort: Public ordinary functions
Function, tcbdbtranbegin: Public ordinary functions
Function, tcbdbtrancommit: Public ordinary functions
Function, tcbdbtune: Public ordinary functions
Function, tcbdbvanish: Public ordinary functions
Function, tcbdbvnum: Public ordinary functions
Function, tcbdbvnum2: Public ordinary functions
Function, tcbdbvsiz: Public ordinary functions
Function, tcbdbvsiz2: Public ordinary functions
Function, tcfdbadddouble: Public ordinary functions
Function, tcfdbaddint: Public ordinary functions
Function, tcfdbclose: Public ordinary functions
Function, tcfdbcopy: Public ordinary functions
Function, tcfdbdel: Public ordinary functions
Function, tcfdbecode: Public ordinary functions
Function, tcfdberrmsg: Public ordinary functions
Function, tcfdbfsiz: Public ordinary functions
Function, tcfdbget: Public ordinary functions
Function, tcfdbget2: Public ordinary functions
Function, tcfdbget3: Public ordinary functions
Function, tcfdbiterinit: Public ordinary functions
Function, tcfdbiternext: Public ordinary functions
Function, tcfdbiternext2: Public ordinary functions
Function, tcfdbiternext3: Public ordinary functions
Function, tcfdbnew: Public ordinary functions
Function, tcfdbopen: Public ordinary functions
Function, tcfdboptimize: Public ordinary functions
Function, tcfdbout: Public ordinary functions
Function, tcfdbout2: Public ordinary functions
Function, tcfdbout3: Public ordinary functions
Function, tcfdbpath: Public ordinary functions
Function, tcfdbput: Public ordinary functions
Function, tcfdbput2: Public ordinary functions
Function, tcfdbput3: Public ordinary functions
Function, tcfdbputcat: Public ordinary functions
Function, tcfdbputcat2: Public ordinary functions
Function, tcfdbputcat3: Public ordinary functions
Function, tcfdbputkeep: Public ordinary functions
Function, tcfdbputkeep2: Public ordinary functions
Function, tcfdbputkeep3: Public ordinary functions
Function, tcfdbrange: Public ordinary functions
Function, tcfdbrnum: Public ordinary functions
Function, tcfdbsync: Public ordinary functions
Function, tcfdbtranabort: Public ordinary functions
Function, tcfdbtranbegin: Public ordinary functions
Function, tcfdbtrancommit: Public ordinary functions
Function, tcfdbtune: Public ordinary functions
Function, tcfdbvanish: Public ordinary functions
Function, tcfdbvsiz: Public ordinary functions
Function, tcfdbvsiz2: Public ordinary functions
Function, tcfdbvsiz3: Public ordinary functions
Function, tchdbclose: Public ordinary functions
Function, tchdbcopy: Public ordinary functions
Function, tchdbdel: Public ordinary functions
Function, tchdbecode: Public ordinary functions
Function, tchdberrmsg: Public ordinary functions
Function, tchdbfsiz: Public ordinary functions
Function, tchdbget: Public ordinary functions
Function, tchdbget2: Public ordinary functions
Function, tchdbiterinit: Public ordinary functions
Function, tchdbiternext: Public ordinary functions
Function, tchdbiternext2: Public ordinary functions
Function, tchdbiternext3: Public ordinary functions
Function, tchdbnew: Public ordinary functions
Function, tchdbopen: Public ordinary functions
Function, tchdboptimize: Public ordinary functions
Function, tchdbout: Public ordinary functions
Function, tchdbout2: Public ordinary functions
Function, tchdbpath: Public ordinary functions
Function, tchdbput: Public ordinary functions
Function, tchdbput2: Public ordinary functions
Function, tchdbputasync: Public ordinary functions
Function, tchdbputasync2: Public ordinary functions
Function, tchdbputcat: Public ordinary functions
Function, tchdbputcat2: Public ordinary functions
Function, tchdbputkeep: Public ordinary functions
Function, tchdbputkeep2: Public ordinary functions
Function, tchdbrnum: Public ordinary functions
Function, tchdbsetcache: Public ordinary functions
Function, tchdbsetxmsiz: Public ordinary functions
Function, tchdbsync: Public ordinary functions
Function, tchdbtranabort: Public ordinary functions
Function, tchdbtranbegin: Public ordinary functions
Function, tchdbtrancommit: Public ordinary functions
Function, tchdbtune: Public ordinary functions
Function, tchdbvanish: Public ordinary functions
Function, tchdbvsiz: Public ordinary functions
Function, tchdbvsiz2: Public ordinary functions

G
Generic Function, (setf current-id-of): Private generic functions
Generic Function, (setf key-size-of): Private generic functions
Generic Function, (setf next-key-of): Private generic functions
Generic Function, (setf ptr-of): Private generic functions
Generic Function, current-id-of: Private generic functions
Generic Function, dbm-abort: Private generic functions
Generic Function, dbm-begin: Public generic functions
Generic Function, dbm-cache: Public generic functions
Generic Function, dbm-close: Public generic functions
Generic Function, dbm-commit: Public generic functions
Generic Function, dbm-delete: Public generic functions
Generic Function, dbm-file-namestring: Private generic functions
Generic Function, dbm-file-size: Public generic functions
Generic Function, dbm-get: Public generic functions
Generic Function, dbm-num-records: Public generic functions
Generic Function, dbm-open: Public generic functions
Generic Function, dbm-optimize: Public generic functions
Generic Function, dbm-put: Public generic functions
Generic Function, dbm-rem: Public generic functions
Generic Function, dbm-vanish: Public generic functions
Generic Function, dbm-xmsize: Public generic functions
Generic Function, error-code-of: Private generic functions
Generic Function, error-msg-of: Private generic functions
Generic Function, iter-close: Public generic functions
Generic Function, iter-first: Public generic functions
Generic Function, iter-get: Public generic functions
Generic Function, iter-jump: Public generic functions
Generic Function, iter-key: Public generic functions
Generic Function, iter-last: Public generic functions
Generic Function, iter-next: Public generic functions
Generic Function, iter-open: Public generic functions
Generic Function, iter-prev: Public generic functions
Generic Function, iter-put: Public generic functions
Generic Function, iter-rem: Public generic functions
Generic Function, key-size-of: Private generic functions
Generic Function, maybe-raise-error: Private generic functions
Generic Function, next-key-of: Private generic functions
Generic Function, ptr-of: Private generic functions
Generic Function, raise-error: Private generic functions
Generic Function, set-comparator: Public generic functions
Generic Function, text: Private generic functions
get-int32->octets: Private ordinary functions
get-int32->string: Private ordinary functions
get-octets->octets: Private ordinary functions
get-octets->string: Private ordinary functions
get-string->octets: Private ordinary functions
get-string->string: Private ordinary functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
iter-close: Public generic functions
iter-close: Public generic functions
iter-close: Public generic functions
iter-close: Public generic functions
iter-first: Public generic functions
iter-first: Public generic functions
iter-first: Public generic functions
iter-first: Public generic functions
iter-get: Public generic functions
iter-get: Public generic functions
iter-get: Public generic functions
iter-get: Public generic functions
iter-jump: Public generic functions
iter-jump: Public generic functions
iter-jump: Public generic functions
iter-jump: Public generic functions
iter-key: Public generic functions
iter-key: Public generic functions
iter-key: Public generic functions
iter-key: Public generic functions
iter-last: Public generic functions
iter-last: Public generic functions
iter-next: Public generic functions
iter-next: Public generic functions
iter-next: Public generic functions
iter-next: Public generic functions
iter-open: Public generic functions
iter-open: Public generic functions
iter-open: Public generic functions
iter-open: Public generic functions
iter-prev: Public generic functions
iter-prev: Public generic functions
iter-put: Public generic functions
iter-put: Public generic functions
iter-put: Public generic functions
iter-rem: Public generic functions
iter-rem: Public generic functions

K
key-size-of: Private generic functions
key-size-of: Private generic functions

M
Macro, with-database: Public macros
Macro, with-iterator: Public macros
Macro, with-string-value: Private macros
Macro, with-transaction: Public macros
maybe-raise-error: Private generic functions
maybe-raise-error: Private generic functions
maybe-raise-error: Private generic functions
maybe-raise-error: Private generic functions
Method, (setf current-id-of): Private generic functions
Method, (setf key-size-of): Private generic functions
Method, (setf next-key-of): Private generic functions
Method, (setf ptr-of): Private generic functions
Method, (setf ptr-of): Private generic functions
Method, current-id-of: Private generic functions
Method, dbm-abort: Private generic functions
Method, dbm-abort: Private generic functions
Method, dbm-abort: Private generic functions
Method, dbm-begin: Public generic functions
Method, dbm-begin: Public generic functions
Method, dbm-begin: Public generic functions
Method, dbm-cache: Public generic functions
Method, dbm-cache: Public generic functions
Method, dbm-close: Public generic functions
Method, dbm-close: Public generic functions
Method, dbm-close: Public generic functions
Method, dbm-commit: Public generic functions
Method, dbm-commit: Public generic functions
Method, dbm-commit: Public generic functions
Method, dbm-delete: Public generic functions
Method, dbm-delete: Public generic functions
Method, dbm-delete: Public generic functions
Method, dbm-file-namestring: Private generic functions
Method, dbm-file-namestring: Private generic functions
Method, dbm-file-namestring: Private generic functions
Method, dbm-file-size: Public generic functions
Method, dbm-file-size: Public generic functions
Method, dbm-file-size: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-get: Public generic functions
Method, dbm-num-records: Public generic functions
Method, dbm-num-records: Public generic functions
Method, dbm-num-records: Public generic functions
Method, dbm-open: Public generic functions
Method, dbm-open: Public generic functions
Method, dbm-open: Public generic functions
Method, dbm-optimize: Public generic functions
Method, dbm-optimize: Public generic functions
Method, dbm-optimize: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-put: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-rem: Public generic functions
Method, dbm-vanish: Public generic functions
Method, dbm-vanish: Public generic functions
Method, dbm-vanish: Public generic functions
Method, dbm-xmsize: Public generic functions
Method, dbm-xmsize: Public generic functions
Method, error-code-of: Private generic functions
Method, error-msg-of: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, iter-close: Public generic functions
Method, iter-close: Public generic functions
Method, iter-close: Public generic functions
Method, iter-first: Public generic functions
Method, iter-first: Public generic functions
Method, iter-first: Public generic functions
Method, iter-get: Public generic functions
Method, iter-get: Public generic functions
Method, iter-get: Public generic functions
Method, iter-jump: Public generic functions
Method, iter-jump: Public generic functions
Method, iter-jump: Public generic functions
Method, iter-key: Public generic functions
Method, iter-key: Public generic functions
Method, iter-key: Public generic functions
Method, iter-last: Public generic functions
Method, iter-next: Public generic functions
Method, iter-next: Public generic functions
Method, iter-next: Public generic functions
Method, iter-open: Public generic functions
Method, iter-open: Public generic functions
Method, iter-open: Public generic functions
Method, iter-prev: Public generic functions
Method, iter-put: Public generic functions
Method, iter-put: Public generic functions
Method, iter-rem: Public generic functions
Method, key-size-of: Private generic functions
Method, maybe-raise-error: Private generic functions
Method, maybe-raise-error: Private generic functions
Method, maybe-raise-error: Private generic functions
Method, next-key-of: Private generic functions
Method, ptr-of: Private generic functions
Method, ptr-of: Private generic functions
Method, raise-error: Private generic functions
Method, raise-error: Private generic functions
Method, raise-error: Private generic functions
Method, set-comparator: Public generic functions
Method, text: Private generic functions

N
next-key-of: Private generic functions
next-key-of: Private generic functions

P
ptr-of: Private generic functions
ptr-of: Private generic functions
ptr-of: Private generic functions
put-int32->octets: Private ordinary functions
put-int32->string: Private ordinary functions
put-octets->octets: Private ordinary functions
put-octets->string: Private ordinary functions
put-string->octets: Private ordinary functions
put-string->string: Private ordinary functions

R
raise-error: Private generic functions
raise-error: Private generic functions
raise-error: Private generic functions
raise-error: Private generic functions
rem-int32->value: Private ordinary functions
rem-octets->value: Private ordinary functions
rem-string->duplicates: Private ordinary functions
rem-string->value: Private ordinary functions

S
set-comparator: Public generic functions
set-comparator: Public generic functions

T
tcbdbclose: Public ordinary functions
tcbdbcopy: Public ordinary functions
tcbdbcurdel: Public ordinary functions
tcbdbcurfirst: Public ordinary functions
tcbdbcurjump: Public ordinary functions
tcbdbcurjump2: Public ordinary functions
tcbdbcurkey: Public ordinary functions
tcbdbcurkey2: Public ordinary functions
tcbdbcurkey3: Public ordinary functions
tcbdbcurlast: Public ordinary functions
tcbdbcurnew: Public ordinary functions
tcbdbcurnext: Public ordinary functions
tcbdbcurout: Public ordinary functions
tcbdbcurprev: Public ordinary functions
tcbdbcurput: Public ordinary functions
tcbdbcurput2: Public ordinary functions
tcbdbcurrec: Public ordinary functions
tcbdbcurval: Public ordinary functions
tcbdbcurval2: Public ordinary functions
tcbdbcurval3: Public ordinary functions
tcbdbdel: Public ordinary functions
tcbdbecode: Public ordinary functions
tcbdberrmsg: Public ordinary functions
tcbdbfsiz: Public ordinary functions
tcbdbget: Public ordinary functions
tcbdbget2: Public ordinary functions
tcbdbnew: Public ordinary functions
tcbdbopen: Public ordinary functions
tcbdboptimize: Public ordinary functions
tcbdbout: Public ordinary functions
tcbdbout2: Public ordinary functions
tcbdbout3: Public ordinary functions
tcbdbpath: Public ordinary functions
tcbdbput: Public ordinary functions
tcbdbput2: Public ordinary functions
tcbdbputcat: Public ordinary functions
tcbdbputcat2: Public ordinary functions
tcbdbputdup: Public ordinary functions
tcbdbputdup2: Public ordinary functions
tcbdbputdup3: Public ordinary functions
tcbdbputkeep: Public ordinary functions
tcbdbputkeep2: Public ordinary functions
tcbdbrnum: Public ordinary functions
tcbdbsetcache: Public ordinary functions
tcbdbsetcmpfunc: Public ordinary functions
tcbdbsetxmsiz: Public ordinary functions
tcbdbsync: Public ordinary functions
tcbdbtranabort: Public ordinary functions
tcbdbtranbegin: Public ordinary functions
tcbdbtrancommit: Public ordinary functions
tcbdbtune: Public ordinary functions
tcbdbvanish: Public ordinary functions
tcbdbvnum: Public ordinary functions
tcbdbvnum2: Public ordinary functions
tcbdbvsiz: Public ordinary functions
tcbdbvsiz2: Public ordinary functions
tcfdbadddouble: Public ordinary functions
tcfdbaddint: Public ordinary functions
tcfdbclose: Public ordinary functions
tcfdbcopy: Public ordinary functions
tcfdbdel: Public ordinary functions
tcfdbecode: Public ordinary functions
tcfdberrmsg: Public ordinary functions
tcfdbfsiz: Public ordinary functions
tcfdbget: Public ordinary functions
tcfdbget2: Public ordinary functions
tcfdbget3: Public ordinary functions
tcfdbiterinit: Public ordinary functions
tcfdbiternext: Public ordinary functions
tcfdbiternext2: Public ordinary functions
tcfdbiternext3: Public ordinary functions
tcfdbnew: Public ordinary functions
tcfdbopen: Public ordinary functions
tcfdboptimize: Public ordinary functions
tcfdbout: Public ordinary functions
tcfdbout2: Public ordinary functions
tcfdbout3: Public ordinary functions
tcfdbpath: Public ordinary functions
tcfdbput: Public ordinary functions
tcfdbput2: Public ordinary functions
tcfdbput3: Public ordinary functions
tcfdbputcat: Public ordinary functions
tcfdbputcat2: Public ordinary functions
tcfdbputcat3: Public ordinary functions
tcfdbputkeep: Public ordinary functions
tcfdbputkeep2: Public ordinary functions
tcfdbputkeep3: Public ordinary functions
tcfdbrange: Public ordinary functions
tcfdbrnum: Public ordinary functions
tcfdbsync: Public ordinary functions
tcfdbtranabort: Public ordinary functions
tcfdbtranbegin: Public ordinary functions
tcfdbtrancommit: Public ordinary functions
tcfdbtune: Public ordinary functions
tcfdbvanish: Public ordinary functions
tcfdbvsiz: Public ordinary functions
tcfdbvsiz2: Public ordinary functions
tcfdbvsiz3: Public ordinary functions
tchdbclose: Public ordinary functions
tchdbcopy: Public ordinary functions
tchdbdel: Public ordinary functions
tchdbecode: Public ordinary functions
tchdberrmsg: Public ordinary functions
tchdbfsiz: Public ordinary functions
tchdbget: Public ordinary functions
tchdbget2: Public ordinary functions
tchdbiterinit: Public ordinary functions
tchdbiternext: Public ordinary functions
tchdbiternext2: Public ordinary functions
tchdbiternext3: Public ordinary functions
tchdbnew: Public ordinary functions
tchdbopen: Public ordinary functions
tchdboptimize: Public ordinary functions
tchdbout: Public ordinary functions
tchdbout2: Public ordinary functions
tchdbpath: Public ordinary functions
tchdbput: Public ordinary functions
tchdbput2: Public ordinary functions
tchdbputasync: Public ordinary functions
tchdbputasync2: Public ordinary functions
tchdbputcat: Public ordinary functions
tchdbputcat2: Public ordinary functions
tchdbputkeep: Public ordinary functions
tchdbputkeep2: Public ordinary functions
tchdbrnum: Public ordinary functions
tchdbsetcache: Public ordinary functions
tchdbsetxmsiz: Public ordinary functions
tchdbsync: Public ordinary functions
tchdbtranabort: Public ordinary functions
tchdbtranbegin: Public ordinary functions
tchdbtrancommit: Public ordinary functions
tchdbtune: Public ordinary functions
tchdbvanish: Public ordinary functions
tchdbvsiz: Public ordinary functions
tchdbvsiz2: Public ordinary functions
text: Private generic functions
text: Private generic functions

W
with-database: Public macros
with-iterator: Public macros
with-string-value: Private macros
with-transaction: Public macros

Jump to:   %   (  
C   D   E   F   G   I   K   M   N   P   R   S   T   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *   +  
C   E   K   N   P   S   T  
Index Entry  Section

*
*in-transaction-p*: Private special variables

+
+bdbcpafter+: Public constants
+bdbcpbefore+: Public constants
+bdbcpcurrent+: Public constants
+tceclose+: Public constants
+tceinvalid+: Public constants
+tcekeep+: Public constants
+tcelock+: Public constants
+tcemeta+: Public constants
+tcemisc+: Public constants
+tcemkdir+: Public constants
+tcemmap+: Public constants
+tcenofile+: Public constants
+tcenoperm+: Public constants
+tcenorec+: Public constants
+tceopen+: Public constants
+tceread+: Public constants
+tcerename+: Public constants
+tcerhead+: Public constants
+tcermdir+: Public constants
+tceseek+: Public constants
+tcestat+: Public constants
+tcesuccess+: Public constants
+tcesync+: Public constants
+tcethread+: Public constants
+tcetrunc+: Public constants
+tceunlink+: Public constants
+tcewrite+: Public constants

C
Constant, +bdbcpafter+: Public constants
Constant, +bdbcpbefore+: Public constants
Constant, +bdbcpcurrent+: Public constants
Constant, +tceclose+: Public constants
Constant, +tceinvalid+: Public constants
Constant, +tcekeep+: Public constants
Constant, +tcelock+: Public constants
Constant, +tcemeta+: Public constants
Constant, +tcemisc+: Public constants
Constant, +tcemkdir+: Public constants
Constant, +tcemmap+: Public constants
Constant, +tcenofile+: Public constants
Constant, +tcenoperm+: Public constants
Constant, +tcenorec+: Public constants
Constant, +tceopen+: Public constants
Constant, +tceread+: Public constants
Constant, +tcerename+: Public constants
Constant, +tcerhead+: Public constants
Constant, +tcermdir+: Public constants
Constant, +tceseek+: Public constants
Constant, +tcestat+: Public constants
Constant, +tcesuccess+: Public constants
Constant, +tcesync+: Public constants
Constant, +tcethread+: Public constants
Constant, +tcetrunc+: Public constants
Constant, +tceunlink+: Public constants
Constant, +tcewrite+: Public constants
current-id: Private classes

E
error-code: Public conditions
error-msg: Public conditions

K
key-size: Private classes

N
next-key: Private classes

P
ptr: Private classes
ptr: Private classes

S
Slot, current-id: Private classes
Slot, error-code: Public conditions
Slot, error-msg: Public conditions
Slot, key-size: Private classes
Slot, next-key: Private classes
Slot, ptr: Private classes
Slot, ptr: Private classes
Slot, text: Public conditions
Special Variable, *in-transaction-p*: Private special variables

T
text: Public conditions

Jump to:   *   +  
C   E   K   N   P   S   T  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   D   F   H   I   M   O   P   S   T  
Index Entry  Section

B
bdb-iterator: Private classes

C
cl-tokyo-cabinet: The cl-tokyo-cabinet system
cl-tokyo-cabinet: The cl-tokyo-cabinet/cl-tokyo-cabinet module
cl-tokyo-cabinet.asd: The cl-tokyo-cabinet/cl-tokyo-cabinet․asd file
Class, bdb-iterator: Private classes
Class, fdb-iterator: Private classes
Class, hdb-iterator: Private classes
Class, tc-bdb: Public classes
Class, tc-dbm: Private classes
Class, tc-fdb: Public classes
Class, tc-hdb: Public classes
Class, tc-iterator: Private classes
Condition, dbm-error: Public conditions

D
dbm-error: Public conditions

F
fdb-iterator: Private classes
File, cl-tokyo-cabinet.asd: The cl-tokyo-cabinet/cl-tokyo-cabinet․asd file
File, package.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/package․lisp file
File, tokyo-cabinet-bdb.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-bdb․lisp file
File, tokyo-cabinet-fdb.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-fdb․lisp file
File, tokyo-cabinet-ffi.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-ffi․lisp file
File, tokyo-cabinet-hdb.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-hdb․lisp file
File, tokyo-cabinet.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet․lisp file

H
hdb-iterator: Private classes

I
int32: Private types
int64: Private types

M
Module, cl-tokyo-cabinet: The cl-tokyo-cabinet/cl-tokyo-cabinet module

O
octet: Private types

P
Package, tokyo-cabinet: The tokyo-cabinet package
Package, tokyo-cabinet-ffi: The tokyo-cabinet-ffi package
package.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/package․lisp file

S
System, cl-tokyo-cabinet: The cl-tokyo-cabinet system

T
tc-bdb: Public classes
tc-dbm: Private classes
tc-fdb: Public classes
tc-hdb: Public classes
tc-iterator: Private classes
tokyo-cabinet: The tokyo-cabinet package
tokyo-cabinet-bdb.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-bdb․lisp file
tokyo-cabinet-fdb.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-fdb․lisp file
tokyo-cabinet-ffi: The tokyo-cabinet-ffi package
tokyo-cabinet-ffi.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-ffi․lisp file
tokyo-cabinet-hdb.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet-hdb․lisp file
tokyo-cabinet.lisp: The cl-tokyo-cabinet/cl-tokyo-cabinet/tokyo-cabinet․lisp file
Type, int32: Private types
Type, int64: Private types
Type, octet: Private types

Jump to:   B   C   D   F   H   I   M   O   P   S   T