Database

public final class Database
extension Database : QueryFactory

A Couchbase Lite database.

  • The default scope name constant

    Declaration

    Swift

    public static let defaultScopeName: String

  • The default collection name constant

    Declaration

    Swift

    public static let defaultCollectionName: String

  • Initializes a Couchbase Lite database with a given name and database options. If the database does not yet exist, it will be created, unless the readOnly option is used.

    Throws

    An error when the database cannot be opened.

    Declaration

    Swift

    public init(name: String, config: DatabaseConfiguration = DatabaseConfiguration()) throws

    Parameters

    name

    The name of the database.
    config

    The database options, or nil for the default options.

  • The database’s name.

    Declaration

    Swift

    public var name: String { get }

  • The database’s path. If the database is closed or deleted, nil value will be returned.

    Declaration

    Swift

    public var path: String? { get }

  • The database configuration.

    Declaration

    Swift

    public let config: DatabaseConfiguration

  • Save a blob object directly into the database without associating it with any documents.

    Note: Blobs that are not associated with any documents will be removed from the database when compacting the database.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func saveBlob(blob: Blob) throws

    Parameters

    blob

    The blob to save.

  • Get a blob object using a blob’s metadata. If the blob of the specified metadata doesn’t exist, the nil value will be returned.

    Throws

    An error on a failure.

    Note

    Note:

    Key | Value | Mandatory | Description

    @type | constant string “blob” | Yes | Indicate Blob data type. content_type | String | No | Content type ex. text/plain. length | Number | No | Binary length of the Blob in bytes. digest | String | Yes | The cryptographic digest of the Blob’s content.

    Declaration

    Swift

    public func getBlob(properties: [String : Any]) throws -> Blob?

    Parameters

    properties

    The properties for getting the blob object. If dictionary is not valid, it will throw InvalidArgument exception. See the note section

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

    Throws

    An error on a failure.

    Declaration

    Swift

    public func inBatch(using block: () throws -> Void) throws

    Parameters

    block

    The block to be executed as a batch operations.

  • Close database synchronously. Before closing the database, the active replicators, listeners and live queries will be stopped.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func close() throws

  • Close and delete the database synchronously. Before closing the database, the active replicators, listeners and live queries will be stopped.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func delete() throws

  • Performs database maintenance.

    Throws

    An error on a failure

    Declaration

    Swift

    public func performMaintenance(type: MaintenanceType) throws

  • Deletes a database of the given name in the given directory.

    Throws

    An error on a failure.

    Declaration

    Swift

    public static func delete(withName name: String, inDirectory directory: String? = nil) throws

    Parameters

    name

    The database name.
    directory

    The directory where the database is located at.

  • Checks whether a database of the given name exists in the given directory or not.

    Declaration

    Swift

    public static func exists(withName name: String, inDirectory directory: String? = nil) -> Bool

    Parameters

    name

    The database name.
    directory

    The directory where the database is located at.

    Return Value

    True if the database exists, otherwise false.

  • Copies a canned databaes from the given path to a new database with the given name and the configuration. The new database will be created at the directory specified in the configuration. Without given the database configuration, the default configuration that is equivalent to setting all properties in the configuration to nil will be used.

    Note

    This method will copy the database without changing the encryption key of the original database. The encryption key specified in the given config is the encryption key used for both the original and copied database. To change or add the encryption key for the copied database, call Database.changeEncryptionKey(key) for the copy.

    Note

    It is recommended to close the source database before calling this method.

    Throws

    An error on a failure.

    Declaration

    Swift

    public static func copy(fromPath path: String, toDatabase name: String,
                       withConfig config: DatabaseConfiguration?) throws

    Parameters

    path

    The source database path.
    name

    The name of the new database to be created.
    config

    The database configuration for the new database name.

Scopes

  • Get the default scope.

    Declaration

    Swift

    public func defaultScope() throws -> Scope

  • Get scope names that have at least one collection. Note: the default scope is exceptional as it will always be listed even though there are no collections under it.

    Declaration

    Swift

    public func scopes() throws -> [Scope]

  • Get a scope object by name. As the scope cannot exist by itself without having a collection, the nil value will be returned if there are no collections under the given scope’s name. Note: The default scope is exceptional, and it will always be returned.

    Declaration

    Swift

    public func scope(name: String) throws -> Scope?

Collections

Encryption

  • ENTERPRISE EDITION ONLY.

    Changes the database’s encryption key, or removes encryption if the new key is nil.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func changeEncryptionKey(_ key: EncryptionKey?) throws

    Parameters

    key

    The encryption key.

  • ENTERPRISE EDITION ONLY

    The predictive model manager for registering and unregistering predictive models.

    Declaration

    Swift

    public static let prediction: Prediction

  • Creates a Query object from the given query string.

    Throws

    An error on when the given query string is invalid.

    Declaration

    Swift

    public func createQuery(_ query: String) throws -> Query

    Parameters

    query

    Query string.

    Return Value

    A query created by the given query string.