Reference

  • Configuration: storage options, environment variables, and client and committer settings.

  • Command-line interface: cairndb snapshot | gc | rebuild.

  • API reference, generated from the source docstrings:

    • Engine: CairnDB and every layer (Objects, ClaimResult, Lease, Document, Log, Transaction, Projection).

    • Events and types: Event, SequencedEvent, Commit, SequenceNumber, Timestamp.

    • Writer: Committer, CommitterConfig, RevalidateHook.

    • Storage: StorageConfig and the backends.

    • Client: CairnDBClient, ClientConfig, HandlerRegistry, and the replay internals.

    • Jobs: SnapshotBuilder, collect_garbage.

    • Exceptions.

  • Glossary.

Everything most applications need is importable from the top-level package:

from cairndb import (
    CairnDB,                                        # the engine
    Event, EventType, SchemaVersion, Timestamp,     # writing events
    SequenceNumber, SequencedEvent, Commit,         # reading them
    LeaseLost, TransactionConflict,                 # expected exceptions
)