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 the GROUP BY clause to group the query result. The GROUP BY clause 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 an alias name.

A Parameters object used for setting values to the query parameters defined in the query.

The Satisfies class represents the SATISFIES clause object in a quantified operator (ANY/ANY AND EVERY/EVERY IN SATISFIES ). The SATISFIES clause is used for specifying an expression that will be used to evaluate each item in the array.

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 ascending or descending order. The default ordering is the ascending 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.

Result represents a single row in the query result. The projecting result value can be accessed either by using a zero based index or by a key corresponding to the SelectResult objects given when constructing the Query object.

A key used for accessing the projecting result value could be one of the followings:

• The alias name of the SelectResult object.
• The last component of the keypath or property name of the property expression used when creating the SelectResult object.
• The provision key in $1, $2, …$N format for the SelectResult that doesn’t have an alias name specified or is not a property expression such as an aggregate function expression (e.g. count(), avg(), min(), max(), sum() and etc). The number suffix after the ‘$’ character is a running number starting from one.

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

On component used for specifying join conditions.

The In class represents the IN clause object in a quantified operator (ANY/ANY AND EVERY/EVERY IN SATISFIES ). The IN clause is used for specifying an array object or an expression evaluated as an array object, each item of which will be evaluated against the satisfies expression.

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.

ResultSet is a result returned from a query.

A Limit component represents the LIMIT clause 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.

Where class represents the WHERE clause of the query statement.

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.