# slap_slatedb v0.2.0 - Table of Contents

> Elixir bindings for SlateDB, a key-value store built on object storage.

## Pages

- [slap_slatedb](readme.md)
- [Changelog](changelog.md)
- [LICENSE](license.md)

## Modules

- Database
  - [Slap.SlateDB](Slap.SlateDB.md): Elixir bindings for [SlateDB](https://slatedb.io), an embedded key-value
store that keeps its data in object storage.
  - [Slap.SlateDB.Iterator](Slap.SlateDB.Iterator.md): A low-level iterator over a key range.
  - [Slap.SlateDB.Reader](Slap.SlateDB.Reader.md): Read-only access to a database, alongside its writer.
  - [Slap.SlateDB.Snapshot](Slap.SlateDB.Snapshot.md): A consistent, read-only view of the database at the time it was taken.
  - [Slap.SlateDB.Transaction](Slap.SlateDB.Transaction.md): A read-write transaction.

- Storage
  - [Slap.SlateDB.Admin](Slap.SlateDB.Admin.md): Checkpoints, clones, garbage collection and other work on a database's
files, without opening the database.
  - [Slap.SlateDB.Cache](Slap.SlateDB.Cache.md): An in-memory block and metadata cache that several databases can share.
  - [Slap.SlateDB.CompactionFilter](Slap.SlateDB.CompactionFilter.md): Deletes every key under a set of prefixes, as the database is compacted.
  - [Slap.SlateDB.MergeOperator](Slap.SlateDB.MergeOperator.md): The built-in merge operators, and helpers for their operand formats.
  - [Slap.SlateDB.ObjectStore](Slap.SlateDB.ObjectStore.md): Plain objects in the store a database lives in: small objects with
conditional writes (`get/3`, `put/4`), such as leases (see
`Slap.Cluster.Strategy.ObjectLease`), and large ones streamed in and out
(`upload/4`, `download/3`), such as file bodies. Every call takes the
`:timeout` option (see `Slap.SlateDB`); for a stream it bounds each step.

- Support
  - [Slap.SlateDB.Error](Slap.SlateDB.Error.md): An error returned by SlateDB.
  - [Slap.SlateDB.Subscription](Slap.SlateDB.Subscription.md): A subscription from `Slap.SlateDB.subscribe/3`. Its `:ref` is the
reference in every message the subscription sends; match on it to tell
subscriptions apart
  - [Slap.SlateDB.Telemetry](Slap.SlateDB.Telemetry.md): Emits `:telemetry` events for one database. Start it after `Slap.SlateDB.open/2`,
usually under the supervisor that owns the database