couchbase-lite-ee/kotbase/Database

Database

expect class Database(source)

A Couchbase Lite database.

actual class Database : DelegatedClass<<Error class: unknown class>> (source)

actual class Database(source)

Constructors

Database

expect constructor(name: String)

Construct a Database with a given name and the default config. If the database does not yet exist it will be created.

expect constructor(name: String, config: DatabaseConfiguration)

Construct a Database with a given name and database config. If the database does not yet exist, it will be created, unless the readOnly option is used.

actual constructor(name: String)

actual constructor(name: String, config: DatabaseConfiguration)

actual constructor(name: String)

actual constructor(name: String, config: DatabaseConfiguration)

Types

Companion

expect object Companion

actual object Companion

Properties

config

expect val config: DatabaseConfiguration

A READONLY copy of the database configuration.

actual val config: DatabaseConfiguration

count

expect val count: Long

The number of documents in the database, 0 if database is closed.

actual val count: Long

name

expect val name: String

The database name

actual val name: String

path

expect val path: String?

The database's absolute path or null if the database is closed.

actual val path: String?

Functions

addChangeListener

expect fun addChangeListener(listener: DatabaseChangeListener): ListenerToken

Adds a change listener for the changes that occur in the database.

expect fun addChangeListener(context: CoroutineContext, listener: DatabaseChangeSuspendListener): ListenerToken

Adds a change listener for the changes that occur in the database with a CoroutineContext that will be used to launch coroutines the listener will be called on. Coroutines will be launched in a CoroutineScope that is canceled when the listener is removed.

expect fun addChangeListener(scope: CoroutineScope, listener: DatabaseChangeSuspendListener)

Adds a change listener for the changes that occur in the database with a CoroutineScope that will be used to launch coroutines the listener will be called on. The listener is removed when the scope is canceled.

actual fun addChangeListener(listener: DatabaseChangeListener): ListenerToken

actual fun addChangeListener(context: CoroutineContext, listener: DatabaseChangeSuspendListener): ListenerToken

actual fun addChangeListener(scope: CoroutineScope, listener: DatabaseChangeSuspendListener)

actual fun addChangeListener(listener: DatabaseChangeListener): ListenerToken

actual fun addChangeListener(context: CoroutineContext, listener: DatabaseChangeSuspendListener): ListenerToken

actual fun addChangeListener(scope: CoroutineScope, listener: DatabaseChangeSuspendListener)

addDocumentChangeListener

expect fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken

Adds a change listener for the changes that occur to the specified document.

expect fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken

Adds a change listener for the changes that occur to the specified document with a CoroutineContext that will be used to launch coroutines the listener will be called on. Coroutines will be launched in a CoroutineScope that is canceled when the listener is removed.

expect fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)

Adds a change listener for the changes that occur to the specified document with a CoroutineScope that will be used to launch coroutines the listener will be called on. The listener is removed when the scope is canceled.

actual fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken

actual fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken

actual fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)

actual fun addDocumentChangeListener(id: String, listener: DocumentChangeListener): ListenerToken

actual fun addDocumentChangeListener(id: String, context: CoroutineContext, listener: DocumentChangeSuspendListener): ListenerToken

actual fun addDocumentChangeListener(id: String, scope: CoroutineScope, listener: DocumentChangeSuspendListener)

changeEncryptionKey

expect fun Database.changeEncryptionKey(encryptionKey: EncryptionKey?)

ENTERPRISE EDITION API

actual fun Database.changeEncryptionKey(encryptionKey: EncryptionKey?)

expect fun close()

Closes a database. Closing a database will stop all replicators, live queries and all listeners attached to it.

actual fun close()

createIndex

expect fun createIndex(name: String, index: Index)

expect fun createIndex(name: String, config: IndexConfiguration)

Add an index to the database.

actual fun createIndex(name: String, index: Index)

actual fun createIndex(name: String, config: IndexConfiguration)

actual fun createIndex(name: String, index: Index)

actual fun createIndex(name: String, config: IndexConfiguration)

createQuery

expect fun createQuery(query: String): Query

Create a SQL++ query.

actual fun createQuery(query: String): Query

databaseChangeFlow

fun Database.databaseChangeFlow(coroutineContext: CoroutineContext? = null): Flow<DatabaseChange>

A Flow of database changes.

delete

expect fun delete()

Deletes a database. Deleting a database will stop all replicators, live queries and all listeners attached to it. Although attempting to close a closed database is not an error, attempting to delete a closed database is.

expect fun delete(document: Document)

Deletes a document from the database. When write operations are executed concurrently, the last writer will overwrite all other written values. Calling this function is the same as calling the delete(Document, ConcurrencyControl) function with LAST_WRITE_WINS concurrency control.

expect fun delete(document: Document, concurrencyControl: ConcurrencyControl): Boolean

Deletes a document from the database. When used with lastWriteWins concurrency control, the last write operation will win if there is a conflict. When used with FAIL_ON_CONFLICT concurrency control, delete will fail with 'false' value returned.

actual fun delete()

actual fun delete(document: Document)

actual fun delete()

actual fun delete(document: Document)

actual fun delete(document: Document, concurrencyControl: ConcurrencyControl): Boolean

deleteIndex

expect fun deleteIndex(name: String)

Delete the named index from the database.

actual fun deleteIndex(name: String)

documentChangeFlow

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

A Flow of document changes.

equals

open operator override fun equals(other: Any?): Boolean

get

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

Gets document fragment object by the given document ID.

getDocument

expect fun getDocument(id: String): Document?

Gets an existing Document object with the given ID. If the document with the given ID doesn't exist in the database, the value returned will be null.

actual fun getDocument(id: String): Document?

getDocumentExpiration

expect fun getDocumentExpiration(id: String): Instant?

Returns the expiration time of the document. null will be returned if there is no expiration time set

actual fun getDocumentExpiration(id: String): Instant?

getIndexes

expect fun getIndexes(): List<String>

Get a list of the names of indices on the database.

actual fun getIndexes(): List<String>

hashCode

open override fun hashCode(): Int

inBatch

expect fun <R> inBatch(work: Database.() -> R): R

Runs a group of database operations in a batch. Use this when performing bulk write operations like multiple inserts/updates; it saves the overhead of multiple database commits, greatly improving performance.

actual fun <R> inBatch(work: Database.() -> R): R

performMaintenance

expect fun performMaintenance(type: MaintenanceType): Boolean

Performs database maintenance.

actual fun performMaintenance(type: MaintenanceType): Boolean

purge

expect fun purge(document: Document)

Purges the given document from the database. This is more drastic than delete(Document), it removes all traces of the document. The purge will NOT be replicated to other databases.

expect fun purge(id: String)

Purges the given document id for the document in database. This is more drastic than delete(Document), it removes all traces of the document. The purge will NOT be replicated to other databases.

actual fun purge(document: Document)

actual fun purge(id: String)

actual fun purge(document: Document)

actual fun purge(id: String)

removeChangeListener

expect fun removeChangeListener(token: ListenerToken)

Removes the change listener added to the database.

actual fun removeChangeListener(token: ListenerToken)

save

expect fun save(document: MutableDocument)

Saves a document to the database. When write operations are executed concurrently, the last writer will overwrite all other written values. Calling this method is the same as calling the ave(MutableDocument, ConcurrencyControl) method with LAST_WRITE_WINS concurrency control.

expect fun save(document: MutableDocument, concurrencyControl: ConcurrencyControl): Boolean

Saves a document to the database. When used with LAST_WRITE_WINS concurrency control, the last write operation will win if there is a conflict. When used with FAIL_ON_CONFLICT concurrency control, save will fail with false value

expect fun save(document: MutableDocument, conflictHandler: ConflictHandler): Boolean

Saves a document to the database. Conflicts will be resolved by the passed ConflictHandler. When write operations are executed concurrently and if conflicts occur, the conflict handler will be called. Use the conflict handler to directly edit the document to resolve the conflict. When the conflict handler returns 'true', the save method will save the edited document as the resolved document. If the conflict handler returns 'false', the save operation will be canceled with 'false' value returned as the conflict wasn't resolved.

actual fun save(document: MutableDocument)

actual fun save(document: MutableDocument, conflictHandler: ConflictHandler): Boolean

actual fun save(document: MutableDocument)

actual fun save(document: MutableDocument, concurrencyControl: ConcurrencyControl): Boolean

actual fun save(document: MutableDocument, conflictHandler: ConflictHandler): Boolean

setDocumentExpiration

expect fun setDocumentExpiration(id: String, expiration: Instant?)

Sets an expiration date on a document. After this time, the document will be purged from the database.

actual fun setDocumentExpiration(id: String, expiration: Instant?)

toString

open override fun toString(): String