The liblmdb Reference Manual

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

The liblmdb Reference Manual

This is the liblmdb Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Aug 15 04:58:20 2022 GMT+0.

Table of Contents


1 Introduction

liblmdb

Low-level LMDB bindings.

Overview

This is a pure CFFI binding to LMDB, no macros or wrappers or anything. For a more complete interface, see this library.

License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.


2 Systems

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


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

2.1 liblmdb

Low-level LMDB bindings.

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/antimer/liblmdb

Source Control

(GIT git@github.com:antimer/liblmdb.git)

Bug Tracker

https://github.com/antimer/liblmdb/issues

License

MIT

Long Description

# liblmdb

Low-level [LMDB](http://symas.com/mdb/) bindings.

# Overview

This is a pure CFFI binding to LMDB, no macros or wrappers or anything. For a more complete interface, see [this][cl-lmdb] library.

# License

Copyright (c) 2016 Fernando Borretti

Licensed under the MIT License.

[cl-lmdb]: https://github.com/antimer/lmdb

Version

0.1

Dependency

cffi (system).

Source

liblmdb.asd.

Child Component

src (module).


3 Modules

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


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

3.1 liblmdb/src

Source

liblmdb.asd.

Parent Component

liblmdb (system).

Child Components

4 Files

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


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

4.1 Lisp


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

4.1.1 liblmdb/liblmdb.asd

Source

liblmdb.asd.

Parent Component

liblmdb (system).

ASDF Systems

liblmdb.


4.1.2 liblmdb/src/package.lisp

Source

liblmdb.asd.

Parent Component

src (module).

Packages

liblmdb.


4.1.3 liblmdb/src/lispify.lisp

Dependency

package.lisp (file).

Source

liblmdb.asd.

Parent Component

src (module).

Public Interface

defanonenum (macro).

Internals

swig-lispify (function).


4.1.4 liblmdb/src/liblmdb.lisp

Dependency

lispify.lisp (file).

Source

liblmdb.asd.

Parent Component

src (module).

Public Interface

5 Packages

Packages are listed by definition order.


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

5.1 liblmdb

The low-level LMDB interface.

Source

package.lisp.

Public Interface
Internals

swig-lispify (function).


6 Definitions

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


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

6.1 Public Interface


6.1.1 Constants

Constant: +append+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +appenddup+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +bad-dbi+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +bad-rslot+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +bad-txn+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +bad-valsize+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +corrupted+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +cp-compact+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +create+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +current+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +cursor-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +dbs-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +dupfixed+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +dupsort+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +fixedmap+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +incompatible+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +integerdup+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +integerkey+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +invalid+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +keyexist+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +last-errcode+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +map-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +map-resized+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +mapasync+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +multiple+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nodupdata+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nolock+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nomeminit+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nometasync+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nooverwrite+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nordahead+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nosubdir+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +nosync+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +notfound+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +notls+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +page-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +page-notfound+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +panic+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +rdonly+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +readers-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +reserve+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +reversedup+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +reversekey+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +success+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +tls-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +txn-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +version-full+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +version-major+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +version-minor+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +version-mismatch+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +version-patch+
Package

liblmdb.

Source

liblmdb.lisp.

Constant: +writemap+
Package

liblmdb.

Source

liblmdb.lisp.


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

6.1.2 Special variables

Special Variable: +version-date+
Package

liblmdb.

Source

liblmdb.lisp.

Special Variable: +version-string+
Package

liblmdb.

Source

liblmdb.lisp.


6.1.3 Macros

Macro: defanonenum (&body enums)

Converts anonymous enums to defconstants.

Package

liblmdb.

Source

lispify.lisp.


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

6.1.4 Ordinary functions

Function: cmp (txn dbi a b)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-close (cursor)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-count (cursor countp)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-dbi (cursor)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-del (cursor flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-get (cursor key data op)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-open (txn dbi cursor)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-put (cursor key data flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-renew (txn cursor)
Package

liblmdb.

Source

liblmdb.lisp.

Function: cursor-txn (cursor)
Package

liblmdb.

Source

liblmdb.lisp.

Function: dbi-close (env dbi)
Package

liblmdb.

Source

liblmdb.lisp.

Function: dbi-flags (txn dbi flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: dbi-open (txn name flags dbi)
Package

liblmdb.

Source

liblmdb.lisp.

Function: dcmp (txn dbi a b)
Package

liblmdb.

Source

liblmdb.lisp.

Function: del (txn dbi key data)
Package

liblmdb.

Source

liblmdb.lisp.

Function: drop (txn dbi del)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-close (env)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-copy (env path)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-copy-2 (env path flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-copyfd (env fd)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-copyfd-2 (env fd flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-create (env)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-get-fd (env fd)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-get-flags (env flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-get-maxkeysize (env)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-get-maxreaders (env readers)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-get-path (env path)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-get-userctx (env)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-info (env stat)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-open (env path flags mode)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-set-assert (env func)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-set-flags (env flags onoff)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-set-mapsize (env size)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-set-maxdbs (env dbs)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-set-maxreaders (env readers)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-set-userctx (env ctx)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-stat (env stat)
Package

liblmdb.

Source

liblmdb.lisp.

Function: env-sync (env force)
Package

liblmdb.

Source

liblmdb.lisp.

Function: get (txn dbi key data)
Package

liblmdb.

Source

liblmdb.lisp.

Function: put (txn dbi key data flags)
Package

liblmdb.

Source

liblmdb.lisp.

Function: reader-check (env dead)
Package

liblmdb.

Source

liblmdb.lisp.

Function: reader-list (env func ctx)
Package

liblmdb.

Source

liblmdb.lisp.

Function: set-compare (txn dbi cmp)
Package

liblmdb.

Source

liblmdb.lisp.

Function: set-dupsort (txn dbi cmp)
Package

liblmdb.

Source

liblmdb.lisp.

Function: set-relctx (txn dbi ctx)
Package

liblmdb.

Source

liblmdb.lisp.

Function: set-relfunc (txn dbi rel)
Package

liblmdb.

Source

liblmdb.lisp.

Function: stat (txn dbi stat)
Package

liblmdb.

Source

liblmdb.lisp.

Function: strerror (err)
Package

liblmdb.

Source

liblmdb.lisp.

Function: txn-abort (txn)
Package

liblmdb.

Source

liblmdb.lisp.

Function: txn-begin (env parent flags txn)
Package

liblmdb.

Source

liblmdb.lisp.

Function: txn-commit (txn)
Package

liblmdb.

Source

liblmdb.lisp.

Function: txn-env (txn)
Package

liblmdb.

Source

liblmdb.lisp.

Function: txn-renew (txn)
Package

liblmdb.

Source

liblmdb.lisp.

Function: txn-reset (txn)
Package

liblmdb.

Source

liblmdb.lisp.

Function: version (major minor patch)
Package

liblmdb.

Source

liblmdb.lisp.


6.1.5 Classes

Class: envinfo-tclass
Package

liblmdb.

Source

liblmdb.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: stat-tclass
Package

liblmdb.

Source

liblmdb.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.
Class: val-tclass
Package

liblmdb.

Source

liblmdb.lisp.

Direct superclasses
  • foreign-struct-type.
  • translatable-foreign-type.

6.2 Internals


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

6.2.1 Ordinary functions

Function: swig-lispify (name flag &optional package)
Package

liblmdb.

Source

lispify.lisp.


Appendix A Indexes


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

A.1 Concepts


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

A.2 Functions

Jump to:   C   D   E   F   G   M   P   R   S   T   V  
Index Entry  Section

C
cmp: Public ordinary functions
cursor-close: Public ordinary functions
cursor-count: Public ordinary functions
cursor-dbi: Public ordinary functions
cursor-del: Public ordinary functions
cursor-get: Public ordinary functions
cursor-open: Public ordinary functions
cursor-put: Public ordinary functions
cursor-renew: Public ordinary functions
cursor-txn: Public ordinary functions

D
dbi-close: Public ordinary functions
dbi-flags: Public ordinary functions
dbi-open: Public ordinary functions
dcmp: Public ordinary functions
defanonenum: Public macros
del: Public ordinary functions
drop: Public ordinary functions

E
env-close: Public ordinary functions
env-copy: Public ordinary functions
env-copy-2: Public ordinary functions
env-copyfd: Public ordinary functions
env-copyfd-2: Public ordinary functions
env-create: Public ordinary functions
env-get-fd: Public ordinary functions
env-get-flags: Public ordinary functions
env-get-maxkeysize: Public ordinary functions
env-get-maxreaders: Public ordinary functions
env-get-path: Public ordinary functions
env-get-userctx: Public ordinary functions
env-info: Public ordinary functions
env-open: Public ordinary functions
env-set-assert: Public ordinary functions
env-set-flags: Public ordinary functions
env-set-mapsize: Public ordinary functions
env-set-maxdbs: Public ordinary functions
env-set-maxreaders: Public ordinary functions
env-set-userctx: Public ordinary functions
env-stat: Public ordinary functions
env-sync: Public ordinary functions

F
Function, cmp: Public ordinary functions
Function, cursor-close: Public ordinary functions
Function, cursor-count: Public ordinary functions
Function, cursor-dbi: Public ordinary functions
Function, cursor-del: Public ordinary functions
Function, cursor-get: Public ordinary functions
Function, cursor-open: Public ordinary functions
Function, cursor-put: Public ordinary functions
Function, cursor-renew: Public ordinary functions
Function, cursor-txn: Public ordinary functions
Function, dbi-close: Public ordinary functions
Function, dbi-flags: Public ordinary functions
Function, dbi-open: Public ordinary functions
Function, dcmp: Public ordinary functions
Function, del: Public ordinary functions
Function, drop: Public ordinary functions
Function, env-close: Public ordinary functions
Function, env-copy: Public ordinary functions
Function, env-copy-2: Public ordinary functions
Function, env-copyfd: Public ordinary functions
Function, env-copyfd-2: Public ordinary functions
Function, env-create: Public ordinary functions
Function, env-get-fd: Public ordinary functions
Function, env-get-flags: Public ordinary functions
Function, env-get-maxkeysize: Public ordinary functions
Function, env-get-maxreaders: Public ordinary functions
Function, env-get-path: Public ordinary functions
Function, env-get-userctx: Public ordinary functions
Function, env-info: Public ordinary functions
Function, env-open: Public ordinary functions
Function, env-set-assert: Public ordinary functions
Function, env-set-flags: Public ordinary functions
Function, env-set-mapsize: Public ordinary functions
Function, env-set-maxdbs: Public ordinary functions
Function, env-set-maxreaders: Public ordinary functions
Function, env-set-userctx: Public ordinary functions
Function, env-stat: Public ordinary functions
Function, env-sync: Public ordinary functions
Function, get: Public ordinary functions
Function, put: Public ordinary functions
Function, reader-check: Public ordinary functions
Function, reader-list: Public ordinary functions
Function, set-compare: Public ordinary functions
Function, set-dupsort: Public ordinary functions
Function, set-relctx: Public ordinary functions
Function, set-relfunc: Public ordinary functions
Function, stat: Public ordinary functions
Function, strerror: Public ordinary functions
Function, swig-lispify: Private ordinary functions
Function, txn-abort: Public ordinary functions
Function, txn-begin: Public ordinary functions
Function, txn-commit: Public ordinary functions
Function, txn-env: Public ordinary functions
Function, txn-renew: Public ordinary functions
Function, txn-reset: Public ordinary functions
Function, version: Public ordinary functions

G
get: Public ordinary functions

M
Macro, defanonenum: Public macros

P
put: Public ordinary functions

R
reader-check: Public ordinary functions
reader-list: Public ordinary functions

S
set-compare: Public ordinary functions
set-dupsort: Public ordinary functions
set-relctx: Public ordinary functions
set-relfunc: Public ordinary functions
stat: Public ordinary functions
strerror: Public ordinary functions
swig-lispify: Private ordinary functions

T
txn-abort: Public ordinary functions
txn-begin: Public ordinary functions
txn-commit: Public ordinary functions
txn-env: Public ordinary functions
txn-renew: Public ordinary functions
txn-reset: Public ordinary functions

V
version: Public ordinary functions

Jump to:   C   D   E   F   G   M   P   R   S   T   V  

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

A.3 Variables

Jump to:   +  
C   S  
Index Entry  Section

+
+append+: Public constants
+appenddup+: Public constants
+bad-dbi+: Public constants
+bad-rslot+: Public constants
+bad-txn+: Public constants
+bad-valsize+: Public constants
+corrupted+: Public constants
+cp-compact+: Public constants
+create+: Public constants
+current+: Public constants
+cursor-full+: Public constants
+dbs-full+: Public constants
+dupfixed+: Public constants
+dupsort+: Public constants
+fixedmap+: Public constants
+incompatible+: Public constants
+integerdup+: Public constants
+integerkey+: Public constants
+invalid+: Public constants
+keyexist+: Public constants
+last-errcode+: Public constants
+map-full+: Public constants
+map-resized+: Public constants
+mapasync+: Public constants
+multiple+: Public constants
+nodupdata+: Public constants
+nolock+: Public constants
+nomeminit+: Public constants
+nometasync+: Public constants
+nooverwrite+: Public constants
+nordahead+: Public constants
+nosubdir+: Public constants
+nosync+: Public constants
+notfound+: Public constants
+notls+: Public constants
+page-full+: Public constants
+page-notfound+: Public constants
+panic+: Public constants
+rdonly+: Public constants
+readers-full+: Public constants
+reserve+: Public constants
+reversedup+: Public constants
+reversekey+: Public constants
+success+: Public constants
+tls-full+: Public constants
+txn-full+: Public constants
+version-date+: Public special variables
+version-full+: Public constants
+version-major+: Public constants
+version-minor+: Public constants
+version-mismatch+: Public constants
+version-patch+: Public constants
+version-string+: Public special variables
+writemap+: Public constants

C
Constant, +append+: Public constants
Constant, +appenddup+: Public constants
Constant, +bad-dbi+: Public constants
Constant, +bad-rslot+: Public constants
Constant, +bad-txn+: Public constants
Constant, +bad-valsize+: Public constants
Constant, +corrupted+: Public constants
Constant, +cp-compact+: Public constants
Constant, +create+: Public constants
Constant, +current+: Public constants
Constant, +cursor-full+: Public constants
Constant, +dbs-full+: Public constants
Constant, +dupfixed+: Public constants
Constant, +dupsort+: Public constants
Constant, +fixedmap+: Public constants
Constant, +incompatible+: Public constants
Constant, +integerdup+: Public constants
Constant, +integerkey+: Public constants
Constant, +invalid+: Public constants
Constant, +keyexist+: Public constants
Constant, +last-errcode+: Public constants
Constant, +map-full+: Public constants
Constant, +map-resized+: Public constants
Constant, +mapasync+: Public constants
Constant, +multiple+: Public constants
Constant, +nodupdata+: Public constants
Constant, +nolock+: Public constants
Constant, +nomeminit+: Public constants
Constant, +nometasync+: Public constants
Constant, +nooverwrite+: Public constants
Constant, +nordahead+: Public constants
Constant, +nosubdir+: Public constants
Constant, +nosync+: Public constants
Constant, +notfound+: Public constants
Constant, +notls+: Public constants
Constant, +page-full+: Public constants
Constant, +page-notfound+: Public constants
Constant, +panic+: Public constants
Constant, +rdonly+: Public constants
Constant, +readers-full+: Public constants
Constant, +reserve+: Public constants
Constant, +reversedup+: Public constants
Constant, +reversekey+: Public constants
Constant, +success+: Public constants
Constant, +tls-full+: Public constants
Constant, +txn-full+: Public constants
Constant, +version-full+: Public constants
Constant, +version-major+: Public constants
Constant, +version-minor+: Public constants
Constant, +version-mismatch+: Public constants
Constant, +version-patch+: Public constants
Constant, +writemap+: Public constants

S
Special Variable, +version-date+: Public special variables
Special Variable, +version-string+: Public special variables

Jump to:   +  
C   S