The cl-mdb Reference Manual

Child Components

tools/cl-murmurhash-3-singlefile.lisp (file).
tools/ctime.lisp (file).
tools/snowflake-id.lisp (file).
packages.lisp (file).
mdb-index.lisp (file).
mdb-value.lisp (file).
mdb.lisp (file).
mdb-test.lisp (file).

2 Files

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

Lisp

2.1 Lisp

cl-mdb/cl-mdb.asd
cl-mdb/tools/cl-murmurhash-3-singlefile.lisp
cl-mdb/tools/ctime.lisp
cl-mdb/tools/snowflake-id.lisp
cl-mdb/packages.lisp
cl-mdb/mdb-index.lisp
cl-mdb/mdb-value.lisp
cl-mdb/mdb.lisp
cl-mdb/mdb-test.lisp

2.1.1 `cl-mdb/cl-mdb.asd`

Source: cl-mdb.asd.
Parent Component: cl-mdb (system).
ASDF Systems: cl-mdb.

2.1.2 `cl-mdb/tools/cl-murmurhash-3-singlefile.lisp`

Source

Parent Component

cl-mdb (system).

Packages

cl-murmurhash-3.

Public Interface

murmur3-x64-128 (function).
murmur3-x86-128 (function).
murmur3-x86-32 (function).

Internals

eightbytes (function).
fmix32 (function).
fmix64 (function).
fourbytes (function).
rotl32 (function).
rotl64 (function).

2.1.3 `cl-mdb/tools/ctime.lisp`

Dependency

tools/cl-murmurhash-3-singlefile.lisp (file).

Source

Parent Component

cl-mdb (system).

Packages

Public Interface

*daylight* (symbol macro).
*timezone* (symbol macro).
*tzname* (symbol macro).
c-asctime (function).
c-ctime (function).
c-difftime (function).
c-gettimeofday (function).
c-gmtime (function).
c-localtime (function).
c-mktime (function).
c-strftime (function).
c-strptime (function).
c-time (function).
c-timegm (function).
c-timelocal (function).

Internals

%var-accessor-*daylight* (function).
(setf %var-accessor-*daylight*) (function).
%var-accessor-*timezone* (function).
(setf %var-accessor-*timezone*) (function).
%var-accessor-*tzname* (function).
(setf %var-accessor-*tzname*) (function).
asctime_r (function).
ctime_r (function).
difftime (function).
gettimeofday (function).
gmtime_r (function).
localtime_r (function).
mktime (function).
strftime (function).
strptime (function).
time1 (function).
timegm (function).
timespec-tclass (class).
timeval-tclass (class).
timezone_-tclass (class).
tm-tclass (class).

2.1.4 `cl-mdb/tools/snowflake-id.lisp`

Dependency

tools/ctime.lisp (file).

Source

Parent Component

cl-mdb (system).

Packages

snowflake-id.

Public Interface

*genidm-counter* (special variable).
*genids-counter* (special variable).
*genids2-counter* (special variable).
genid (function).
genidm (function).
genids (function).
genids2 (function).

Internals

+snid-epoch+ (constant).
incf-counter (function).

2.1.5 `cl-mdb/packages.lisp`

Dependency: tools/snowflake-id.lisp (file).
Source: cl-mdb.asd.
Parent Component: cl-mdb (system).
Packages: cl-mdb.

2.1.6 `cl-mdb/mdb-index.lisp`

Dependency

packages.lisp (file).

Source

Parent Component

cl-mdb (system).

Internals

gc-index (function).
hash-key (function).
init-index-array (function).
insert-before-greater (function).
insert-index (function).
insert-key (function).
re-index (function).
select-index (function).
select-key (function).

2.1.7 `cl-mdb/mdb-value.lisp`

Dependency

mdb-index.lisp (file).

Source

Parent Component

cl-mdb (system).

Internals

*node-id* (special variable).
copy-row (function).
generate-row (function).
init-store-list (function).
insert-value (function).
make-row (function).
push-value (function).
row (structure).
row-content (reader).
(setf row-content) (writer).
row-operation-id (reader).
(setf row-operation-id) (writer).
row-original-key (reader).
(setf row-original-key) (writer).
row-p (function).
row-read-flag (reader).
(setf row-read-flag) (writer).
row-remove-flag (reader).
(setf row-remove-flag) (writer).
row-time (reader).
(setf row-time) (writer).
row-uuid (reader).
(setf row-uuid) (writer).
row-write-flag (reader).
(setf row-write-flag) (writer).

2.1.8 `cl-mdb/mdb.lisp`

Dependency

mdb-value.lisp (file).

Source

tools/snowflake-id.lisp.

Parent Component

cl-mdb (system).

Public Interface

gbc (function).
init-root-list (function).
insert (function).
mdump (function).
mload (function).
remov (function).
select (function).
update (function).

2.1.9 `cl-mdb/mdb-test.lisp`

Dependency: mdb.lisp (file).
Source: cl-mdb.asd.
Parent Component: cl-mdb (system).
Public Interface: test (function).
Internals: random-string (function).

3 Packages

Packages are listed by definition order.

snowflake-id
cl-mdb
ctime
cl-murmurhash-3

3.1 `snowflake-id`

Source

Nickname

snid

Use List

common-lisp.
ctime.

Used By List

cl-mdb.

Public Interface

*genidm-counter* (special variable).
*genids-counter* (special variable).
*genids2-counter* (special variable).
genid (function).
genidm (function).
genids (function).
genids2 (function).

Internals

+snid-epoch+ (constant).
incf-counter (function).

3.2 `cl-mdb`

a simple in-memory key-value database

Source

packages.lisp.

Nickname

mdb

Use List

cl-murmurhash-3.
common-lisp.
snowflake-id.

Public Interface

gbc (function).
init-root-list (function).
insert (function).
mdump (function).
mload (function).
remov (function).
select (function).
test (function).
update (function).

Internals

*node-id* (special variable).
copy-row (function).
gc-index (function).
generate-row (function).
hash-key (function).
init-index-array (function).
init-store-list (function).
insert-before-greater (function).
insert-index (function).
insert-key (function).
insert-value (function).
make-row (function).
push-value (function).
random-string (function).
re-index (function).
row (structure).
row-content (reader).
(setf row-content) (writer).
row-operation-id (reader).
(setf row-operation-id) (writer).
row-original-key (reader).
(setf row-original-key) (writer).
row-p (function).
row-read-flag (reader).
(setf row-read-flag) (writer).
row-remove-flag (reader).
(setf row-remove-flag) (writer).
row-time (reader).
(setf row-time) (writer).
row-uuid (reader).
(setf row-uuid) (writer).
row-write-flag (reader).
(setf row-write-flag) (writer).
select-index (function).
select-key (function).

3.3 `ctime`

a Common Lisp interface for glibc date and time part

Source

tools/cl-murmurhash-3-singlefile.lisp.

Nickname

ct

Use List

cffi.
common-lisp.

Used By List

snowflake-id.

Public Interface

*daylight* (symbol macro).
*timezone* (symbol macro).
*tzname* (symbol macro).
c-asctime (function).
c-ctime (function).
c-difftime (function).
c-gettimeofday (function).
c-gmtime (function).
c-localtime (function).
c-mktime (function).
c-strftime (function).
c-strptime (function).
c-time (function).
c-timegm (function).
c-timelocal (function).

Internals

%var-accessor-*daylight* (function).
(setf %var-accessor-*daylight*) (function).
%var-accessor-*timezone* (function).
(setf %var-accessor-*timezone*) (function).
%var-accessor-*tzname* (function).
(setf %var-accessor-*tzname*) (function).
asctime_r (function).
ctime_r (function).
difftime (function).
gettimeofday (function).
gmtime_r (function).
localtime_r (function).
mktime (function).
strftime (function).
strptime (function).
time1 (function).
timegm (function).
timespec-tclass (class).
timeval-tclass (class).
timezone_-tclass (class).
tm-tclass (class).

3.4 `cl-murmurhash-3`

Source

Nicknames

mr3
murmur3

Use List

common-lisp.

Used By List

cl-mdb.

Public Interface

murmur3-x64-128 (function).
murmur3-x86-128 (function).
murmur3-x86-32 (function).

Internals

eightbytes (function).
fmix32 (function).
fmix64 (function).
fourbytes (function).
rotl32 (function).
rotl64 (function).

4 Definitions

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

Public Interface
Internals

4.1.1 Special variables

Special Variable: *genidm-counter* ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Special Variable: *genids-counter* ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Special Variable: *genids2-counter* ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

4.1.2 Symbol macros

Symbol Macro: *daylight* ¶

Package: ctime.
Source: tools/ctime.lisp.

Symbol Macro: *timezone* ¶

Package: ctime.
Source: tools/ctime.lisp.

Symbol Macro: *tzname* ¶

Package: ctime.
Source: tools/ctime.lisp.

4.1.3 Ordinary functions

Function: c-asctime (bt) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-ctime (timestamp) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-difftime (end begin) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-gettimeofday () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-gmtime (timestamp) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-localtime (timestamp) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-mktime (bt) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-strftime (fmt bt &optional maxlen) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-strptime (s fmt) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-time () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-timegm (bt) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: c-timelocal (bt) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: gbc (root-list) ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: genid (nodeid &optional counter) ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Function: genidm (nodeid &optional counter) ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Function: genids (nodeid &optional counter) ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Function: genids2 (nodeid &optional counter) ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Function: init-root-list () ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: insert (root-list key value) ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: mdump (root-list path) ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: mload (path) ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: murmur3-x64-128 (data seed) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: murmur3-x86-128 (data &optional seed) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: murmur3-x86-32 (data &optional seed) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: remov (root-list key) ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: select (root-list key) ¶

Package: cl-mdb.
Source: mdb.lisp.

Function: test () ¶

Package: cl-mdb.
Source: mdb-test.lisp.

Function: update (root-list key new-value) ¶

Package: cl-mdb.
Source: mdb.lisp.

4.2 Internals

Constants
Special variables
Ordinary functions
Structures
Classes

4.2.1 Constants

Constant: +snid-epoch+ ¶

2022-01-01T00:00:00+0800

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

4.2.2 Special variables

Special Variable: *node-id* ¶

machine node id

Package: cl-mdb.
Source: mdb-value.lisp.

4.2.3 Ordinary functions

Function: %var-accessor-*daylight* () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: (setf %var-accessor-*daylight*) () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: %var-accessor-*timezone* () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: (setf %var-accessor-*timezone*) () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: %var-accessor-*tzname* () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: (setf %var-accessor-*tzname*) () ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: asctime_r (brokentime buffer) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: copy-row (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Function: ctime_r (timestamp buffer) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: difftime (end begin) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: eightbytes (lst n) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: fmix32 (h) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: fmix64 (h) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: fourbytes (lst n) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: gc-index (key-array gc-key-list) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: generate-row (key value &optional counter) ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Function: gettimeofday (tv tz) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: gmtime_r (timestamp resultp) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: hash-key (key) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: incf-counter (counter &optional maxi) ¶

Package: snowflake-id.
Source: tools/snowflake-id.lisp.

Function: init-index-array () ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: init-store-list () ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Function: insert-before-greater (lst keyhash ptr) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: insert-index (key-array key ptr) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: insert-key (key-array key ptr) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: insert-value (store-list key value) ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Function: localtime_r (timestamp resultp) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: make-row (&key content original-key uuid time operation-id read-flag write-flag remove-flag) ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Function: mktime (brokentime) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: push-value (store-list key value) ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Function: random-string (len) ¶

Package: cl-mdb.
Source: mdb-test.lisp.

Function: re-index (root-list) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: rotl32 (x r) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Function: rotl64 (x r) ¶

Package: cl-murmurhash-3.
Source: tools/cl-murmurhash-3-singlefile.lisp.

Reader: row-content (instance) ¶

Writer: (setf row-content) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: content.

Reader: row-operation-id (instance) ¶

Writer: (setf row-operation-id) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: operation-id.

Reader: row-original-key (instance) ¶

Writer: (setf row-original-key) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: original-key.

Function: row-p (object) ¶

Package: cl-mdb.
Source: mdb-value.lisp.

Reader: row-read-flag (instance) ¶

Writer: (setf row-read-flag) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: read-flag.

Reader: row-remove-flag (instance) ¶

Writer: (setf row-remove-flag) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: remove-flag.

Reader: row-time (instance) ¶

Writer: (setf row-time) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: time.

Reader: row-uuid (instance) ¶

Writer: (setf row-uuid) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: uuid.

Reader: row-write-flag (instance) ¶

Writer: (setf row-write-flag) (instance) ¶

Package: cl-mdb.
Source: mdb-value.lisp.
Target Slot: write-flag.

Function: select-index (key-array key) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: select-key (key-array key) ¶

Package: cl-mdb.
Source: mdb-index.lisp.

Function: strftime (buf bufsize fmt brokentime) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: strptime (s fmt tp) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: time1 (ts) ¶

Package: ctime.
Source: tools/ctime.lisp.

Function: timegm (brokentime) ¶

Package: ctime.
Source: tools/ctime.lisp.

4.2.4 Structures

Structure: row ¶

Package

cl-mdb.

Source

mdb-value.lisp.

Direct superclasses

structure-object.

Direct slots

Slot: content ¶

Type: (or number character string sequence null)
Readers: row-content.
Writers: (setf row-content).

Slot: original-key ¶

Type: (or string null)
Readers: row-original-key.
Writers: (setf row-original-key).

Slot: uuid ¶

Type: (or string null)
Readers: row-uuid.
Writers: (setf row-uuid).

Slot: time ¶

Package: common-lisp.
Type: number
Initform: 0
Readers: row-time.
Writers: (setf row-time).

Slot: operation-id ¶

Type: (or number null)
Readers: row-operation-id.
Writers: (setf row-operation-id).

Slot: read-flag ¶

Type: boolean
Readers: row-read-flag.
Writers: (setf row-read-flag).

Slot: write-flag ¶

Type: boolean
Readers: row-write-flag.
Writers: (setf row-write-flag).

Slot: remove-flag ¶

Type: boolean
Readers: row-remove-flag.
Writers: (setf row-remove-flag).

4.2.5 Classes

Class: timespec-tclass ¶

Package

Source

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: timeval-tclass ¶

Package

Source

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: timezone_-tclass ¶

Package

Source

Direct superclasses

foreign-struct-type.
translatable-foreign-type.

Class: tm-tclass ¶

Package

Source