# Package overview

<!-- slap-preamble -->
Slap provides Elixir bindings for [SlateDB](https://slatedb.io) (an embedded
key-value engine optimized for storing data in object storage), as well as
services built on top of these bindings. The services run inside your
application, on one node or several.

Services:

- [slap_streams](https://hexdocs.pm/slap_streams/): a [Durable
  Streams](https://durablestreams.com) server, with HTTP, long polling, and
  SSE
- [slap_kv](https://hexdocs.pm/slap_kv/): partitioned key-value storage with
  conditional writes, ordered scans, and an HTTP API
- [slap_files](https://hexdocs.pm/slap_files/): file storage with metadata
  and conditional replacement; small files are kept in `slap_kv`
  records, which saves object-store PUTs
- [slap_yjs](https://hexdocs.pm/slap_yjs/): [Yjs](https://yjs.dev) documents
  for collaborative editing, with replication and presence across nodes

Building blocks:

- [slap_slatedb](https://hexdocs.pm/slap_slatedb/): the SlateDB bindings
- [slap_cluster](https://hexdocs.pm/slap_cluster/): SlateDB databases run as
  shards across nodes, with placement, routing, and failover
- [slap_snapshot_log](https://hexdocs.pm/slap_snapshot_log/): an append-only
  log of changes that can be condensed into snapshots

All-in-one:

- [slap](https://hexdocs.pm/slap/): all Slap server libraries, and `Slap`,
  which starts the services you select under one supervisor

Inspection:

- [slap_inspect](https://hexdocs.pm/slap_inspect/): a read-only TUI and CLI
  for browsing Slap data; installed separately

The `slap` package pulls in all seven server libraries. If you only need a
subset, add those packages directly.
<!-- /slap-preamble -->
