Package-level declarations

Types

Link copied to clipboard
expect open class Array : Iterable<Any?>

Array provides readonly access to array data.

actual open class Array : DelegatedClass<<Error class: unknown class>> , Iterable<Any?>
actual open class Array : Iterable<Any?>
Link copied to clipboard
expect object ArrayExpression

Array expression

actual object ArrayExpression
actual object ArrayExpression
Link copied to clipboard
expect class ArrayExpressionIn

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.

actual class ArrayExpressionIn : DelegatedClass<<Error class: unknown class>>
actual class ArrayExpressionIn
Link copied to clipboard

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.

actual class ArrayExpressionSatisfies : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard
expect object ArrayFunction

Function provides array functions.

actual object ArrayFunction
actual object ArrayFunction
Link copied to clipboard
expect sealed class Authenticator

Authenticator objects provide server authentication credentials to the replicator. Authenticator is a base sealed class; you must instantiate one of its implementations.

actual sealed class Authenticator : DelegatedClass<<Error class: unknown class>>
actual sealed class Authenticator
Link copied to clipboard
expect class BasicAuthenticator(username: String, password: CharArray) : Authenticator

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.

actual class BasicAuthenticator(username: String, password: CharArray) : Authenticator
actual class BasicAuthenticator(val username: String, password: CharArray) : Authenticator
Link copied to clipboard
expect class Blob(contentType: String, content: ByteArray)

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

actual class Blob(contentType: String, content: ByteArray) : DelegatedClass<<Error class: unknown class>>
actual class Blob(contentType: String, content: ByteArray)
Link copied to clipboard
object CBLError
Link copied to clipboard
typealias ChangeListener<T> = (change: T) -> Unit
Link copied to clipboard
typealias ChangeSuspendListener<T> = suspend (change: T) -> Unit
Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard
expect sealed class Collation

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.

actual sealed class Collation : DelegatedClass<<Error class: unknown class>>
actual sealed class Collation
Link copied to clipboard
expect class Collection : AutoCloseable

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.

actual class Collection : DelegatedClass<<Error class: unknown class>> , AutoCloseable
actual class Collection : AutoCloseable
Link copied to clipboard
expect class CollectionChange

Provides details about a Collection change.

actual class CollectionChange : DelegatedClass<<Error class: unknown class>>
actual class CollectionChange
Link copied to clipboard

The listener interface for receiving Collection change events.

Link copied to clipboard

The listener interface for receiving Collection change events, called within a coroutine.

Link copied to clipboard
expect class CollectionConfiguration(channels: List<String>? = null, documentIDs: List<String>? = null, pullFilter: ReplicationFilter? = null, pushFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null)

The collection configuration that can be configured specifically for the replication.

actual class CollectionConfiguration : DelegatedClass<<Error class: unknown class>>
actual class CollectionConfiguration(var channels: List<String>?, var documentIDs: List<String>?, var pullFilter: ReplicationFilter?, var pushFilter: ReplicationFilter?, var conflictResolver: ConflictResolver?)
Link copied to clipboard

ConcurrencyControl type used when saving or deleting a document.

actual typealias ConcurrencyControl = <Error class: unknown class>
Link copied to clipboard
expect class Conflict

The representation of conflicting changes in the remote and local instances of a document.

actual class Conflict : DelegatedClass<<Error class: unknown class>>
actual class Conflict
Link copied to clipboard
typealias ConflictHandler = (document: MutableDocument, oldDocument: Document?) -> Boolean
Link copied to clipboard
typealias ConflictResolver = (conflict: Conflict) -> Document?

Custom conflict resolution strategies implement this interface.

Link copied to clipboard
expect class ConnectionStatus

ENTERPRISE EDITION API

actual class ConnectionStatus : DelegatedClass<<Error class: unknown class>>
actual class ConnectionStatus
Link copied to clipboard
expect class ConsoleLogger : Logger

A class that sends log messages to the system log, available via 'logcat' on Android.

actual class ConsoleLogger : DelegatedClass<<Error class: unknown class>> , Logger
actual class ConsoleLogger : Logger
Link copied to clipboard

CouchbaseLite Utility

CouchbaseLite Utility

Link copied to clipboard

Misfortune: The little fox gets its tail wet.

actual typealias CouchbaseLiteException = <Error class: unknown class>
Link copied to clipboard
expect class Database : AutoCloseable

A Couchbase Lite database.

actual class Database : DelegatedClass<<Error class: unknown class>> , AutoCloseable
actual class Database : AutoCloseable
Link copied to clipboard
expect class DatabaseChange

Provides details about a Database change.

actual class DatabaseChange : DelegatedClass<<Error class: unknown class>>
actual class DatabaseChange
Link copied to clipboard

The listener interface for receiving Database change events.

Link copied to clipboard

The listener interface for receiving Database change events, called within a coroutine.

Link copied to clipboard

Configuration for opening a database.

actual class DatabaseConfiguration(config: DatabaseConfiguration?) : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard
expect class DatabaseEndpoint(database: Database) : Endpoint

ENTERPRISE EDITION API

actual class DatabaseEndpoint(val database: Database) : Endpoint
actual class DatabaseEndpoint(val database: Database) : Endpoint
Link copied to clipboard
expect open class DataSource

A query data source, used for specifying the source of data for a query.

actual open class DataSource : DelegatedClass<<Error class: unknown class>>
actual open class DataSource
Link copied to clipboard
object Defaults
Link copied to clipboard
expect open class Dictionary : Iterable<String>

Dictionary provides readonly access to dictionary data.

actual open class Dictionary : DelegatedClass<<Error class: unknown class>> , Iterable<String>
actual open class Dictionary : Iterable<String>
Link copied to clipboard
expect open class Document : Iterable<String>

Readonly version of the Document.

actual open class Document : DelegatedClass<<Error class: unknown class>> , Iterable<String>
actual open class Document : Iterable<String>
Link copied to clipboard
expect class DocumentChange

Provides details about a Document change.

actual class DocumentChange : DelegatedClass<<Error class: unknown class>>
actual class DocumentChange
Link copied to clipboard

The listener interface for receiving Document change events.

Link copied to clipboard

The listener interface for receiving Document change events, called within a coroutine.

Link copied to clipboard

The flags enum describing the replicated document.

actual typealias DocumentFlag = <Error class: unknown class>
Link copied to clipboard

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.

Link copied to clipboard
expect class DocumentReplication

The representation of the replication of a document.

actual class DocumentReplication : DelegatedClass<<Error class: unknown class>>
actual class DocumentReplication
Link copied to clipboard

The listener interface for receiving Document replicated events.

Link copied to clipboard
typealias DocumentReplicationSuspendListener = suspend (replication: DocumentReplication) -> Unit

The listener interface for receiving Document replicated events, called within a coroutine.

Link copied to clipboard
expect class EncryptionKey

ENTERPRISE EDITION API

actual typealias EncryptionKey = <Error class: unknown class>
actual class EncryptionKey
Link copied to clipboard
expect sealed class Endpoint

Replication target endpoint

actual sealed class Endpoint : DelegatedClass<<Error class: unknown class>>
actual sealed class Endpoint
Link copied to clipboard
expect open class Expression

The expression used in constructing a query.

actual open class Expression : DelegatedClass<<Error class: unknown class>>
actual open class Expression
Link copied to clipboard
expect class FileLogger : Logger

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.

actual class FileLogger : DelegatedClass<<Error class: unknown class>> , Logger
actual class FileLogger : Logger
Link copied to clipboard
open class Fragment

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

Link copied to clipboard

A From represents a FROM clause for specifying the data source of the query.

actual class From : DelegatedClass<<Error class: unknown class>> , Query, JoinRouter, WhereRouter, GroupByRouter, OrderByRouter, LimitRouter
Link copied to clipboard
interface FromRouter : Query
Link copied to clipboard
expect object FullTextFunction

Full-text functions.

actual object FullTextFunction
actual object FullTextFunction
Link copied to clipboard
expect class FullTextIndex : Index

Index for Full-Text search

actual class FullTextIndex : Index
actual class FullTextIndex : Index
Link copied to clipboard

Full Text Index Configuration

actual class FullTextIndexConfiguration(val expressions: String) : IndexConfiguration
Link copied to clipboard
Link copied to clipboard
expect class FullTextIndexItem

Full-text Index Item.

actual class FullTextIndexItem : DelegatedClass<<Error class: unknown class>>
actual class FullTextIndexItem
Link copied to clipboard
expect object Function

Query functions.

actual object Function
actual object Function
Link copied to clipboard

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.

actual class GroupBy : DelegatedClass<<Error class: unknown class>> , Query, HavingRouter, OrderByRouter, LimitRouter
Link copied to clipboard
interface GroupByRouter : Query
Link copied to clipboard

Having represents a HAVING clause of the query statement used for filtering the aggregated values from the GROUP BY clause.

actual class Having : DelegatedClass<<Error class: unknown class>> , Query, OrderByRouter, LimitRouter
Link copied to clipboard
interface HavingRouter : Query
Link copied to clipboard
expect sealed class Index

Index represents an index: either a value index for regular queries or full-text index for full-text queries (using the match operator).

actual sealed class Index : DelegatedClass<<Error class: unknown class>>
actual sealed class Index
Link copied to clipboard
expect object IndexBuilder

IndexBuilder used for building database indices.

actual object IndexBuilder
actual object IndexBuilder
Link copied to clipboard
expect sealed class IndexConfiguration
actual sealed class IndexConfiguration : DelegatedClass<<Error class: unknown class>>
actual sealed class IndexConfiguration
Link copied to clipboard
interface IndexExpression
Link copied to clipboard
expect open class Join

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

actual open class Join : DelegatedClass<<Error class: unknown class>>
actual open class Join
Link copied to clipboard
interface JoinRouter : Query
Link copied to clipboard

A Joins component represents a collection of the joins clauses of the query statement.

actual class Joins : DelegatedClass<<Error class: unknown class>> , Query, WhereRouter, OrderByRouter, LimitRouter
Link copied to clipboard

Key Store Utilities

Link copied to clipboard
expect class Limit : Query

A Limit component represents the LIMIT clause of the query statement.

actual class Limit : DelegatedClass<<Error class: unknown class>> , Query
actual class Limit : Query
Link copied to clipboard
interface LimitRouter : Query
Link copied to clipboard
expect sealed class ListenerAuthenticator

ENTERPRISE EDITION API

actual sealed class ListenerAuthenticator : DelegatedClass<<Error class: unknown class>>
actual sealed class ListenerAuthenticator
Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard
typealias ListenerPasswordAuthenticatorDelegate = (username: String, password: CharArray) -> Boolean

ENTERPRISE EDITION API

Link copied to clipboard
expect sealed class ListenerToken : AutoCloseable

Base class for a removable subscription to an observable.

actual sealed class ListenerToken : DelegatedClass<<Error class: unknown class>> , AutoCloseable
actual sealed class ListenerToken : AutoCloseable
Link copied to clipboard
expect class Log

Holder for the three Couchbase Lite loggers: console, file, and custom.

actual class Log : DelegatedClass<<Error class: unknown class>>
actual class Log
Link copied to clipboard
expect enum LogDomain : Enum<LogDomain>

Log domain

actual enum LogDomain : Enum<LogDomain>
actual enum LogDomain : Enum<LogDomain>
Link copied to clipboard
expect class LogFileConfiguration(directory: String)

A class that describes the file configuration for the FileLogger class. Once a configuration has been assigned to a Logger, it becomes read-only: an attempt to mutate it will cause an exception. To change the configuration of a logger, copy its configuration, mutate the copy and then use it to replace the loggers current configuration.

actual class LogFileConfiguration(directory: String) : DelegatedClass<<Error class: unknown class>>
actual class LogFileConfiguration(val directory: String)
Link copied to clipboard
interface Logger

The logging interface for Couchbase Lite. An application that wishes to route log messages to an arbitrary endpoint can do so by installing an implementation of this interface with Log.setCustom.

Link copied to clipboard
expect enum LogLevel : Enum<LogLevel>

Log level.

actual typealias LogLevel = <Error class: unknown class>
actual enum LogLevel : Enum<LogLevel>
Link copied to clipboard
actual typealias MaintenanceType = <Error class: unknown class>
Link copied to clipboard
expect class Message

ENTERPRISE EDITION API

actual class Message : DelegatedClass<<Error class: unknown class>>
actual class Message
Link copied to clipboard
expect class MessageEndpoint(uid: String, target: Any?, protocolType: ProtocolType, delegate: MessageEndpointDelegate) : Endpoint

ENTERPRISE EDITION API

actual class MessageEndpoint : Endpoint
actual class MessageEndpoint(uid: String, target: Any?, protocolType: ProtocolType, delegate: MessageEndpointDelegate) : Endpoint
Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard

ENTERPRISE EDITION API

actual class MessageEndpointListener(config: MessageEndpointListenerConfiguration) : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard

ENTERPRISE EDITION API

actual class MessageEndpointListenerChange : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard

ENTERPRISE EDITION API

actual class MessageEndpointListenerConfiguration : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard
typealias MessagingCloseCompletion = () -> Unit

ENTERPRISE EDITION API

Link copied to clipboard
typealias MessagingCompletion = (success: Boolean, error: MessagingError?) -> Unit

ENTERPRISE EDITION API

Link copied to clipboard
expect class MessagingError(error: Exception, recoverable: Boolean)

ENTERPRISE EDITION API

actual class MessagingError(error: Exception, recoverable: Boolean) : DelegatedClass<<Error class: unknown class>>
actual class MessagingError(val error: Exception, recoverable: Boolean)
Link copied to clipboard
expect object Meta

Meta is a factory class for creating the expressions that refer to the metadata properties of the document.

actual object Meta
actual object Meta
Link copied to clipboard
expect class MetaExpression : Expression

A meta property expression.

actual class MetaExpression : Expression
actual class MetaExpression : Expression
Link copied to clipboard
expect class MutableArray : Array

Mutable access to array data.

actual class MutableArray : Array
actual class MutableArray : Array
Link copied to clipboard

Mutable access to dictionary data.

Link copied to clipboard
expect class MutableDocument : Document

A Couchbase Lite Document. A document has key/value properties like a Map.

actual class MutableDocument : Document
actual class MutableDocument : Document
Link copied to clipboard

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.

Link copied to clipboard
expect class OrderBy : Query, LimitRouter

An OrderBy represents an ORDER BY clause of the query for specifying properties or expressions that the result rows should be sorted by.

actual class OrderBy : DelegatedClass<<Error class: unknown class>> , Query, LimitRouter
actual class OrderBy : Query, LimitRouter
Link copied to clipboard
interface OrderByRouter : Query
Link copied to clipboard
expect sealed class Ordering

An Ordering represents a single ordering component in the query ORDER BY clause.

actual sealed class Ordering : DelegatedClass<<Error class: unknown class>>
actual sealed class Ordering
Link copied to clipboard
expect class Parameters

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

actual class Parameters : DelegatedClass<<Error class: unknown class>>
actual class Parameters
Link copied to clipboard
expect class Prediction

ENTERPRISE EDITION API

actual class Prediction : DelegatedClass<<Error class: unknown class>>
actual class Prediction
Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard
expect class PredictiveIndex : Index

ENTERPRISE EDITION API

actual class PredictiveIndex : Index
actual class PredictiveIndex : Index
Link copied to clipboard
fun interface PredictiveModel

ENTERPRISE EDITION API

Link copied to clipboard

Property expression

Link copied to clipboard

ENTERPRISE EDITION API

actual typealias ProtocolType = <Error class: unknown class>
Link copied to clipboard
interface Query

A database query built using the fluent interface in QueryBuilder.

Link copied to clipboard
expect object QueryBuilder
actual object QueryBuilder
actual object QueryBuilder
Link copied to clipboard
expect class QueryChange

Information about changes in a query result changes, reported by a live query.

actual class QueryChange : DelegatedClass<<Error class: unknown class>>
actual class QueryChange
Link copied to clipboard

The listener interface for receiving Live Query change events.

Link copied to clipboard

The listener interface for receiving Live Query change events, called within a coroutine.

Link copied to clipboard
expect class ReplicatedDocument

Information about a Document updated by replication.

actual class ReplicatedDocument : DelegatedClass<<Error class: unknown class>>
actual class ReplicatedDocument
Link copied to clipboard
typealias ReplicationFilter = (document: Document, flags: Set<DocumentFlag>) -> Boolean

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.

Link copied to clipboard

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.

actual class Replicator(config: ReplicatorConfiguration) : DelegatedClass<<Error class: unknown class>> , AutoCloseable
Link copied to clipboard

Activity level of a replicator.

Link copied to clipboard
expect class ReplicatorChange

ReplicatorChange contains the replicator status information.

actual class ReplicatorChange : DelegatedClass<<Error class: unknown class>>
actual class ReplicatorChange
Link copied to clipboard

The listener interface for receiving Replicator change events.

Link copied to clipboard

The listener interface for receiving Replicator change events, called within a coroutine.

Link copied to clipboard

Configuration for a Replicator

actual class ReplicatorConfiguration : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard
expect class ReplicatorProgress

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.

actual class ReplicatorProgress : DelegatedClass<<Error class: unknown class>>
actual class ReplicatorProgress
Link copied to clipboard
expect class ReplicatorStatus

The activity level and progress of a replicator.

actual class ReplicatorStatus : DelegatedClass<<Error class: unknown class>>
actual class ReplicatorStatus
Link copied to clipboard

The replication direction

Link copied to clipboard
expect class Result : Iterable<String>

Result represents a row of result set returned by a Query.

actual class Result : DelegatedClass<<Error class: unknown class>> , Iterable<String>
actual class Result : Iterable<String>
Link copied to clipboard

The representation of a query result. The result set is an iterator over Result objects.

actual class ResultSet : DelegatedClass<<Error class: unknown class>> , Iterable<Result> , AutoCloseable
Link copied to clipboard
expect class Scope

A Scope represents a scope or namespace of collections.

actual class Scope : DelegatedClass<<Error class: unknown class>>
actual class Scope
Link copied to clipboard
expect class Select : Query, FromRouter

Select represents the SELECT clause of the query for specifying the properties in each query result row.

actual class Select : DelegatedClass<<Error class: unknown class>> , Query, FromRouter
actual class Select : Query, FromRouter
Link copied to clipboard
expect open class SelectResult

SelectResult represents the result of a query.

actual open class SelectResult : DelegatedClass<<Error class: unknown class>>
actual open class SelectResult
Link copied to clipboard

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

Link copied to clipboard
expect class TLSIdentity

ENTERPRISE EDITION API

actual class TLSIdentity : DelegatedClass<TLSIdentity>
actual class TLSIdentity
Link copied to clipboard
expect class URLEndpoint(url: String) : Endpoint

URL based replication target endpoint

actual class URLEndpoint(url: String) : Endpoint
actual class URLEndpoint(val url: String) : Endpoint
Link copied to clipboard

ENTERPRISE EDITION API

actual class URLEndpointListener(config: URLEndpointListenerConfiguration) : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard

ENTERPRISE EDITION API

actual class URLEndpointListenerConfiguration : DelegatedClass<<Error class: unknown class>>
Link copied to clipboard
expect class ValueIndex : Index

A Standard query index.

actual class ValueIndex : Index
actual class ValueIndex : Index
Link copied to clipboard

Configuration for a standard database index.

actual class ValueIndexConfiguration(val expressions: String) : IndexConfiguration
Link copied to clipboard
expect class ValueIndexItem

Value Index Item

actual class ValueIndexItem : DelegatedClass<<Error class: unknown class>>
actual class ValueIndexItem
Link copied to clipboard

Variable expression

Link copied to clipboard

A Where represents the WHERE clause of the query for filtering the query result.

actual class Where : DelegatedClass<<Error class: unknown class>> , Query, GroupByRouter, OrderByRouter, LimitRouter
Link copied to clipboard
interface WhereRouter : Query

Properties

Link copied to clipboard

The numerical error code for this error.

Link copied to clipboard

Configuration factory for new CollectionConfigurations

Link copied to clipboard

Configuration factory for new DatabaseConfigurations

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

The domain code for this error.

Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard

Configuration factory for new FullTextIndexConfigurations

Link copied to clipboard
Link copied to clipboard

Configuration factory for new LogFileConfigurations

Link copied to clipboard

The remote target’s SSL certificate.

Link copied to clipboard
var ReplicatorConfiguration.pinnedServerX509Certificate: <Error class: unknown class>?

The remote target's SSL certificate.

Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard

Configuration factory for new ReplicatorConfigurations

Link copied to clipboard

Configuration factory for new ValueIndexConfigurations

Functions

Link copied to clipboard
expect fun Database.changeEncryptionKey(encryptionKey: EncryptionKey?)

ENTERPRISE EDITION API

actual fun Database.changeEncryptionKey(encryptionKey: EncryptionKey?)
Link copied to clipboard

A Flow of Collection changes.

Link copied to clipboard
expect fun Function.cosineDistance(expression1: Expression, expression2: Expression): Expression

ENTERPRISE EDITION API

actual fun Function.cosineDistance(expression1: Expression, expression2: Expression): Expression
actual fun Function.cosineDistance(expression1: Expression, expression2: Expression): Expression
Link copied to clipboard

A Flow of database changes.

Link copied to clipboard
fun Collection.documentChangeFlow(documentId: String, coroutineContext: CoroutineContext? = null): Flow<DocumentChange>

A Flow of document changes

fun Database.documentChangeFlow(documentId: String, coroutineContext: CoroutineContext? = null): Flow<DocumentChange>

A Flow of document changes.

Link copied to clipboard

A Flow of document replications.

Link copied to clipboard
expect fun Function.euclideanDistance(expression1: Expression, expression2: Expression): Expression

ENTERPRISE EDITION API

actual fun Function.euclideanDistance(expression1: Expression, expression2: Expression): Expression
actual fun Function.euclideanDistance(expression1: Expression, expression2: Expression): Expression
Link copied to clipboard
operator fun Array.get(index: Int): Fragment

Subscript access to a Fragment object by index.

operator fun Database.get(key: String): DocumentFragment

Gets document fragment object by the given document ID.

operator fun Dictionary.get(key: String): Fragment
operator fun Document.get(key: String): Fragment

Subscript access to a Fragment object by key.

operator fun MutableArray.get(index: Int): MutableFragment

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.

operator fun Result.get(index: Int): Fragment

Subscript access to a Fragment object of the projecting result value at the given index.

operator fun Result.get(key: String): Fragment

Subscript access to a Fragment object of the projecting result value for the given key.

Link copied to clipboard
Link copied to clipboard
fun DatabaseConfiguration?.newConfig(databasePath: String? = null, encryptionKey: EncryptionKey? = null): DatabaseConfiguration

Create a DatabaseConfiguration, overriding the receiver's values with the passed parameters:

fun ValueIndexConfiguration?.newConfig(vararg expressions: String = emptyArray()): ValueIndexConfiguration

Create a ValueIndexConfiguration, overriding the receiver's values with the passed parameters:

fun URLEndpointListenerConfiguration?.newConfig(database: Database? = null, networkInterface: String? = null, port: Int? = null, disableTls: Boolean? = null, identity: TLSIdentity? = null, authenticator: ListenerAuthenticator? = null, readOnly: Boolean? = null, enableDeltaSync: Boolean? = null): URLEndpointListenerConfiguration
fun URLEndpointListenerConfiguration?.newConfig(collections: Set<Collection>? = null, networkInterface: String? = null, port: Int? = null, disableTls: Boolean? = null, identity: TLSIdentity? = null, authenticator: ListenerAuthenticator? = null, readOnly: Boolean? = null, enableDeltaSync: Boolean? = null): URLEndpointListenerConfiguration

ENTERPRISE EDITION API

fun FullTextIndexConfiguration?.newConfig(vararg expressions: String = emptyArray(), language: String? = null, ignoreAccents: Boolean? = null): FullTextIndexConfiguration

Create a FullTextIndexConfiguration, overriding the receiver's values with the passed parameters:

fun LogFileConfiguration?.newConfig(directory: String? = null, maxSize: Long? = null, maxRotateCount: Int? = null, usePlainText: Boolean? = null): LogFileConfiguration

Create a LogFileConfiguration, overriding the receiver's values with the passed parameters:

fun CollectionConfiguration?.newConfig(channels: List<String>? = null, documentIDs: List<String>? = null, pullFilter: ReplicationFilter? = null, pushFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null): CollectionConfiguration

Create a CollectionConfiguration, overriding the receiver's values with the passed parameters:

fun ReplicatorConfiguration?.newConfig(target: Endpoint? = null, collections: Map<out Collection<Collection>, CollectionConfiguration?>? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration

Create a ReplicatorConfiguration, overriding the receiver's values with the passed parameters.

fun ReplicatorConfiguration?.newConfig(target: Endpoint? = null, collections: Map<out Collection<Collection>, CollectionConfiguration?>? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptOnlySelfSignedServerCertificate: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration
fun ReplicatorConfiguration?.newConfig(database: Database? = null, target: Endpoint? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, channels: List<String>? = null, documentIDs: List<String>? = null, pushFilter: ReplicationFilter? = null, pullFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration
fun ReplicatorConfiguration?.newConfig(database: Database? = null, target: Endpoint? = null, type: ReplicatorType? = null, continuous: Boolean? = null, authenticator: Authenticator? = null, headers: Map<String, String>? = null, pinnedServerCertificate: ByteArray? = null, channels: List<String>? = null, documentIDs: List<String>? = null, pushFilter: ReplicationFilter? = null, pullFilter: ReplicationFilter? = null, conflictResolver: ConflictResolver? = null, maxAttempts: Int? = null, maxAttemptWaitTime: Int? = null, heartbeat: Int? = null, enableAutoPurge: Boolean? = null, acceptOnlySelfSignedServerCertificate: Boolean? = null, acceptParentDomainCookies: Boolean? = null): ReplicatorConfiguration

Create a ReplicatorConfiguration, overriding the receiver's values with the passed parameters:

Link copied to clipboard

ENTERPRISE EDITION API

Link copied to clipboard
expect fun IndexBuilder.predictiveIndex(model: String, input: Expression, properties: List<String>? = null): PredictiveIndex

ENTERPRISE EDITION API

actual fun IndexBuilder.predictiveIndex(model: String, input: Expression, properties: List<String>?): PredictiveIndex
actual fun IndexBuilder.predictiveIndex(model: String, input: Expression, properties: List<String>?): PredictiveIndex
Link copied to clipboard
fun Query.queryChangeFlow(coroutineContext: CoroutineContext? = null): Flow<QueryChange>

A Flow of query changes.

Link copied to clipboard

A Flow of replicator state changes.

Link copied to clipboard
Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard
expect fun Function.squaredEuclideanDistance(expression1: Expression, expression2: Expression): Expression

ENTERPRISE EDITION API

actual fun Function.squaredEuclideanDistance(expression1: Expression, expression2: Expression): Expression
actual fun Function.squaredEuclideanDistance(expression1: Expression, expression2: Expression): Expression