slap

Slap is a set of Elixir libraries that store streams, key-value data, files and Yjs documents in S3-compatible object storage or a local directory, through SlateDB. The services run inside your application rather than as a separate database server. They run on one node or across several, with each service's data split into shards that are spread across the nodes.

Add the slap package to install all seven Slap server libraries at once. It also provides mix slap.server, a standalone HTTP server for evaluating and benchmarking Streams and KV.

See the package overview for a description of each package.

Use Slap in an application

Requires Elixir 1.18 or later and Erlang/OTP 26.2 or later.

Add slap to the dependencies in your application's mix.exs:

defp deps do
  [
    {:slap, "~> 0.5.1"}
  ]
end

Run mix deps.get.

Add the required processes to your application's supervision tree. Each package guide has setup instructions and API examples:

Package Integration
slap_streams Supervise Slap.Streams.Cluster; call Slap.Streams or serve Slap.Streams.HTTP.Router as a Plug.
slap_kv Supervise Slap.KV.Cluster; call Slap.KV or serve Slap.KV.HTTP.Router as a Plug.
slap_files Supervise Slap.KV.Cluster before Slap.Files.
slap_yjs Supervise Slap.Streams.Cluster and Slap.Yjs.Docs.
slap_snapshot_log Supervise Slap.Streams.Cluster before using the log.
slap_cluster Define shard children and supervise your module that uses Slap.Cluster.
slap_slatedb Open a database and use Slap.SlateDB.

These packages do not start an HTTP listener. The Streams and KV HTTP routers are Plugs: mount them in your application's HTTP pipeline, or serve them with a listener you supervise, and put your authentication and authorization in front of them.

Kitchen sink demo

To try all seven libraries without creating an application, download and run the kitchen sink demo:

curl -fsSLo kitchen_sink.exs https://raw.githubusercontent.com/mjrusso/slap/main/slap/examples/kitchen_sink.exs
elixir kitchen_sink.exs

The script installs slap, updates sample data once a second, and prints commands for browsing it with Slap Inspect. Data is held in memory and lost when the demo exits. Press Enter to exit.

The demo guide covers running from a checkout, inspection, and options. For an interactive walkthrough of the Elixir APIs, see the library examples.

Try the standalone server

mix slap.server serves Streams, KV, or both from one HTTP listener. It does not authenticate requests. Use it to evaluate, test and benchmark the services without writing an application:

elixir -e 'Mix.install([:slap]); Mix.Task.run("slap.server", System.argv())' -- \
  --streams --kv --store memory

The server listens on http://127.0.0.1:4437. In another terminal, write and read a KV row:

curl -X PUT --data-binary 'Ada' http://localhost:4437/v1/kv/people/a
curl http://localhost:4437/v1/kv/people/a

The memory store loses its data when the server stops. The standalone server guide covers Streams and KV HTTP examples, S3 and local storage, server options, and supervision in a release.

Slap Inspect

Slap Inspect is a read-only TUI and CLI for browsing data in the standalone server or in your application. Install it separately:

mix escript.install hex slap_inspect

It connects over distributed Erlang using the server's node name and cookie. The inspector guide covers connection and commands. The demo guide explains how to inspect the kitchen sink demo.

Development and testing

Follow the repository's development setup to work from this checkout. The development guide documents the server's test and benchmark tools:

License

Slap is released under the terms of the Apache License 2.0.

Copyright (c) 2026, Michael Russo.