Package-level declarations
Types
Array provides readonly access to array data.
Array expression
The In class represents the IN clause object in a quantified operator (ANY/ANY AND EVERY/EVERY
The Satisfies class represents the SATISFIES clause object in a quantified operator (ANY/ANY AND EVERY/EVERY
Function provides array functions.
Configuration for indexing property values within nested arrays in documents, intended for use with the UNNEST query.
ArrayInterface defines a set of methods for readonly accessing array data.
Authenticator objects provide server authentication credentials to the replicator. Authenticator is a base sealed class; you must instantiate one of its implementations.
The BasicAuthenticator 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 Couchbase Lite Blob. A Blob appears as a property of a Document and contains arbitrary binary data, tagged with MIME type. Blobs can be arbitrarily large, although some operations may require that the entire content be loaded into memory. The containing document's JSON contains only the Blob's metadata (type, length and digest). The data itself is stored in a file whose name is the content digest (like git).
Collation 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 Collection is a container for documents similar to a table in a relational database. Collections are grouped into namespaces called scopes and have a unique name within that scope.
Provides details about a Collection change.
The listener interface for receiving Collection change events.
The listener interface for receiving Collection change events, called within a coroutine.
The collection configuration that can be configured specifically for the replication.
ConcurrencyControl type used when saving or deleting a document.
The representation of conflicting changes in the remote and local instances of a document.
Custom conflict resolution strategies implement this interface.
CouchbaseLite Utility
CouchbaseLite Utility
Misfortune: The little fox gets its tail wet.
A Couchbase Lite database.
Configuration for opening a database.
A query data source, used for specifying the source of data for a query.
Dictionary provides readonly access to dictionary data.
DictionaryInterface defines a set of methods for readonly accessing dictionary data.
Readonly version of the Document.
Provides details about a Document change.
The listener interface for receiving Document change events.
The listener interface for receiving Document change events, called within a coroutine.
The flags enum describing the replicated document.
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.
The representation of the replication of a document.
The listener interface for receiving Document replicated events.
The listener interface for receiving Document replicated events, called within a coroutine.
Replication target endpoint
The expression used in constructing a query.
A From represents a FROM clause for specifying the data source of the query.
Full-text functions.
Index for Full-Text search
Configuration for creating full-text indexes.
Full-text Index Item.
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.
Having represents a HAVING clause of the query statement used for filtering the aggregated values from the GROUP BY clause.
Index represents an index: either a value index for regular queries or full-text index for full-text queries (using the match operator).
IndexBuilder used for building database indices.
A Join component representing a single JOIN clause in the query statement.
A Joins component represents a collection of the joins clauses of the query statement.
Base class for a removable subscription to an observable.
A meta property expression.
Mutable access to array data.
MutableArrayInterface defines a set of methods for getting and setting array data.
Mutable access to dictionary data.
MutableDictionaryInterface defines a set of methods for getting and setting dictionary data.
A Couchbase Lite Document. A document has key/value properties like a Map.
MutableFragment provides read and write access to data value. MutableFragment also provides subscript access by either key or index to the nested values which are wrapped by MutableFragment objects.
An OrderBy represents an ORDER BY clause of the query for specifying properties or expressions that the result rows should be sorted by.
An Ordering represents a single ordering component in the query ORDER BY clause.
A Parameters object used for setting values to the query parameters defined in the query.
Property expression
A database query built using the fluent interface in QueryBuilder.
Information about changes in a query result changes, reported by a live query.
The listener interface for receiving Live Query change events.
The listener interface for receiving Live Query change events, called within a coroutine.
QueryIndex object represents an existing index in the collection.
Information about a Document updated by replication.
Delegate that takes Document input parameter and bool output parameter Document push and pull will be allowed if the predicate returns true. Document will be not be replicated, push or pull, otherwise.
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-shot or continuous. The replicator runs asynchronously, so observe the status to be notified of progress.
Activity level of a replicator.
ReplicatorChange contains the replicator status information.
The listener interface for receiving Replicator change events.
The listener interface for receiving Replicator change events, called within a coroutine.
Configuration for a Replicator
Progress of a replicator. If total is zero, the progress is indeterminate; otherwise, dividing the two will produce a fraction that can be used to draw a progress bar. The quotient is highly volatile and may be slightly inaccurate by the time it is returned.
The activity level and progress of a replicator.
The replication direction
Result represents a row of result set returned by a Query.
The representation of a query result. The result set is an iterator over Result objects.
A Scope represents a scope or namespace of collections.
Select represents the SELECT clause of the query for specifying the properties in each query result row.
SelectResult represents the result of a query.
SessionAuthenticator class is an authenticator that will authenticate by using the session ID of the session created by a Sync Gateway
URL based replication target endpoint
A Standard query index.
Configuration for a standard database index.
Value Index Item
Variable expression
A Where represents the WHERE clause of the query for filtering the query result.
Properties
Allows the replicator to continue replicating in the background on iOS. The default value is false, which means that the replicator will suspend itself when the replicator detects that the application is running in the background.
The numerical error code for this error.
The default conflict resolution strategy. Deletion always wins. A newer doc always beats an older one. Otherwise, one of the two document is chosen randomly but deterministically.
This is a long time: just under 25 days. This many seconds, however, is just less than Integer.MAX_INT millis and will fit in the heartbeat property.
The domain code for this error.
The remote target’s SSL certificate.
The remote target's SSL certificate.
Functions
A Flow of Collection changes.
A Flow of document changes
A Flow of document replications.
Subscript access to a Fragment object of the projecting result value at the given index.
Gets document fragment object by the given document ID.
Subscript access to a Fragment object of the projecting result value for the given key.
Subscript access to a MutableFragment object of the projecting result value at the given index.
Subscripting access to a MutableFragment object that represents the value of the dictionary by key.
Subscript access to a MutableFragment object of the projecting result value for the given key.
A Flow of query changes.
A Flow of replicator state changes.
Allows the replicator to continue replicating in the background on iOS. The default value is false, which means that the replicator will suspend itself when the replicator detects that the application is running in the background.
Sets the certificate used to authenticate the target server. A server will be authenticated if it presents a chain of certificates (possibly of length 1) in which any one of the certificates matches the one passed here. The default is no pinned certificate.
Sets the certificate used to authenticate the target server. A server will be authenticated if it presents a chain of certificates (possibly of length 1) in which any one of the certificates matches the one passed here. The default is no pinned certificate.