Skip to content

Latest commit

 

History

History
86 lines (59 loc) · 2.92 KB

README.md

File metadata and controls

86 lines (59 loc) · 2.92 KB
Raw

SQLite3-OCaml - SQLite3 Bindings for OCaml

What is SQLite3-OCaml?

SQLite3-OCaml is an OCaml library with bindings to the SQLite3 client API. Sqlite3 is a self-contained, serverless, zero-configuration, transactional SQL database engine with outstanding performance for many use cases.

These bindings are written in a way that enables a friendly coexistence with the old (version 2) SQLite and its OCaml wrapper ocaml-sqlite.

Usage

The API in file lib/sqlite3.mli is fully documented, and HTML-documentation can be built using make doc and installed with this distribution. It can also be found online.

SQLite3 has its own online documentation.

Examples

The test-directory in this distribution contains a few simple examples for testing various features of this library.

Build issues

SQLite3-OCaml depends on pkg-config to locate and compile against an SQLite3 library.

If the SQLite3 version is larger than or equal to 3.3.7, it is assumed that it supports Run-Time Loadable Extensions. If this feature has been explicitly disabled in the library, the build will fail with:

Undefined symbols for architecture ...:
  "_sqlite3_enable_load_extension", referenced from:
      _caml_sqlite3_enable_load_extension in libsqlite3_stubs.a(sqlite3_stubs.o)
     (maybe you meant: _caml_sqlite3_enable_load_extension)

  • You can check if your library is missing loadable extensions by searching it for the string OMIT_LOAD_EXTENSION.

  • If you need to change where pkg-config will look for the SQLite3 library, set the PKG_CONFIG_PATH environment variable to the new directory.

Credits

  • Enrico Tassi contributed support for user-defined scalar functions.

  • Markus Mottl rewrote Christian's bindings for Jane Street Holding, LLC to clean up a few things and to make it perform better in multi-threaded environments.

  • Christian Szegedy wrote the initial release for SQLite version 3.

  • Mikhail Fedotov wrote ocaml-sqlite for SQLite version 2. His bindings served as a reference for this wrapper, but sqlite3 is written completely from scratch since the C interface changed significantly.

Contact Information and Contributing

In the case of bugs, feature requests, contributions and similar, please contact the maintainers:

Up-to-date information should be available at: http://mmottl.github.io/sqlite3-ocaml

Enjoy!

Markus Mottl on February 9, 2015