The cl-kyoto-cabinet Reference Manual

Table of Contents

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

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.


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

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))

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

2 Systems

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


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

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

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

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 cl-kyoto-cabinet.asd

Location

cl-kyoto-cabinet.asd

Systems

cl-kyoto-cabinet (system)

Packages

cl-kyoto-cabinet-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Parent

cl-kyoto-cabinet (system)

Location

cl-kyoto-cabinet-package.lisp

Packages

Next: , Previous: , Up: Lisp files   [Contents][Index]

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
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

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

Dependencies
Parent

cl-kyoto-cabinet (system)

Location

kyoto-cabinet.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

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

Dependencies
Parent

cl-kyoto-cabinet (system)

Location

kyoto-cabinet-dbm.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-kyoto-cabinet-system

Source

cl-kyoto-cabinet.asd

Use List

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

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
Exported Definitions
Internal Definitions

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

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
Used By List

kyoto-cabinet

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *in-transaction-p*

Bound when in a transaction.

Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

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)


Previous: , Up: Exported definitions   [Contents][Index]

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
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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.5 Conditions

Condition: dbm-error ()
Package

kyoto-cabinet

Source

kyoto-cabinet.lisp (file)

Direct superclasses

error (condition)

Direct methods
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)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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
Direct slots
Slot: ptr

A KC pointer.

Initargs

:ptr

Readers

ptr-of (generic function)

Writers

(setf ptr-of) (generic function)


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-kyoto-cabinet.asd: The cl-kyoto-cabinet<dot>asd file
cl-kyoto-cabinet/cl-kyoto-cabinet-package.lisp: The cl-kyoto-cabinet/cl-kyoto-cabinet-package<dot>lisp file
cl-kyoto-cabinet/kyoto-cabinet-dbm.lisp: The cl-kyoto-cabinet/kyoto-cabinet-dbm<dot>lisp file
cl-kyoto-cabinet/kyoto-cabinet-ffi.lisp: The cl-kyoto-cabinet/kyoto-cabinet-ffi<dot>lisp file
cl-kyoto-cabinet/kyoto-cabinet.lisp: The cl-kyoto-cabinet/kyoto-cabinet<dot>lisp file

F
File, Lisp, cl-kyoto-cabinet.asd: The cl-kyoto-cabinet<dot>asd file
File, Lisp, cl-kyoto-cabinet/cl-kyoto-cabinet-package.lisp: The cl-kyoto-cabinet/cl-kyoto-cabinet-package<dot>lisp file
File, Lisp, cl-kyoto-cabinet/kyoto-cabinet-dbm.lisp: The cl-kyoto-cabinet/kyoto-cabinet-dbm<dot>lisp file
File, Lisp, cl-kyoto-cabinet/kyoto-cabinet-ffi.lisp: The cl-kyoto-cabinet/kyoto-cabinet-ffi<dot>lisp file
File, Lisp, cl-kyoto-cabinet/kyoto-cabinet.lisp: The cl-kyoto-cabinet/kyoto-cabinet<dot>lisp file

L
Lisp File, cl-kyoto-cabinet.asd: The cl-kyoto-cabinet<dot>asd file
Lisp File, cl-kyoto-cabinet/cl-kyoto-cabinet-package.lisp: The cl-kyoto-cabinet/cl-kyoto-cabinet-package<dot>lisp file
Lisp File, cl-kyoto-cabinet/kyoto-cabinet-dbm.lisp: The cl-kyoto-cabinet/kyoto-cabinet-dbm<dot>lisp file
Lisp File, cl-kyoto-cabinet/kyoto-cabinet-ffi.lisp: The cl-kyoto-cabinet/kyoto-cabinet-ffi<dot>lisp file
Lisp File, cl-kyoto-cabinet/kyoto-cabinet.lisp: The cl-kyoto-cabinet/kyoto-cabinet<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

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

%
%var-accessor-kcversion: Internal functions
%var-accessor-kcvisnop: Internal functions
%var-accessor-kcvisremove: Internal functions

(
(setf %var-accessor-kcversion): Internal functions
(setf %var-accessor-kcvisnop): Internal functions
(setf %var-accessor-kcvisremove): Internal functions
(setf ptr-of): Internal generic functions
(setf ptr-of): Internal generic functions
(setf ptr-of): Internal generic functions

C
check-open-mode: Internal functions
convert-from-lisp: Internal generic functions
convert-from-lisp: Internal generic functions
convert-from-lisp: Internal generic functions
convert-from-lisp: Internal generic functions
convert-to-lisp: Internal generic functions
convert-to-lisp: Internal generic functions
convert-to-lisp: Internal generic functions
convert-to-lisp: Internal generic functions
copy-foreign-value: Internal functions

D
dbm-begin: Exported generic functions
dbm-begin: Exported generic functions
dbm-cache: Exported generic functions
dbm-clear: Exported generic functions
dbm-clear: Exported generic functions
dbm-close: Exported generic functions
dbm-close: Exported generic functions
dbm-commit: Exported generic functions
dbm-commit: Exported generic functions
dbm-delete: Exported generic functions
dbm-delete: Exported generic functions
dbm-file-namestring: Internal generic functions
dbm-file-size: Exported generic functions
dbm-get: Exported generic functions
dbm-get: Exported generic functions
dbm-get: Exported generic functions
dbm-get: Exported generic functions
dbm-get-fast: Exported functions
dbm-num-records: Exported generic functions
dbm-num-records: Exported generic functions
dbm-open: Exported generic functions
dbm-open: Exported generic functions
dbm-optimize: Exported generic functions
dbm-put: Exported generic functions
dbm-put: Exported generic functions
dbm-put: Exported generic functions
dbm-put: Exported generic functions
dbm-put: Exported generic functions
dbm-put: Exported generic functions
dbm-put-fast: Exported functions
dbm-remove: Exported generic functions
dbm-remove: Exported generic functions
dbm-remove: Exported generic functions
dbm-remove: Exported generic functions
dbm-remove-fast: Exported functions
dbm-rollback: Exported generic functions
dbm-rollback: Exported generic functions
dbm-xmsize: Exported generic functions
defanonenum: Internal macros

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

F
Function, %var-accessor-kcversion: Internal functions
Function, %var-accessor-kcvisnop: Internal functions
Function, %var-accessor-kcvisremove: Internal functions
Function, (setf %var-accessor-kcversion): Internal functions
Function, (setf %var-accessor-kcvisnop): Internal functions
Function, (setf %var-accessor-kcvisremove): Internal functions
Function, check-open-mode: Internal functions
Function, copy-foreign-value: Internal functions
Function, dbm-get-fast: Exported functions
Function, dbm-put-fast: Exported functions
Function, dbm-remove-fast: Exported functions
Function, get-int32->octets: Internal functions
Function, get-int32->string: Internal functions
Function, get-octets->octets: Internal functions
Function, get-octets->string: Internal functions
Function, get-pointer: Internal functions
Function, get-pointer->pointer: Internal functions
Function, get-something: Internal functions
Function, get-string->octets: Internal functions
Function, get-string->string: Internal functions
Function, kcatof: Internal functions
Function, kcatoi: Internal functions
Function, kcatoix: Internal functions
Function, kcchkinf: Internal functions
Function, kcchknan: Internal functions
Function, kccuraccept: Internal functions
Function, kccurdb: Exported functions
Function, kccurdel: Exported functions
Function, kccurecode: Internal functions
Function, kccuremsg: Internal functions
Function, kccurget: Exported functions
Function, kccurgetkey: Exported functions
Function, kccurgetvalue: Exported functions
Function, kccurjump: Exported functions
Function, kccurjumpkey: Exported functions
Function, kccurremove: Exported functions
Function, kccursetvalue: Internal functions
Function, kccurstep: Exported functions
Function, kcdbaccept: Internal functions
Function, kcdbadd: Exported functions
Function, kcdbappend: Exported functions
Function, kcdbbegintran: Exported functions
Function, kcdbbegintrantry: Internal functions
Function, kcdbcas: Internal functions
Function, kcdbclear: Exported functions
Function, kcdbclose: Exported functions
Function, kcdbcopy: Internal functions
Function, kcdbcount: Exported functions
Function, kcdbcursor: Exported functions
Function, kcdbdel: Exported functions
Function, kcdbdumpsnap: Internal functions
Function, kcdbecode: Exported functions
Function, kcdbemsg: Exported functions
Function, kcdbendtran: Exported functions
Function, kcdbget: Exported functions
Function, kcdbgetbuf: Internal functions
Function, kcdbincrdouble: Internal functions
Function, kcdbincrint: Internal functions
Function, kcdbiterate: Internal functions
Function, kcdbloadsnap: Internal functions
Function, kcdbnew: Exported functions
Function, kcdbopen: Exported functions
Function, kcdbpath: Internal functions
Function, kcdbremove: Exported functions
Function, kcdbset: Exported functions
Function, kcdbsize: Internal functions
Function, kcdbstatus: Internal functions
Function, kcdbsync: Internal functions
Function, kcecodename: Internal functions
Function, kcfree: Exported functions
Function, kchashfnv: Internal functions
Function, kchashmurmur: Internal functions
Function, kcinf: Internal functions
Function, kcmalloc: Exported functions
Function, kcnan: Internal functions
Function, kctime: Internal functions
Function, make-octet-vector: Internal functions
Function, maybe-raise-error-with-ecode: Internal functions
Function, put-int32->octets: Internal functions
Function, put-int32->string: Internal functions
Function, put-octets->octets: Internal functions
Function, put-pointer->pointer: Internal functions
Function, put-string->octets: Internal functions
Function, put-string->string: Internal functions
Function, rem-int32->value: Internal functions
Function, rem-octets->value: Internal functions
Function, rem-pointer->value: Internal functions
Function, rem-string->value: Internal functions
Function, swig-lispify: Internal functions

G
Generic Function, (setf ptr-of): Internal generic functions
Generic Function, convert-from-lisp: Internal generic functions
Generic Function, convert-to-lisp: Internal generic functions
Generic Function, dbm-begin: Exported generic functions
Generic Function, dbm-cache: Exported generic functions
Generic Function, dbm-clear: Exported generic functions
Generic Function, dbm-close: Exported generic functions
Generic Function, dbm-commit: Exported generic functions
Generic Function, dbm-delete: Exported generic functions
Generic Function, dbm-file-namestring: Internal generic functions
Generic Function, dbm-file-size: Exported generic functions
Generic Function, dbm-get: Exported generic functions
Generic Function, dbm-num-records: Exported generic functions
Generic Function, dbm-open: Exported generic functions
Generic Function, dbm-optimize: Exported generic functions
Generic Function, dbm-put: Exported generic functions
Generic Function, dbm-remove: Exported generic functions
Generic Function, dbm-rollback: Exported generic functions
Generic Function, dbm-xmsize: Exported generic functions
Generic Function, error-code-of: Internal generic functions
Generic Function, error-msg-of: Internal generic functions
Generic Function, iter-close: Exported generic functions
Generic Function, iter-first: Exported generic functions
Generic Function, iter-go-to: Exported generic functions
Generic Function, iter-go-to-fast: Exported generic functions
Generic Function, iter-item: Exported generic functions
Generic Function, iter-item-fast: Exported generic functions
Generic Function, iter-iterate: Internal generic functions
Generic Function, iter-key: Exported generic functions
Generic Function, iter-key-fast: Exported generic functions
Generic Function, iter-last: Exported generic functions
Generic Function, iter-next: Exported generic functions
Generic Function, iter-open: Exported generic functions
Generic Function, iter-prev: Exported generic functions
Generic Function, iter-put: Exported generic functions
Generic Function, iter-remove: Exported generic functions
Generic Function, iter-value: Exported generic functions
Generic Function, iter-value-fast: Exported generic functions
Generic Function, maybe-raise-error: Internal generic functions
Generic Function, ptr-of: Internal generic functions
Generic Function, put-method-for: Internal generic functions
Generic Function, raise-error: Internal generic functions
Generic Function, set-comparator: Exported generic functions
Generic Function, text: Internal generic functions
get-int32->octets: Internal functions
get-int32->string: Internal functions
get-octets->octets: Internal functions
get-octets->string: Internal functions
get-pointer: Internal functions
get-pointer->pointer: Internal functions
get-something: Internal functions
get-string->octets: Internal functions
get-string->string: Internal functions

I
iter-close: Exported generic functions
iter-close: Exported generic functions
iter-first: Exported generic functions
iter-first: Exported generic functions
iter-go-to: Exported generic functions
iter-go-to: Exported generic functions
iter-go-to: Exported generic functions
iter-go-to: Exported generic functions
iter-go-to-fast: Exported generic functions
iter-go-to-fast: Exported generic functions
iter-item: Exported generic functions
iter-item: Exported generic functions
iter-item-fast: Exported generic functions
iter-item-fast: Exported generic functions
iter-iterate: Internal generic functions
iter-key: Exported generic functions
iter-key: Exported generic functions
iter-key-fast: Exported generic functions
iter-key-fast: Exported generic functions
iter-last: Exported generic functions
iter-next: Exported generic functions
iter-next: Exported generic functions
iter-open: Exported generic functions
iter-open: Exported generic functions
iter-prev: Exported generic functions
iter-put: Exported generic functions
iter-remove: Exported generic functions
iter-remove: Exported generic functions
iter-value: Exported generic functions
iter-value: Exported generic functions
iter-value-fast: Exported generic functions
iter-value-fast: Exported generic functions

K
kcatof: Internal functions
kcatoi: Internal functions
kcatoix: Internal functions
kcchkinf: Internal functions
kcchknan: Internal functions
kccuraccept: Internal functions
kccurdb: Exported functions
kccurdel: Exported functions
kccurecode: Internal functions
kccuremsg: Internal functions
kccurget: Exported functions
kccurgetkey: Exported functions
kccurgetvalue: Exported functions
kccurjump: Exported functions
kccurjumpkey: Exported functions
kccurremove: Exported functions
kccursetvalue: Internal functions
kccurstep: Exported functions
kcdbaccept: Internal functions
kcdbadd: Exported functions
kcdbappend: Exported functions
kcdbbegintran: Exported functions
kcdbbegintrantry: Internal functions
kcdbcas: Internal functions
kcdbclear: Exported functions
kcdbclose: Exported functions
kcdbcopy: Internal functions
kcdbcount: Exported functions
kcdbcursor: Exported functions
kcdbdel: Exported functions
kcdbdumpsnap: Internal functions
kcdbecode: Exported functions
kcdbemsg: Exported functions
kcdbendtran: Exported functions
kcdbget: Exported functions
kcdbgetbuf: Internal functions
kcdbincrdouble: Internal functions
kcdbincrint: Internal functions
kcdbiterate: Internal functions
kcdbloadsnap: Internal functions
kcdbnew: Exported functions
kcdbopen: Exported functions
kcdbpath: Internal functions
kcdbremove: Exported functions
kcdbset: Exported functions
kcdbsize: Internal functions
kcdbstatus: Internal functions
kcdbsync: Internal functions
kcecodename: Internal functions
kcfree: Exported functions
kchashfnv: Internal functions
kchashmurmur: Internal functions
kcinf: Internal functions
kcmalloc: Exported functions
kcnan: Internal functions
kctime: Internal functions

M
Macro, defanonenum: Internal macros
Macro, with-database: Exported macros
Macro, with-iterator: Exported macros
Macro, with-string-value: Internal macros
Macro, with-transaction: Exported macros
make-octet-vector: Internal functions
maybe-raise-error: Internal generic functions
maybe-raise-error: Internal generic functions
maybe-raise-error: Internal generic functions
maybe-raise-error-with-ecode: Internal functions
Method, (setf ptr-of): Internal generic functions
Method, (setf ptr-of): Internal generic functions
Method, convert-from-lisp: Internal generic functions
Method, convert-from-lisp: Internal generic functions
Method, convert-from-lisp: Internal generic functions
Method, convert-to-lisp: Internal generic functions
Method, convert-to-lisp: Internal generic functions
Method, convert-to-lisp: Internal generic functions
Method, dbm-begin: Exported generic functions
Method, dbm-clear: Exported generic functions
Method, dbm-close: Exported generic functions
Method, dbm-commit: Exported generic functions
Method, dbm-delete: Exported generic functions
Method, dbm-get: Exported generic functions
Method, dbm-get: Exported generic functions
Method, dbm-get: Exported generic functions
Method, dbm-num-records: Exported generic functions
Method, dbm-open: Exported generic functions
Method, dbm-put: Exported generic functions
Method, dbm-put: Exported generic functions
Method, dbm-put: Exported generic functions
Method, dbm-put: Exported generic functions
Method, dbm-put: Exported generic functions
Method, dbm-remove: Exported generic functions
Method, dbm-remove: Exported generic functions
Method, dbm-remove: Exported generic functions
Method, dbm-rollback: Exported generic functions
Method, error-code-of: Internal generic functions
Method, error-msg-of: Internal generic functions
Method, iter-close: Exported generic functions
Method, iter-first: Exported generic functions
Method, iter-go-to: Exported generic functions
Method, iter-go-to: Exported generic functions
Method, iter-go-to: Exported generic functions
Method, iter-go-to-fast: Exported generic functions
Method, iter-item: Exported generic functions
Method, iter-item-fast: Exported generic functions
Method, iter-key: Exported generic functions
Method, iter-key-fast: Exported generic functions
Method, iter-next: Exported generic functions
Method, iter-open: Exported generic functions
Method, iter-remove: Exported generic functions
Method, iter-value: Exported generic functions
Method, iter-value-fast: Exported generic functions
Method, maybe-raise-error: Internal generic functions
Method, maybe-raise-error: Internal generic functions
Method, ptr-of: Internal generic functions
Method, ptr-of: Internal generic functions
Method, put-method-for: Internal generic functions
Method, put-method-for: Internal generic functions
Method, put-method-for: Internal generic functions
Method, raise-error: Internal generic functions
Method, raise-error: Internal generic functions
Method, text: Internal generic functions

P
ptr-of: Internal generic functions
ptr-of: Internal generic functions
ptr-of: Internal generic functions
put-int32->octets: Internal functions
put-int32->string: Internal functions
put-method-for: Internal generic functions
put-method-for: Internal generic functions
put-method-for: Internal generic functions
put-method-for: Internal generic functions
put-octets->octets: Internal functions
put-pointer->pointer: Internal functions
put-string->octets: Internal functions
put-string->string: Internal functions

R
raise-error: Internal generic functions
raise-error: Internal generic functions
raise-error: Internal generic functions
rem-int32->value: Internal functions
rem-octets->value: Internal functions
rem-pointer->value: Internal functions
rem-string->value: Internal functions

S
set-comparator: Exported generic functions
swig-lispify: Internal functions

T
text: Internal generic functions
text: Internal generic functions

W
with-database: Exported macros
with-iterator: Exported macros
with-string-value: Internal macros
with-transaction: Exported macros

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

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

A.3 Variables

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

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

E
error-code: Internal conditions
error-msg: Internal conditions

K
kcversion: Internal symbol macros
kcvisnop: Internal symbol macros
kcvisremove: Internal symbol macros

P
ptr: Exported classes
ptr: Internal classes

S
Slot, error-code: Internal conditions
Slot, error-msg: Internal conditions
Slot, ptr: Exported classes
Slot, ptr: Internal classes
Slot, text: Internal conditions
Special Variable, *in-transaction-p*: Exported special variables
Symbol Macro, kcversion: Internal symbol macros
Symbol Macro, kcvisnop: Internal symbol macros
Symbol Macro, kcvisremove: Internal symbol macros

T
text: Internal conditions

Jump to:   *  
E   K   P   S   T  

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

A.4 Data types

Jump to:   C   D   I   K   O   P   S   T  
Index Entry  Section

C
cl-kyoto-cabinet: The cl-kyoto-cabinet system
cl-kyoto-cabinet-system: The cl-kyoto-cabinet-system package
Class, kc-dbm: Exported classes
Class, kc-iterator: Internal classes
Condition, dbm-error: Internal conditions

D
dbm-error: Internal conditions

I
int32: Internal types
int64: Internal types

K
kc-dbm: Exported classes
kc-iterator: Internal classes
kyoto-cabinet: The kyoto-cabinet package
kyoto-cabinet-ffi: The kyoto-cabinet-ffi package

O
octet: Internal types

P
Package, cl-kyoto-cabinet-system: The cl-kyoto-cabinet-system package
Package, kyoto-cabinet: The kyoto-cabinet package
Package, kyoto-cabinet-ffi: The kyoto-cabinet-ffi package

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

T
Type, int32: Internal types
Type, int64: Internal types
Type, octet: Internal types

Jump to:   C   D   I   K   O   P   S   T