Classes

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

Having represents a HAVING clause of the query statement used for filtering the aggregated values from the the GROUP BY clause.

A GroupBy represents a query GROUP BY statement to group the query result. The GROUP BY statement is normally used with aggregate functions (AVG, COUNT, MAX, MIN, SUM) to aggregate the group of the values.

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 Parameters object used for setting values to the query parameters defined in the query.

Fragment provides read and write access to data value. Fragment also provides subscript access by either key or index to the nested values which are wrapped by Fragment objects.

A row of data generated by a Query.

A single result from a full-text Query.

Function represents a function expression.

An Ordering represents a single ordering component in the query ORDER BY clause.

SortOrder allows to specify the ordering direction which is an ascending or a descending order

A replicator for replicating document changes between a local database and a target database. The replicator can be bidirectional or either push or pull. The replicator can also be one-short or continuous. The replicator runs asynchronously, so observe the status property to be notified of progress.

A property expression.

DocumentFragment provides access to a document object. DocumentFragment also provides subscript access by either key or index to the data values of the document which are wrapped by Fragment objects. */

A Join component representing a single join clause in the query statement.

On component used for specifying join conditions.

ReadOnlyFragment provides readonly access to data value. ReadOnlyFragment also provides subscript access by either key or index to the nested values which are wrapped by ReadOnlyFragment objects.

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

A Joins component represents a collection of the joins clauses of the query statement.

DictionaryObject provides access to dictionary data.

ReadOnlyDictionaryObject provides readonly access to dictionary data.

A LiveQuery automatically observes database changes and re-run the query that the LiveQuery object is created from. If there is a new query result or an error occurred, the LiveQuery object will report the changed result via the added listener blocks.

ReadOnlyArrayObject provides readonly access to array data.

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

Undocumented

A Couchbase Lite document.

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 an ORDER BY clause of the query statement.

A meta property expression.

ArrayObject provides access to array data.

Readonly version of the Document.

SelectResult represents a signle return value of the query statement.

Meta is a factory class for creating the expressions that refer to the metadata properties of the document.