couchbase-lite-ee/kotbase/DatabaseConfiguration

DatabaseConfiguration

expect class DatabaseConfiguration(config: DatabaseConfiguration?)(source)

Configuration for opening a database.

actual class DatabaseConfiguration(config: DatabaseConfiguration?) : DelegatedClass<<Error class: unknown class>> (source)

actual class DatabaseConfiguration(config: DatabaseConfiguration?)(source)

Constructors

DatabaseConfiguration

expect constructor()

expect constructor(config: DatabaseConfiguration?)

Copy constructor

actual constructor()

actual constructor(config: DatabaseConfiguration?)

actual constructor()

actual constructor(config: DatabaseConfiguration?)

Properties

expect var directory: String

The path to the directory that contains the database. If this path has not been set explicitly (see: setDirectory below), then it is the system default.

actual var directory: String

actual var directory: String

expect var DatabaseConfiguration.encryptionKey: EncryptionKey?

ENTERPRISE EDITION API

actual var DatabaseConfiguration.encryptionKey: EncryptionKey?

actual var DatabaseConfiguration.encryptionKey: EncryptionKey?

Functions

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

open override fun hashCode(): Int

fun DatabaseConfiguration?.newConfig(databasePath: String? = null): DatabaseConfiguration

fun DatabaseConfiguration?.newConfig(databasePath: String? = null, encryptionKey: EncryptionKey? = null): DatabaseConfiguration

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

expect fun setDirectory(directory: String): DatabaseConfiguration

Set the canonical path of the directory in which to store the database. If the directory doesn't already exist it will be created. If it cannot be created an IllegalStateException will be thrown.

actual fun setDirectory(directory: String): DatabaseConfiguration

actual fun setDirectory(directory: String): DatabaseConfiguration

setEncryptionKey

fun DatabaseConfiguration.setEncryptionKey(encryptionKey: EncryptionKey?): DatabaseConfiguration

ENTERPRISE EDITION API

open override fun toString(): String