The cl-kyoto-cabinet Reference Manual

Table of Contents

The cl-kyoto-cabinet Reference Manual

This is the cl-kyoto-cabinet Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:12:05 2018 GMT+0.

1 Introduction

(in-package :kyoto-cabinet)
(defparameter *db* (make-instance 'kc-dbm))
(dbm-open *db* "/tmp/hello.kch" :create :write)

(dbm-put *db* "Ilya" "Sterin" :mode :keep)
(dbm-get *db* "Ilya")
(dbm-remove *db* "Ilya")

(dbm-put *db* 123 "456" :mode :keep)
(dbm-get *db* 123)
(dbm-remove *db* 123)

(defparameter *iter* (iter-open *db*))
(iter-first *iter*)
(multiple-value-bind (key val) (iter-item *iter*) (list key val))
(iter-next *iter*)

(dbm-put *db* 123 (make-array 2 :initial-contents '(75 76) :element-type '(unsigned-byte 8)) :mode :replace)
(dbm-put *db* 123 (make-octet-vector 100 101) :mode :replace)

(multiple-value-bind (key val) (iter-item *iter* :key-type :integer) (list key val))

2 Systems

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

2.1 cl-kyoto-cabinet

Author

Kevin Raison <last name @ chatsubo dot net>

License

New BSD

Description

Lisp Interface to Kyoto Cabinet DBM (http://fallabs.com/kyotocabinet/)

Version

0.1

Dependency

cffi (at least version 0.10.3)

Source

cl-kyoto-cabinet.asd (file)

Components

• cl-kyoto-cabinet-package.lisp (file)
• kyoto-cabinet-ffi.lisp (file)
• kyoto-cabinet.lisp (file)
• kyoto-cabinet-dbm.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 cl-kyoto-cabinet.asd

Location

cl-kyoto-cabinet.asd

Systems

cl-kyoto-cabinet (system)

Packages

cl-kyoto-cabinet-system

3.1.2 cl-kyoto-cabinet/cl-kyoto-cabinet-package.lisp

Parent

cl-kyoto-cabinet (system)

Location

cl-kyoto-cabinet-package.lisp

Packages

• kyoto-cabinet
• kyoto-cabinet-ffi

3.1.3 cl-kyoto-cabinet/kyoto-cabinet-ffi.lisp

Dependency

cl-kyoto-cabinet-package.lisp (file)

Parent

cl-kyoto-cabinet (system)

Location

kyoto-cabinet-ffi.lisp

Exported Definitions

• kccurdb (function)
• kccurdel (function)
• kccurget (function)
• kccurgetkey (function)
• kccurgetvalue (function)
• kccurjump (function)
• kccurjumpkey (function)
• kccurremove (function)
• kccurstep (function)
• kcdbadd (function)
• kcdbappend (function)
• kcdbbegintran (function)
• kcdbclear (function)
• kcdbclose (function)
• kcdbcount (function)
• kcdbcursor (function)
• kcdbdel (function)
• kcdbecode (function)
• kcdbemsg (function)
• kcdbendtran (function)
• kcdbget (function)
• kcdbnew (function)
• kcdbopen (function)
• kcdbremove (function)
• kcdbset (function)
• kcfree (function)
• kcmalloc (function)

Internal Definitions

• %var-accessor-kcversion (function)
• (setf %var-accessor-kcversion) (function)
• %var-accessor-kcvisnop (function)
• (setf %var-accessor-kcvisnop) (function)
• %var-accessor-kcvisremove (function)
• (setf %var-accessor-kcvisremove) (function)
• defanonenum (macro)
• kcatof (function)
• kcatoi (function)
• kcatoix (function)
• kcchkinf (function)
• kcchknan (function)
• kccuraccept (function)
• kccurecode (function)
• kccuremsg (function)
• kccursetvalue (function)
• kcdbaccept (function)
• kcdbbegintrantry (function)
• kcdbcas (function)
• kcdbcopy (function)
• kcdbdumpsnap (function)
• kcdbgetbuf (function)
• kcdbincrdouble (function)
• kcdbincrint (function)
• kcdbiterate (function)
• kcdbloadsnap (function)
• kcdbpath (function)
• kcdbsize (function)
• kcdbstatus (function)
• kcdbsync (function)
• kcecodename (function)
• kchashfnv (function)
• kchashmurmur (function)
• kcinf (function)
• kcnan (function)
• kctime (function)
• kcversion (symbol macro)
• kcvisnop (symbol macro)
• kcvisremove (symbol macro)
• swig-lispify (function)

3.1.4 cl-kyoto-cabinet/kyoto-cabinet.lisp

Dependencies

• cl-kyoto-cabinet-package.lisp (file)
• kyoto-cabinet-ffi.lisp (file)

Parent

cl-kyoto-cabinet (system)

Location

kyoto-cabinet.lisp

Exported Definitions

• *in-transaction-p* (special variable)
• dbm-begin (generic function)
• dbm-cache (generic function)
• dbm-clear (generic function)
• dbm-close (generic function)
• dbm-commit (generic function)
• dbm-delete (generic function)
• dbm-file-size (generic function)
• dbm-get (generic function)
• dbm-num-records (generic function)
• dbm-open (generic function)
• dbm-optimize (generic function)
• dbm-put (generic function)
• dbm-remove (generic function)
• dbm-rollback (generic function)
• dbm-xmsize (generic function)
• iter-close (generic function)
• iter-first (generic function)
• iter-go-to (generic function)
• iter-item (generic function)
• iter-key (generic function)
• iter-last (generic function)
• iter-next (generic function)
• iter-open (generic function)
• iter-prev (generic function)
• iter-put (generic function)
• iter-remove (generic function)
• iter-value (generic function)
• kc-dbm (class)
• set-comparator (generic function)
• with-database (macro)
• with-iterator (macro)
• with-transaction (macro)

Internal Definitions

• check-open-mode (function)
• convert-from-lisp (generic function)
• convert-from-lisp (method)
• convert-from-lisp (method)
• convert-from-lisp (method)
• convert-to-lisp (generic function)
• convert-to-lisp (method)
• convert-to-lisp (method)
• convert-to-lisp (method)
• copy-foreign-value (function)
• dbm-error (condition)
• dbm-file-namestring (generic function)
• error-code-of (method)
• error-msg-of (method)
• get-int32->octets (function)
• get-int32->string (function)
• get-octets->octets (function)
• get-octets->string (function)
• get-pointer (function)
• get-pointer->pointer (function)
• get-something (function)
• get-string->octets (function)
• get-string->string (function)
• int32 (type)
• int64 (type)
• iter-iterate (generic function)
• kc-iterator (class)
• make-octet-vector (function)
• maybe-raise-error (generic function)
• octet (type)
• ptr-of (method)
• (setf ptr-of) (method)
• ptr-of (method)
• (setf ptr-of) (method)
• put-int32->octets (function)
• put-int32->string (function)
• put-method-for (generic function)
• put-method-for (method)
• put-method-for (method)
• put-method-for (method)
• put-octets->octets (function)
• put-pointer->pointer (function)
• put-string->octets (function)
• put-string->string (function)
• raise-error (generic function)
• rem-int32->value (function)
• rem-octets->value (function)
• rem-pointer->value (function)
• rem-string->value (function)
• text (method)
• with-string-value (macro)

3.1.5 cl-kyoto-cabinet/kyoto-cabinet-dbm.lisp

Dependencies

• cl-kyoto-cabinet-package.lisp (file)
• kyoto-cabinet.lisp (file)
• kyoto-cabinet-ffi.lisp (file)

Parent

cl-kyoto-cabinet (system)

Location

kyoto-cabinet-dbm.lisp

Exported Definitions

• dbm-begin (method)
• dbm-clear (method)
• dbm-close (method)
• dbm-commit (method)
• dbm-delete (method)
• dbm-get (method)
• dbm-get (method)
• dbm-get (method)
• dbm-get-fast (function)
• dbm-num-records (method)
• dbm-open (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put-fast (function)
• dbm-remove (method)
• dbm-remove (method)
• dbm-remove (method)
• dbm-remove-fast (function)
• dbm-rollback (method)
• iter-close (method)
• iter-first (method)
• iter-go-to (method)
• iter-go-to (method)
• iter-go-to (method)
• iter-go-to-fast (method)
• iter-item (method)
• iter-item-fast (method)
• iter-key (method)
• iter-key-fast (method)
• iter-next (method)
• iter-open (method)
• iter-remove (method)
• iter-value (method)
• iter-value-fast (method)

Internal Definitions

• maybe-raise-error (method)
• maybe-raise-error (method)
• maybe-raise-error-with-ecode (function)
• raise-error (method)
• raise-error (method)

4 Packages

Packages are listed by definition order.

4.1 cl-kyoto-cabinet-system

Source

cl-kyoto-cabinet.asd

Use List

• asdf/interface
• common-lisp

4.2 kyoto-cabinet

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

Source

cl-kyoto-cabinet-package.lisp (file)

Nickname

kc

Use List

• kyoto-cabinet-ffi
• cffi
• common-lisp

Exported Definitions

• *in-transaction-p* (special variable)
• dbm-begin (generic function)
• dbm-begin (method)
• dbm-cache (generic function)
• dbm-clear (generic function)
• dbm-clear (method)
• dbm-close (generic function)
• dbm-close (method)
• dbm-commit (generic function)
• dbm-commit (method)
• dbm-delete (generic function)
• dbm-delete (method)
• dbm-file-size (generic function)
• dbm-get (generic function)
• dbm-get (method)
• dbm-get (method)
• dbm-get (method)
• dbm-get-fast (function)
• dbm-num-records (generic function)
• dbm-num-records (method)
• dbm-open (generic function)
• dbm-open (method)
• dbm-optimize (generic function)
• dbm-put (generic function)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put-fast (function)
• dbm-remove (generic function)
• dbm-remove (method)
• dbm-remove (method)
• dbm-remove (method)
• dbm-remove-fast (function)
• dbm-rollback (generic function)
• dbm-rollback (method)
• dbm-xmsize (generic function)
• iter-close (generic function)
• iter-close (method)
• iter-first (generic function)
• iter-first (method)
• iter-go-to (generic function)
• iter-go-to (method)
• iter-go-to (method)
• iter-go-to (method)
• iter-go-to-fast (generic function)
• iter-go-to-fast (method)
• iter-item (generic function)
• iter-item (method)
• iter-item-fast (generic function)
• iter-item-fast (method)
• iter-key (generic function)
• iter-key (method)
• iter-key-fast (generic function)
• iter-key-fast (method)
• iter-last (generic function)
• iter-next (generic function)
• iter-next (method)
• iter-open (generic function)
• iter-open (method)
• iter-prev (generic function)
• iter-put (generic function)
• iter-remove (generic function)
• iter-remove (method)
• iter-value (generic function)
• iter-value (method)
• iter-value-fast (generic function)
• iter-value-fast (method)
• kc-dbm (class)
• set-comparator (generic function)
• with-database (macro)
• with-iterator (macro)
• with-transaction (macro)

Internal Definitions

• check-open-mode (function)
• convert-from-lisp (generic function)
• convert-from-lisp (method)
• convert-from-lisp (method)
• convert-from-lisp (method)
• convert-to-lisp (generic function)
• convert-to-lisp (method)
• convert-to-lisp (method)
• convert-to-lisp (method)
• copy-foreign-value (function)
• dbm-error (condition)
• dbm-file-namestring (generic function)
• error-code-of (generic function)
• error-code-of (method)
• error-msg-of (generic function)
• error-msg-of (method)
• get-int32->octets (function)
• get-int32->string (function)
• get-octets->octets (function)
• get-octets->string (function)
• get-pointer (function)
• get-pointer->pointer (function)
• get-something (function)
• get-string->octets (function)
• get-string->string (function)
• int32 (type)
• int64 (type)
• iter-iterate (generic function)
• kc-iterator (class)
• make-octet-vector (function)
• maybe-raise-error (generic function)
• maybe-raise-error (method)
• maybe-raise-error (method)
• maybe-raise-error-with-ecode (function)
• octet (type)
• ptr-of (generic function)
• ptr-of (method)
• (setf ptr-of) (method)
• ptr-of (method)
• (setf ptr-of) (method)
• (setf ptr-of) (generic function)
• put-int32->octets (function)
• put-int32->string (function)
• put-method-for (generic function)
• put-method-for (method)
• put-method-for (method)
• put-method-for (method)
• put-octets->octets (function)
• put-pointer->pointer (function)
• put-string->octets (function)
• put-string->string (function)
• raise-error (generic function)
• raise-error (method)
• raise-error (method)
• rem-int32->value (function)
• rem-octets->value (function)
• rem-pointer->value (function)
• rem-string->value (function)
• text (generic function)
• text (method)
• with-string-value (macro)

4.3 kyoto-cabinet-ffi

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

Source

cl-kyoto-cabinet-package.lisp (file)

Use List

• cffi
• common-lisp

Used By List

kyoto-cabinet

Exported Definitions

• kccurdb (function)
• kccurdel (function)
• kccurget (function)
• kccurgetkey (function)
• kccurgetvalue (function)
• kccurjump (function)
• kccurjumpkey (function)
• kccurremove (function)
• kccurstep (function)
• kcdbadd (function)
• kcdbappend (function)
• kcdbbegintran (function)
• kcdbclear (function)
• kcdbclose (function)
• kcdbcount (function)
• kcdbcursor (function)
• kcdbdel (function)
• kcdbecode (function)
• kcdbemsg (function)
• kcdbendtran (function)
• kcdbget (function)
• kcdbnew (function)
• kcdbopen (function)
• kcdbremove (function)
• kcdbset (function)
• kcfree (function)
• kcmalloc (function)

Internal Definitions

• %var-accessor-kcversion (function)
• (setf %var-accessor-kcversion) (function)
• %var-accessor-kcvisnop (function)
• (setf %var-accessor-kcvisnop) (function)
• %var-accessor-kcvisremove (function)
• (setf %var-accessor-kcvisremove) (function)
• defanonenum (macro)
• kcatof (function)
• kcatoi (function)
• kcatoix (function)
• kcchkinf (function)
• kcchknan (function)
• kccuraccept (function)
• kccurecode (function)
• kccuremsg (function)
• kccursetvalue (function)
• kcdbaccept (function)
• kcdbbegintrantry (function)
• kcdbcas (function)
• kcdbcopy (function)
• kcdbdumpsnap (function)
• kcdbgetbuf (function)
• kcdbincrdouble (function)
• kcdbincrint (function)
• kcdbiterate (function)
• kcdbloadsnap (function)
• kcdbpath (function)
• kcdbsize (function)
• kcdbstatus (function)
• kcdbsync (function)
• kcecodename (function)
• kchashfnv (function)
• kchashmurmur (function)
• kcinf (function)
• kcnan (function)
• kctime (function)
• kcversion (symbol macro)
• kcvisnop (symbol macro)
• kcvisremove (symbol macro)
• swig-lispify (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *in-transaction-p*

Bound when in a transaction.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

5.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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Macro: with-iterator (VAR DB) &body BODY

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

5.1.3 Functions

Function: dbm-get-fast DB KEY KEY-LEN

Package

kyoto-cabinet

Source

kyoto-cabinet-dbm.lisp (file)

Function: dbm-put-fast DB KEY KEY-LEN VALUE VALUE-LEN &key MODE

Package

kyoto-cabinet

Source

kyoto-cabinet-dbm.lisp (file)

Function: dbm-remove-fast DB KEY KEY-LEN

Package

kyoto-cabinet

Source

kyoto-cabinet-dbm.lisp (file)

Function: kccurdb CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurdel CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurget CUR KSP VBP VSP STEP

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurgetkey CUR SP STEP

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurgetvalue CUR SP STEP

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurjump CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurjumpkey CUR KBUF KSIZ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurremove CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurstep CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbadd DB KBUF KSIZ VBUF VSIZ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbappend DB KBUF KSIZ VBUF VSIZ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbbegintran DB HARD

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbclear DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbclose DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbcount DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbcursor DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbdel DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbecode DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbemsg DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbendtran DB COMMIT

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbget DB KBUF KSIZ SP

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbnew ()

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbopen DB PATH MODE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbremove DB KBUF KSIZ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbset DB KBUF KSIZ VBUF VSIZ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcfree PTR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcmalloc SIZE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

5.1.4 Generic functions

Generic Function: dbm-begin DB &rest HARD

Begins a transaction with DB.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-begin (DB kc-dbm) &rest HARD

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-cache DB &rest ARGS

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Generic Function: dbm-clear DB

Removes all records from DB.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-clear (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-close DB

Closes an open KC database.

Arguments:

- db (object): A KC dbm object.

Returns:

- T on success, or NIL otherwise.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-close (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-commit DB

Commits a transaction with DB.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-commit (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-delete DB

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

Arguments:

- db (object): A KC dbm object.

Returns:

- NIL .

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-delete (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-file-size DB

Returns the size of the DB file in bytes.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-get (DB kc-dbm) (KEY vector) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-get (DB kc-dbm) (KEY integer) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-get (DB kc-dbm) (KEY string) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-num-records DB

Returns the number of records in DB.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-num-records (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-open DB FILESPEC &rest MODE

Opens a new, or existing KC database.

Arguments:

- db (object): A KC 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 :KCOWRITER :KCOREADER :KCOCREATE :KCOTRUNCATE :KCOAUTOTRAN :KCOAUTOSYNC :KCONOLOCK :KCOTRYLOCK :KCONOREPAIR which correspond to those described in the KC specification.

Returns:

- The KC dbm object, now open.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-open (DB kc-dbm) FILENAME &rest MODE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-optimize DB &rest ARGS

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Generic Function: dbm-put DB KEY VALUE &key MODE

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

Arguments:

- db (object): A KC 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 KC insertion modes: replace, keep, concat, 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.

Valid modes for hash databases are:

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-put (DB kc-dbm) (KEY integer) (VALUE vector) &key MODE

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-put (DB kc-dbm) (KEY integer) (VALUE string) &key MODE

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-put (DB kc-dbm) (KEY vector) (VALUE vector) &key MODE

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-put (DB kc-dbm) (KEY string) (VALUE vector) &key MODE

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-put (DB kc-dbm) (KEY string) (VALUE string) &key MODE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-remove DB KEY

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-remove (DB kc-dbm) (KEY vector)

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-remove (DB kc-dbm) (KEY integer)

Source

kyoto-cabinet-dbm.lisp (file)

Method: dbm-remove (DB kc-dbm) (KEY string)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-rollback DB

Rolls back a transaction with DB.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: dbm-rollback (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: dbm-xmsize DB SIZE

Sets the DB extra mapped memory to SIZE bytes.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Generic Function: iter-close ITERATOR

Closes ITERATOR. Only effective for B+ tree databases.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-close (ITER kc-iterator)

Source

kyoto-cabinet-dbm.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-first (ITER kc-iterator)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-go-to ITERATOR KEY

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-go-to (ITER kc-iterator) (KEY vector)

Source

kyoto-cabinet-dbm.lisp (file)

Method: iter-go-to (ITER kc-iterator) (KEY integer)

Source

kyoto-cabinet-dbm.lisp (file)

Method: iter-go-to (ITER kc-iterator) (KEY string)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-go-to-fast ITER KEY-PTR KEY-LEN

Package

kyoto-cabinet

Methods

Method: iter-go-to-fast (ITER kc-iterator) KEY-PTR KEY-LEN

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-item DB &key KEY-TYPE VALUE-TYPE

Returns the current item in the iterator. ** DOES NOT advance the cursor **

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-item (ITER kc-iterator) &key KEY-TYPE VALUE-TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-item-fast ITER

Package

kyoto-cabinet

Methods

Method: iter-item-fast (ITER kc-iterator)

Source

kyoto-cabinet-dbm.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-key (ITER kc-iterator) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-key-fast ITER &optional TYPE

Package

kyoto-cabinet

Methods

Method: iter-key-fast (ITER kc-iterator) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Generic Function: iter-next ITERATOR

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-next (ITER kc-iterator)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-open DB

Opens an iterator on DB.

Arguments:

- db (object): A KC dbm object.

Returns:
- A TC iterator object.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-open (DB kc-dbm)

Source

kyoto-cabinet-dbm.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Generic Function: iter-remove ITERATOR

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-remove (ITER kc-iterator)

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-value 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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: iter-value (ITER kc-iterator) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: iter-value-fast ITER &optional TYPE

Package

kyoto-cabinet

Methods

Method: iter-value-fast (ITER kc-iterator) &optional TYPE

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: set-comparator DB FN

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

5.1.5 Classes

Class: kc-dbm ()

A KC database.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• iter-open (method)
• dbm-remove (method)
• dbm-remove (method)
• dbm-remove (method)
• dbm-get (method)
• dbm-get (method)
• dbm-get (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-put (method)
• dbm-num-records (method)
• dbm-rollback (method)
• dbm-commit (method)
• dbm-begin (method)
• dbm-clear (method)
• dbm-delete (method)
• dbm-close (method)
• dbm-open (method)
• maybe-raise-error (method)
• raise-error (method)
• initialize-instance (method)
• ptr-of (method)
• ptr-of (method)

Direct slots

Slot: ptr

A pointer to a KC native database object.

Initargs

:ptr

Readers

ptr-of (generic function)

Writers

(setf ptr-of) (generic function)

5.2 Internal definitions

5.2.1 Symbol macros

Symbol Macro: kcversion

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Expansion

(kyoto-cabinet-ffi::%var-accessor-kcversion)

Symbol Macro: kcvisnop

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Expansion

(kyoto-cabinet-ffi::%var-accessor-kcvisnop)

Symbol Macro: kcvisremove

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Expansion

(kyoto-cabinet-ffi::%var-accessor-kcvisremove)

5.2.2 Macros

Macro: defanonenum &body ENUMS

Converts anonymous enums to defconstants.

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Macro: with-string-value (VALUE-PTR INITFORM) &body BODY

Helper macro for managing string values.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

5.2.3 Functions

Function: %var-accessor-kcversion ()

Function: (setf %var-accessor-kcversion) VALUE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: %var-accessor-kcvisnop ()

Function: (setf %var-accessor-kcvisnop) VALUE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: %var-accessor-kcvisremove ()

Function: (setf %var-accessor-kcvisremove) VALUE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: check-open-mode MODE

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: copy-foreign-value VALUE-PTR SIZE-PTR

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: get-pointer ITER FN

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: get-pointer->pointer DB KEY-PTR KEY-LEN FN

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: get-something ITER FN &optional TYPE

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: get-string->string DB KEY FN

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: kcatof STR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcatoi STR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcatoix STR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcchkinf NUM

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcchknan NUM

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccuraccept CUR FULLPROC OPQ WRITABLE STEP

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccurecode CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccuremsg CUR

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kccursetvalue CUR VBUF VSIZ STEP

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbaccept DB KBUF KSIZ FULLPROC EMPTYPROC OPQ WRITABLE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbbegintrantry DB HARD

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbcas DB KBUF KSIZ NVBUF NVSIZ OVBUF OVSIZ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbcopy DB DEST

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbdumpsnap DB DEST

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbgetbuf DB KBUF KSIZ VBUF MAX

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbincrdouble DB KBUF KSIZ NUM

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbincrint DB KBUF KSIZ NUM

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbiterate DB FULLPROC OPQ WRITABLE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbloadsnap DB SRC

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbpath DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbsize DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbstatus DB

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcdbsync DB HARD PROC OPQ

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcecodename CODE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kchashfnv BUF SIZE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kchashmurmur BUF SIZE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcinf ()

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kcnan ()

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: kctime ()

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

Function: make-octet-vector &rest BODY

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: maybe-raise-error-with-ecode WHAT ECODE &optional MESSAGE &rest MESSAGE-ARGUMENTS

Package

kyoto-cabinet

Source

kyoto-cabinet-dbm.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: put-pointer->pointer DB KEY-PTR KEY-LEN VALUE-PTR VALUE-LEN FN

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: put-string->string DB KEY VALUE FN

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: rem-int32->value DB KEY

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: rem-octets->value DB KEY

Removes value from DB under KEY where the key is a octet vector

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: rem-pointer->value DB KEY KEY-LEN

Removes value from DB under KEY where the key is a cffi pointer

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: rem-string->value DB KEY

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

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Function: swig-lispify NAME FLAG &optional PACKAGE

Package

kyoto-cabinet-ffi

Source

kyoto-cabinet-ffi.lisp (file)

5.2.4 Generic functions

Generic Function: convert-from-lisp TYPE WHAT

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: convert-from-lisp (TYPE (eql string)) WHAT

Method: convert-from-lisp (TYPE (eql integer)) WHAT

Method: convert-from-lisp (TYPE (eql octets)) WHAT

Generic Function: convert-to-lisp TYPE WHAT-PTR &optional SIZE

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: convert-to-lisp (TYPE (eql string)) WHAT-PTR &optional SIZE

Method: convert-to-lisp (TYPE (eql integer)) WHAT-PTR &optional SIZE

Method: convert-to-lisp (TYPE (eql octets)) WHAT-PTR &optional SIZE

Generic Function: dbm-file-namestring DB

Returns the name of the DB file.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Generic Function: error-code-of CONDITION

Package

kyoto-cabinet

Methods

Method: error-code-of (CONDITION dbm-error)

Source

kyoto-cabinet.lisp (file)

Generic Function: error-msg-of CONDITION

Package

kyoto-cabinet

Methods

Method: error-msg-of (CONDITION dbm-error)

Source

kyoto-cabinet.lisp (file)

Generic Function: iter-iterate DB FN

Iterates through all records and calls function fn for each record.

Arguments:

- db (object): A KC dbm object.
- fn (function): A callback function

Returns:
- Boolean representing true for success or false for failure.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: maybe-raise-error (ITER kc-iterator) &optional MESSAGE &rest MESSAGE-ARGUMENTS

Source

kyoto-cabinet-dbm.lisp (file)

Method: maybe-raise-error (DB kc-dbm) &optional MESSAGE &rest MESSAGE-ARGUMENTS

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: ptr-of OBJECT

Generic Function: (setf ptr-of) NEW-VALUE OBJECT

Package

kyoto-cabinet

Methods

Method: ptr-of (KC-ITERATOR kc-iterator)

Method: (setf ptr-of) NEW-VALUE (KC-ITERATOR kc-iterator)

A KC pointer.

Source

kyoto-cabinet.lisp (file)

Method: ptr-of (KC-DBM kc-dbm)

Method: (setf ptr-of) NEW-VALUE (KC-DBM kc-dbm)

A pointer to a KC native database object.

Source

kyoto-cabinet.lisp (file)

Generic Function: put-method-for MODE

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: put-method-for (MODE (eql replace))

Method: put-method-for (MODE (eql keep))

Method: put-method-for (MODE (eql concat))

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

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Methods

Method: raise-error (ITER kc-iterator) &optional MESSAGE &rest MESSAGE-ARGUMENTS

Source

kyoto-cabinet-dbm.lisp (file)

Method: raise-error (DB kc-dbm) &optional MESSAGE &rest MESSAGE-ARGUMENTS

Source

kyoto-cabinet-dbm.lisp (file)

Generic Function: text CONDITION

Package

kyoto-cabinet

Methods

Method: text (CONDITION dbm-error)

Source

kyoto-cabinet.lisp (file)

5.2.5 Conditions

Condition: dbm-error ()

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Direct superclasses

error (condition)

Direct methods

• text (method)
• error-msg-of (method)
• error-code-of (method)

Direct slots

Slot: error-code

The error code provided by KC.

Initargs

:error-code

Initform

(quote nil)

Readers

error-code-of (generic function)

Slot: error-msg

The error message provided by KC.

Initargs

:error-msg

Initform

(quote nil)

Readers

error-msg-of (generic function)

Slot: text

Any additional message provided by the CL API.

Initform

(quote nil)

Readers

text (generic function)

5.2.6 Classes

Class: kc-iterator ()

A KC database iterator, the superclass of both B+ tree cursors and hash iterators.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• iter-remove (method)
• iter-go-to-fast (method)
• iter-go-to (method)
• iter-go-to (method)
• iter-go-to (method)
• iter-next (method)
• iter-first (method)
• iter-value-fast (method)
• iter-value (method)
• iter-key-fast (method)
• iter-key (method)
• iter-item-fast (method)
• iter-item (method)
• iter-close (method)
• maybe-raise-error (method)
• raise-error (method)
• initialize-instance (method)
• ptr-of (method)
• ptr-of (method)

Direct slots

Slot: ptr

A KC pointer.

Initargs

:ptr

Readers

ptr-of (generic function)

Writers

(setf ptr-of) (generic function)

5.2.7 Types

Type: int32 ()

The 32bit built-in DBM key type.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Type: int64 ()

The 64bit built-in DBM key type.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Type: octet ()

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions