Reference

The complete contracts. These pages are precise rather than instructive; the pages before them teach, and these are what you check a detail against.

Page What it holds
Data contract Every dataset and column the importer accepts. Generated from the code
Interface contract Every CLI command, CSV format, web route and API endpoint
Data model The logical model, the lens mechanism, and worked SQL queries
Design decisions Why it is shaped this way, and what was rejected

The running system is more authoritative than any of them

Two contracts are generated from the code and cannot drift:

crane import spec --json           # every dataset, column, accepted value and rule
curl http://host:8000/api/openapi.json   # the full HTTP API schema

Where a page here disagrees with either of those, the running system is right and the page is a bug worth reporting.


Table of contents


Back to top

CRAne. The database is one SQLite file and it is yours.

This site uses Just the Docs, a documentation theme for Jekyll.