Classes

CBLArray provides access to array data.

Authenticator objects provide server authentication credentials to the replicator. CBLAuthenticator is an abstract superclass; you must instantiate one of its subclasses. CBLAuthenticator is not meant to be subclassed by applications.

The CBLBasicAuthenticator class is an authenticator that will authenticate using HTTP Basic auth with the given username and password. This should only be used over an SSL/TLS connection, as otherwise it’s very easy for anyone sniffing network traffic to read the password.

A CBLBlob appears as a property of a CBLDocument; it contains arbitrary binary data, tagged with a MIME type. Blobs can be arbitrarily large, and their data is loaded only on demand (when the content or contentStream properties are accessed), not when the document is loaded. The document’s raw JSON form only contains the CBLBlob’s metadata (type, length and a digest of the data) in a small object. The data itself is stored externally to the document, keyed by the digest.

An authenticator that presents a client certificate to the server during the initial SSL/TLS handshake. This requires access to both the X.509 certificate and the matching private key. Apple’s security APIs refer to such a (certificate, key) pair as an identity, typed as a SecIdentityRef.

CBLConflict provides details about a conflict.

Configuration for opening a database.

A Couchbase Lite database.

Database Change information

CBLDictionary provides access to dictionary data.

A Couchbase Lite document.

Document change information

CBLDocumentFragment provides access to a document object. CBLDocumentFragment also provides subscript access by either key or index to the data values of the document which are wrapped by CBLFragment objects.

The encryption key, a raw AES-256 key data which has exactly 32 bytes in length or a password string. If the password string is given, it will be internally converted to a raw AES key using 64,000 rounds of PBKDF2 hashing.

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

CBLIndex represents an index which could be a value index for regular queries or full-text search (FTS) index for full-text queries (using the match operator).

Value Index Item.

FTS Index Item.

Options for creating full-text search indexes. All properties are set to false or nil by default.

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

CBLLiveQueryChange contains the information about the query result changes reported by a live query object.

A compiled database query. You create a query by calling the CBLDatabase method createQueryWhere:. The query can be further configured by setting properties before running it. Some properties alter the behavior of the query enough to trigger recompilation; it’s usually best to set these only once and then reuse the CBLQuery object. You can use NSPredicate / NSExpression variables to parameterize the query, making it flexible without needing recompilation. Then you just set the parameters property before running it.

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

CBLQueryCollation defines how strings are compared and is used when creating a COLLATE expression. The COLLATE expression can be used in the WHERE clause when comparing two strings or in the ORDER BY clause when specifying how the order of the query results. CouchbaseLite provides two types of the Collation, ASCII and Unicode. Without specifying the COLLATE expression Couchbase Lite will use the ASCII with case sensitive collation by default.

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

A CBLQueryExpression represents an expression used for constructing a query statement.

CBLQueryFunction represents a function expression.

A CBLQueryJoin represents the JOIN clause in the query statement.

A CBLQueryLimit represents a query LIMIT clause used for constrainting the number of results returned by a query.

CBLQueryMeta is a factory class for creating the expressions that refers to the metadata properties of the document.

A CBLQueryOrdering represents a single ordering component in the query ORDER BY clause.

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

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

CBLQueryResult 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 CBLQuerySelectResult objects given when constructing the CBLQuery object.

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

• The alias name of the CBLQuerySelectResult object.
• The last component of the keypath or property name of the property expression used when creating the CBLQuerySelectResult object.
• The provision key in $1, $2, …$N format for the CBLQuerySelectResult 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.

CBLQueryResultSet is a result returned from a query. The CBLQueryResultSet is an NSEnumerator of the CBLQueryResult objects, each of which represent a single row in the query result.

A single result from a CBLQuery. The NSEnumeration returned by -[CBLQuery run:] produces these.

A single result from a full-text CBLQuery.

A CBLQuerySelectResult represents a returning value in each query result row.

CBLReadOnlyArray provides readonly access to array data.

CBLReadOnlyDictionary provides readonly access to dictionary data.

Readonly version of the CBLDocument.

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

Combined activity level and progress of a replicator.

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.

Replicator status change details.

Replicator configuration.

The CBLSessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway.