Classes

The following classes are available globally.

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

    See more

    Declaration

    Swift

    public class PredicateQuery

  • A Couchbase Lite database.

    See more

    Declaration

    Swift

    public final class Database

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

    See more

    Declaration

    Swift

    public class DataSource

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

    See more

    Declaration

    Swift

    public class DatabaseSource: DataSource

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

    See more

    Declaration

    Swift

    public class Fragment: ReadOnlyFragment, DictionaryFragment, ArrayFragment

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

    See more

    Declaration

    Swift

    public final class Replicator

  • 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. */

    See more

    Declaration

    Swift

    public class DocumentFragment: DictionaryFragment

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

    See more

    Declaration

    Swift

    public class ReadOnlyFragment: ReadOnlyFragmentProtocol,
                               ReadOnlyArrayFragment, ReadOnlyDictionaryFragment

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

    See more

    Declaration

    Swift

    public class Query

  • ReadOnlyDictionaryObject provides readonly access to dictionary data.

    See more

    Declaration

    Swift

    public class ReadOnlyDictionaryObject: ReadOnlyDictionaryProtocol

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

    See more

    Declaration

    Swift

    public class LiveQuery

  • ReadOnlyArrayObject provides readonly access to array data.

    See more

    Declaration

    Swift

    public class ReadOnlyArrayObject: ReadOnlyArrayProtocol

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

    See more

    Declaration

    Swift

    public final class Expression

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

    See more

    Declaration

    Swift

    public final class From: Query, WhereRouter, OrderByRouter

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

    See more

    Declaration

    Swift

    public final class Select: Query, FromRouter

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

    See more

    Declaration

    Swift

    public class OrderBy: Query

  • Undocumented

    See more