Symisc UnQLite

An Embeddable NoSQL Database Engine


Follow @symisc

unQLite C/C++ API Reference.

These pages define the C-language interface to UnQLite.

This is not a tutorial. These pages are designed to be precise. Not easy to read.

For a tutorial introduction see UnQLite In 5 Minutes Or Less, An Introduction To The UnQLite C/C++ Interface, The UnQLite Architecture or An Introduction To Jx9.

This version of the C-language interface reference is broken down into small pages for easy viewing.

The same content is also available as a single large HTML or PDF file for those who prefer that format.

The interface is broken down into three categories:

List Of Objects.

This is a list of all abstract objects and datatypes used by the UnQLite library. There are eleven exported objects in total, but the two most important are:

  • A database handle represented by the unqlite opaque pointer.
  • A virtual machine object resulting from successful compilation of the target Jx9 script and represented by the unqlite_vm opaque pointer.

List Of Constants.

This is a list of numeric constants used by UnQLite and represented by #defines in the unqlite.h header file. These constants are things such as numeric return values from various interfaces (e.g: UNQLITE_OK, UNQLITE_NOTFOUND, UNQLITE_BUSY, etc.).

Also, compile-time directives such as UNQLITE_ENBALE_THREADS are discussed here.

List Of Functions.

This is a list of all functions and methods operating on the objects and using and/or returning constants. There are many functions, but most applications only use a handful.

Symisc Systems
Copyright © Symisc Systems