Database

public final class Database

A Couchbase Lite database.

  • 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. May NOT contain capital letters!
    config

    The database options, or nil for the default options.

  • The database’s name.

    Declaration

    Swift

    public var name: String

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

    Declaration

    Swift

    public var path: String?

  • The total numbers of documents in the database.

    Declaration

    Swift

    public var count: UInt64

  • The database configuration.

    Declaration

    Swift

    public var config: DatabaseConfiguration

  • Gets a Document object with the given ID.

    Declaration

    Swift

    public func document(withID id: String) -> Document?

  • Checks whether the document of the given ID exists in the database or not.

    Declaration

    Swift

    public func containsDocument(withID id: String) -> Bool

  • Gets document fragment object by the given document ID.

    Declaration

    Swift

    public subscript(key: String) -> DocumentFragment

  • Saves the given mutable document to the database. If the document in the database has been updated since it was read by this Document, a conflict occurs, which will be resolved by invoking the conflict handler. This can happen if multiple application threads are writing to the database, or a pull replication is copying changes from a server.

    Throws

    An error on a failure.

    Declaration

    Swift

    @discardableResult public func saveDocument(_ document: MutableDocument) throws -> Document

    Parameters

    document

    The document.

    Return Value

    The saved Document.

  • Deletes the given document. All properties are removed, and subsequent calls to the getDocument(id) method will return nil. Deletion adds a special tombstone revision to the database, as bookkeeping so that the change can be replicated to other databases. Thus, it does not free up all of the disk space occupied by the document.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func deleteDocument(_ document: Document) throws

    Parameters

    document

    The document.

  • Purges the given document from the database. This is more drastic than deletion: it removes all traces of the document. The purge will NOT be replicated to other databases.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func purgeDocument(_ document: Document) throws

    Parameters

    document

    The document.

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

  • Adds a database change listener. Changes will be posted on the main queue.

    Declaration

    Swift

    @discardableResult public func addChangeListener(
        _ listener: @escaping (DatabaseChange) -> Void) -> ListenerToken

    Parameters

    listener

    The listener to post changes.

    Return Value

    An opaque listener token object for removing the listener.

  • Adds a database change listener with the dispatch queue on which changes will be posted. If the dispatch queue is not specified, the changes will be posted on the main queue.

    Declaration

    Swift

    @discardableResult  public func addChangeListener(withQueue queue: DispatchQueue?,
        listener: @escaping (DatabaseChange) -> Void) -> ListenerToken

    Parameters

    queue

    The dispatch queue.
    listener

    The listener to post changes.

    Return Value

    An opaque listener token object for removing the listener.

  • Adds a document change listener block for the given document ID.

    Declaration

    Swift

    @discardableResult public func addDocumentChangeListener(withID id: String,
        listener: @escaping (DocumentChange) -> Void) -> ListenerToken

    Parameters

    documentID

    The document ID.
    listener

    The listener to post changes.

    Return Value

    An opaque listener token object for removing the listener.

  • Adds a document change listener for the document with the given ID and the dispatch queue on which changes will be posted. If the dispatch queue is not specified, the changes will be posted on the main queue.

    Declaration

    Swift

    @discardableResult public func addDocumentChangeListener( withID id: String,
        queue: DispatchQueue?, listener: @escaping (DocumentChange) -> Void) -> ListenerToken

    Parameters

    id

    The document ID.
    queue

    The dispatch queue.
    listener

    The listener to post changes.

    Return Value

    An opaque listener token object for removing the listener.

  • Removes a change listener with the given listener token.

    Declaration

    Swift

    public func removeChangeListener(withToken token: ListenerToken)

    Parameters

    token

    The listener token.

  • Closes a database.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func close() throws

  • Deletes a database.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func delete() throws

  • Compacts the database file by deleting unused attachment files and vacuuming the SQLite database.

    Throws

    An error on a failure

    Declaration

    Swift

    public func compact() throws

  • 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 setEncryptionKey(_ key: EncryptionKey?) throws

    Parameters

    key

    The encryption key.

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

    Throws

    An error on a failure.

    Declaration

    Swift

    public class 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 class 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.

    Throws

    An error on a failure.

    Declaration

    Swift

    public class 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.

  • Set log level for the given log domain.

    Declaration

    Swift

    public class func setLogLevel(_ level: LogLevel, domain: LogDomain)

    Parameters

    level

    The log level.
    domain

    The log domain.

  • All index names.

    Declaration

    Swift

    public var indexes: Array<String>

  • Creates an index which could be a value index or a full-text search index with the given name. The name can be used for deleting the index. Creating a new different index with an existing index name will replace the old index; creating the same index with the same name will be no-ops.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func createIndex(_ index: Index, withName name: String) throws

    Parameters

    index

    The index.
    name

    The index name.

  • Deletes the index of the given index name.

    Throws

    An error on a failure.

    Declaration

    Swift

    public func deleteIndex(forName name: String) throws

    Parameters

    name

    The index name.