cozo-hs: Haskell bindings to the CozoDB C API

[ database, library, mpl ] [ Propose Tags ]

Simple, relatively low-level bindings to the C API provided by cozo. Additionally, there are some convenience types for serializing function arguments and deserializing query results.


[Skip to Readme]

Modules

[Index] [Quick Jump]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.1.0.0
Change log CHANGELOG.md
Dependencies aeson (>=2.2.1 && <2.3), base (>=4.18.0.0 && <4.19), bytestring (>=0.11.4 && <0.12), text (>=2.0.2 && <2.1) [details]
License MPL-2.0
Author Henry Johnson
Maintainer hencutJohnson@gmail.com
Category Database
Uploaded by HenryJohnson at 2023-11-04T23:37:13Z
Distributions
Downloads 24 total (5 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs uploaded by user
Build status unknown [no reports yet]

Readme for cozo-hs-0.1.0.0

[back to package description]

cozo-hs

A library with bindings and simple types to the C API of the embeddable Cozo database.

Installation

This library relies on pkg-config for libcozo_c being available on your system. You will need to have cozo_c.h and libcozo_c.so installed somewhere your linker can find it and it must be registered with pkg-config.

To do so, you can download both the header files as well as the library from the Cozo project repository or you could clone that repository and build it from source.

If there is no official way to install this library on your OS/Distro (Debian for example) then you can put the library and headers in common paths (/usr/local/lib, /usr/local/include respectively) then manually create a pkg-config file for them. Just make sure that the version you specify matches what you have installed!

Here is an example libcozo_c.pc:

Name: cozo_c
Description: C Interface with the Cozo embeddable database.
Version: 0.7.5
Cflags: -I/usr/local/include
Libs: -L/usr/local/lib -lcozo_c

After that, a simple cabal build can make sure that the C compiler is linking correctly.

After building, you may want to ensure that the runtime is linked correctly as well. Run cabal repl to try out some of the code or cabal test to run the test-suite.

Following all of this, you can include this library as a dependency in other Cabal projects the normal way.

Notes on Usage

This library makes heavy use of aeson given that the C API is defined almost entirely in terms of JSON. Therefore, some primitive data types which match the structure of returned JSON are provided as part of this library.

If you desire to use your own serialization scheme rather than the types provided, the underlying bindings are exposed in the form of functions with a ' suffix. All of these functions deal with strict ByteStrings that are marshalled from the strings produced by C.

All errors are handled in a pure Either.

A very simple program which opens an in-memory connection and runs a query is as follows:

{-#LANGUAGE OverloadedStrings#-}
import Database.Cozo
import Control.Exception (bracket, throwIO)

main :: IO ()
main = 
  bracket 
    (open "mem" "" "{}" >>= either throwIO pure)
    (fmap (const ()) . close)
    $ \c -> do
      er <- runQuery c "?[] <- [[1,2,3]]" KM.empty
      case er of
        Left e -> throwIO e
        Right (CozoResult badOkay) -> 
          case badOkay of
            Left bad -> print . cozoBadMessage $ bad
            Right okay -> print . namedRowsRows . cozoOkayNamedRows $ okay

This program will output:

[[Number 1.0,Number 2.0,Number 3.0]]