Home

Generally Useful Pages

Build And Deploy On Linux -- More Linux instructions (beyond what's in the README.)
JSON Query Schema -- LiteCore's query syntax
REST API -- If you enable this unsupported listener, here's its API
The cblite Tool -- Super useful command-line tool for inspecting databases
TLS and Crypto Terminology -- a glossary
Backpressure and the replicator

Debugging Replicators Stuck In Busy -- some tips for using logging to investigate a pesky source of bugs
Legacy Attachment Handling -- backwards compatibility with the old _attachments when replicating with Sync Gateway
Replication Protocol -- Specification of the WebSocket-based protocol

Intro To LiteCore -- start here if you're new
C API Documentation -- Doxygen-generated documentation of the C API called by Couchbase Lite
C++ API Overview -- there's a shiny new C++ API equivalent to the C one, if you swing that way
API Changelog -- Chronological list of LiteCore C API changes
🆕 Reference Counting -- How to use ref-counted types in C and C++
Using Fleece and Advanced Fleece -- the JSON-like storage format and API used for documents
Shared Keys In Fleece -- describes an often-confusing optimization of Fleece
Slices -- a core data structure used by LiteCore and Fleece
Proxy Servers -- LiteCore doesn't deal with them, but someone has to...

Class Overview and Replicator Class Overview -- A tour of the implementation's internal C++ classes
Database Schema -- What's in the SQLite database
Revision Trees -- Deep innards of how documents are stored
Query Engine -- How we implemented N1QL-like queries
Replicator Overview -- A tour of the replicator implementation
Replication Lifecycle -- The state machine the replicator goes through
Actor School -- The Actor concurrency library the replicator classes use
BLIP -- The network protocol underlying the replicator
Logging Goals - A document describing why and at what times we should be logging things