# slap_files v0.3.0 - Table of Contents

> Files on Slap.KV and an object store: bodies inline or as objects.

## Pages

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

## Modules

- Files
  - [Slap.Files](Slap.Files.md): Files stored with `Slap.KV` and an object store. A file lives at a ref,
`{partition, id}`: a partition is a stable group of files (a document's,
for example), listed together, and on one `Slap.KV` shard. Each file has
one record in `Slap.KV`, which exists exactly while the file does, and a
body stored in the record (inline) or as an object.
  - [Slap.Files.File](Slap.Files.File.md): A file's metadata, as `Slap.Files.get/1` and `Slap.Files.list/2` return
it. `version` changes with every write of the file. `storage` is
`:inline` (in the file's record) or `:object`.

- Maintenance
  - [Slap.Files.Sweeper](Slap.Files.Sweeper.md): Deletes objects that are no longer a file's body, from the intents that
name them (every `sweep_interval_ms`, default 10 s). Each node sweeps
the intent partitions whose `Slap.KV` shard it owns.