crux-xodus

Crux Currently supports LMDB and RocksDB, but we wanted a pure Java solution so we created a Xodus-backed KV store.

Usage

If you want to quickly try it out you should follow the Official Crux installation.

Add a dependency

Make sure to first add this module as a dependency:

Configure Crux

And after that you can change the KV backend to the Xodus one:

EDN

{:crux/index-store {:kv-store {:crux/module 'avisi.crux.xodus/->kv-store
                               :db-dir (io/file "/tmp/xodus")}}
 :crux/document-store {...}
 :crux/tx-log {...}}

JSON

{
  "crux/index-store": {
    "kv-store": {
      "crux/module": "avisi.crux.xodus/->kv-store",
      "db-dir": "/tmp/xodus"
    }
  },

  "crux/document-store": { ... },
  "crux/tx-log": { ... }
}

For more information about configuring Crux see: https://opencrux.com/reference/configuration.html

Developer

Releasing

First make sure the pom is up-to-date run

$ clojure -Spom

Edit the pom to have the wanted version and commit these changes. Create a tag for the version for example:

$ git tag <your-version>
$ git publish origin <your-version>

Make sure you have everything setup to release to clojars by checking these instructions. After this is al done you can release by running:

$ mvn deploy