# sapedb — planning

> The public planning record for sapedb, a storage engine whose only interface is a named, declared
> operation. There is no query language and no query text ever reaches the engine. Every call was
> written down first: which collection it touches, which index it walks, how far, what it returns, and
> who may run it. The consequence this project plans around is that cost is declared rather than
> discovered — a scan states its limit and so does a count, so the ceiling is readable before anything
> runs.

This site is the planning record, not the documentation and not the marketing site. It holds the
versions, what each one freezes, and every ticket and issue in each.

Three conventions govern what is written here, and they are worth knowing before reading anything else:

- **Done is a measurement, not a judgement.** Every ticket carries an acceptance criterion somebody runs
  and watches pass or fail.
- **Issues found during the work are triaged once**, against a single question: does it lose data, break
  a promise on a public surface, or stop somebody installing and running the thing? A no means it waits
  for the next version, however true or embarrassing it is.
- **Nothing is sold on speed.** Where a number exists it is published with the layer it was measured at,
  including the unflattering ones. Composing operations was measured to buy 0 ms on the write path,
  because what a write costs is the fsync.

There are no dates anywhere on this site. Nobody has fixed one. What is fixed is the order and what
blocks what.

## Planning

- [Versions](https://planning.sapedb.com/index.html): what sapedb is, the version list, and how this
  planning works.
- [1.0.0](https://planning.sapedb.com/v1.0.0.html): the release scope and the issues the work turned up,
  as two backlogs. 1.0.0 freezes four surfaces — the on-disk format, the wire protocol, the meaning of a
  declaration, and the public API — and explicitly does not promise performance, the ordering of reads
  against writes, the file layout inside a partition, or anything under `internal/`.

## The product

- [sapedb.com](https://sapedb.com): what it is and what it is not.
- [learn.sapedb.com](https://learn.sapedb.com): the guides. Every code sample there was run against a
  real daemon before it was published.

## Source

- [github.com/sapedb/sapedb](https://github.com/sapedb/sapedb): the server, the command line and the
  operator shell, in Go. MIT licensed.
- [github.com/material-atomic/ecosy-sapedb](https://github.com/material-atomic/ecosy-sapedb): the
  TypeScript client, published as `@ecosy/sapedb`. It also ships the conformance fixtures, which are the
  wire specification an implementation in any language can check itself against.

## Optional

- [llms-full.txt](https://planning.sapedb.com/llms-full.txt): the same record with the full ticket and
  issue listing, for a reader that wants the detail without following every link.