Simple KV Store (sks)

What it does

Simple KV Store is just a minimalist implementation of basic key-value store

Two implementations are provided:

• SimpleKVStore works in memory and is only intended for use within unit tests and examples.
• FileKVStore persists to file system. It is not intended for production usage.

The anticipation is that other implementations will be provided for production, for example a JpaKVStore that is backed by a relational database. To support this the units will be refactored into a suite of common tests that should pass for any event store.

By design this is JUST a key-value, with very limited searching. To efficiently find a record you MUST known the key beforehand.

There payload can in 3 types

• A Kotlin class that corresponds to the rules of Really Simple Serialisation(rss).
• Plain text (CLOB)
• Binary (BLOB)

Adding to a project

Maven jars are deployed using JitPack. See releases for version details.

//add jitpack repo
maven { url "https://jitpack.io" }

// add dependency 
implementation "com.github.mycordaapp:simple-kv-store:<release>"

JitPack build status is at https://jitpack.io/com/github/mycordaapp/simple-kv-store/$releaseTag/build.log

Dependencies

As with everything in myCorda dot App, this library has minimal dependencies.

• Kotlin 1.4
• Java 11
• The object Registry
• The Really Simple Serialisation(rss) module
  • Jackson for JSON serialisation

Next Steps

• Using the kv store.