@hackage traildb0.1.4.1

TrailDB bindings for Haskell

  • Installation

  • Dependencies (12)

  • Dependents (1)

    @hackage/acme-everything

    • Package Flags

      use-ioref
       (off by default)

      Use IORef instead of MVar as the container for Tdb. Can improve performance (very slightly) but you lose thread safety.

      build-wikipedia-benchmark
       (off by default)

      Build the wikipedia scanning executable from https:/github.comjoeyrobert/traildb-benchmark This program requires you to download the wikipedia TrailDB manually; check out the linked git repository for where to get it.

Hackage Travis CI

TrailDB Haskell bindings

TrailDB logo

These are the official Haskell bindings to TrailDB. Most of the API is covered (with the notable exception of filters). Check out System.TrailDB module for some examples and documentation.

How to build

These bindings can be installed using cabal-install or stack on Linux. At least GHC 7.8 is required.

Fetch the code in some way. You can clone [https://github.com/traildb/traildb-haskell]. Then follow these instructions.

You need at least traildb and Judy libraries installed to compile and use these bindings. Judy is a dependency of TrailDB itself so if you have TrailDB the C library installed properly, then most likely you don't need to do anything else regarding dependencies.

cabal-install

Cabal is usually in the package repositories of your distribution.

$ apt-get install cabal-install      # Debian/Mint/Ubuntu
$ dnf install ghc cabal-install      # Fedora 22
$ pacman -S ghc cabal-install        # Arch Linux
$ pkg install hs-cabal-install       # FreeBSD

$ cabal install                      # Run this in the root of traildb-haskell

# Test it out!

$ cd examples
$ ghc tutorial_simple_traildb.hs -o tutorial
$ ./tutorial

After this, bindings should be usable in other Haskell projects by requiring traildb.

stack

Stack is a new fancy Haskell build tool. Because it's new and fancy, it doesn't quite have the same level of presence in Linux package repositories than cabal-install.

You can manually download stack from [http://www.haskellstack.org/] if it's not in your repositories.

# Once you have `stack` in your PATH:

$ stack setup      # May be optional if you have GHC already installed and it can be used
$ stack install

# Test it out!

$ cd examples
$ stack ghc -- tutorial_simple_traildb.hs -o tutorial
$ ./tutorial

License

These bindings are licensed under the MIT license.

How to contribute or report bugs

Use our GitHub page to report issues or to open pull requests.

Example program

Check out examples/tutorial_simple_traildb.hs in this repository.