Package-level declarations
Types
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.
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.
ConcurrencyControl type used when saving or deleting a document.
Custom conflict resolution strategies implement this interface.
A class that sends log messages to the system log, available via 'logcat' on Android.
CouchbaseLite Utility
CouchbaseLite Utility
A CouchbaseLiteException gets raised whenever a Couchbase Lite faces errors.
A Couchbase Lite database.
Provides details about a Database change.
The listener interface for receiving Database change events.
The listener interface for receiving Database change events, called within a coroutine.
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.
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.
Document replicated update of a replicator.
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 logger for writing to a file in the application's storage so that log messages can persist durably after the application has stopped or encountered a problem. Each log level is written to a separate file. Threading policy: This class is certain to be used from multiple threads. As long as it is thread safe, the various race conditions are unlikely and the penalties very small. "Volatile" ensures the thread safety and the several races are tolerable.
A From represents a FROM clause for specifying the data source of the query.
Full-text function.
Index for Full-Text search
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 which could be a value index for regular queries or full-text index for full-text queries (using the match operator).
IndexBuilder used for building database index objects. Use Database.createIndex(IndexConfiguration, String)
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.
The listener token interface
Gets the log controller for Couchbase Lite, which stores the three available logging methods: console (logcat), file, and custom.
A class that describes the file configuration for the FileLogger class. These options must be set atomically, so they won't take effect unless a new configuration object is set on the logger. Attempting to modify an in-use configuration object will result in an exception being thrown.
A meta property expression.
MutableArray provides access to array data.
Dictionary provides access to 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
QueryChange contains the information about the query result changes reported by a query object.
The listener interface for receiving Live Query change events.
The listener interface for receiving Live Query change events, called within a coroutine.
Interface delegate that takes Document input parameter and bool output parameter Document push and pull will be allowed if output is true, otherwise, Document push and pull will not be allowed.
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.
Combined activity level and progress of a replicator.
The replication direction
A result set representing the query result. The result set is an iterator of the Result objects.
Select represents the SELECT clause of the query for specifying the returning properties in each query result row.
SelectResult represents a single return value of the query statement.
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
Value (standard query) index
Value Index Item
Variable expression
A Where represents the WHERE clause of the query for filtering the query result.
Properties
The numerical error code for this error.
Configuration factory for new DatabaseConfigurations
The default conflict resolver used by the replicator.
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.
Configuration factory for new FullTextIndexConfigurations
Configuration factory for new LogFileConfigurations
Configuration factory for new ReplicatorConfigurations
Configuration factory for new ValueIndexConfigurations
Functions
A Flow of database changes.
A Flow of document changes.
A Flow of document replications.
Subscript access to a Fragment object by index.
Gets document fragment object by the given document ID.
Subscript access to a Fragment object by key.
Subscripting access to a MutableFragment object that represents the value at the given index.
Subscripting access to a MutableFragment object that represents the value of the dictionary by key.
Subscripting access to a MutableFragment object that represents the value of the document by key.
Subscript access to a Fragment object of the projecting result value at the given index.
Subscript access to a Fragment object of the projecting result value for the given key.
Create a DatabaseConfiguration, overriding the receiver's values with the passed parameters:
Create a ValueIndexConfiguration, overriding the receiver's values with the passed parameters:
Create a FullTextIndexConfiguration, overriding the receiver's values with the passed parameters:
Create a LogFileConfiguration, overriding the receiver's values with the passed parameters:
Create a ReplicatorConfiguration, overriding the receiver's values with the passed parameters:
A Flow of query changes.
A Flow of replicator state changes.