Classes

A compiled database query, similar to a N1QL or SQL query.

A Couchbase Lite database.

A query data source. used for specifiying the data source for your query. The current data source supported is the database.

A database data source. You could also create an alias data source by calling the as(alias) method with a given alias name.

A row of data generated by a Query.

A single result from a full-text Query.

A replication between a local and a remote database. Before starting the replication, you just set either the push or pull property, or both. The replication runs asynchronously, so set a delegate or observe the status property to be notified of progress.

Properties defines a JSON-compatible object, much like a Dictionory but with type-safe accessors. It is implemented by classes Document and Subdocument.

A database query. A Query instance can be constructed by calling one of the select class methods.

An Expression represents an expression used for constructing a query statement.

Undocumented

A Couchbase Lite document. A document has key/value properties like a Dictionary; their API is defined by the superclass Properties. To learn how to work with properties, see that class’s documentation.

A From component representing a FROM clause for specifying the data source of the query.

A Select component represents the returning properties in each query result row.

An OrderBy represents a query ORDER BY clause by sepecifying properties or expressions t hat the result rows should be sorted by. A CBLQueryOrderBy can be construct as a single CBLQuerySortOrder instance with a propery name or an expression instance or as a chain of multiple CBLQueryOrderBy instances.

Undocumented

Subdocument is a nested document with its own set of named properties. In JSON terms it’s a nested JSON Map object. Like Document, Subdocument is mutable, so you can make changes in-place. The difference is that a Subdocument doesn’t have its own ID. It’s not a first-class entity in the database, it’s just a nested object within the document’s JSON. It can’t be saved individually; changes are persisted when you save its document.