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

Useful For QE And Support

• 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

For Couchbase Lite Implementors

• C API Documentation -- Doxygen-generated documentation of the C API called by Couchbase Lite
• API Changelog -- Chronological list of LiteCore C API changes
• Using Fleece -- the JSON-like storage format and API used for documents
• Proxy Servers -- LiteCore doesn't deal with them, but someone has to...

Internal Design Documents

• 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
• 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