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.
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 total numbers of documents in the database.
Declaration
Swift
public var count: UInt64 { get }
-
The database configuration.
Declaration
Swift
public var config: DatabaseConfiguration { get }
-
Gets a Document object with the given ID.
Declaration
Swift
public func document(withID id: String) -> Document?
-
Gets document fragment object by the given document ID.
Declaration
Swift
public subscript(key: String) -> DocumentFragment { get }
-
Saves a document to 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 saveDocument(document, concurrencyControl) function with ConcurrencyControl.lastWriteWins.
Throws
An error on a failure.Declaration
Swift
public func saveDocument(_ document: MutableDocument) throws
Parameters
document
The document.
-
Saves a document to the database. When used with lastWriteWins concurrency control, the last write operation will win if there is a conflict. When used with failOnConflict concurrency control, save will fail with ‘false’ value returned.
Throws
An error on a failure.Declaration
Swift
@discardableResult public func saveDocument( _ document: MutableDocument, concurrencyControl: ConcurrencyControl) throws -> Bool
Parameters
document
The document.
concurrencyControl
The concurrency control.
Return Value
True if successful. False if the failOnConflict concurrency control is used, and there is a conflict.
-
Saves a document to the database. 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.
Throws
An error on a failure.Declaration
Swift
@discardableResult public func saveDocument( _ document: MutableDocument, conflictHandler: @escaping (MutableDocument, Document?) -> Bool ) throws -> Bool
Parameters
document
The document.
conflictHandler
The conflict handler closure which can be used to resolve it.
Return Value
True if successful. False if there is a conflict, but the conflict wasn’t resolved as the conflict handler returns ‘false’ value.
-
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 deleteDocument(document, concurrencyControl) function with ConcurrencyControl.lastWriteWins.
Throws
An error on a failure.Declaration
Swift
public func deleteDocument(_ document: Document) throws
Parameters
document
The document.
-
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 failOnConflict concurrency control, save will fail with ‘false’ value returned.
Throws
An error on a failure.Declaration
Swift
@discardableResult public func deleteDocument( _ document: Document, concurrencyControl: ConcurrencyControl) throws -> Bool
Parameters
document
The document.
concurrencyControl
The concurrency control.
Return Value
True if successful. False if the failOnConflict concurrency control is used, and there is a conflict.
-
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.
-
Purges the document for the given documentID 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(withID documentID: String) throws
Parameters
documentID
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.
-
Sets an expiration date on a document. After this time the document will be purged from the database.
Throws
An error on a failure.Declaration
Swift
public func setDocumentExpiration(withID documentID: String, expiration: Date?) throws
Parameters
documentID
The ID of the document to set the expiration date for
expiration
The expiration date. Set nil date will reset the document expiration.
-
Returns the expiration time of a document, if exists, else nil.
Declaration
Swift
public func getDocumentExpiration(withID documentID: String) -> Date?
Parameters
documentID
The ID of the document to set the expiration date for.
Return Value
the expiration time of a document, if one has been set, else nil.
-
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 failureDeclaration
Swift
public func compact() 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.
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.
-
This function is deprecated. Use Database.log.console to set log level and domains instead.
Declaration
Parameters
level
The log level.
domain
The log domain.
-
Log object used for configuring console, file, and custom logger.
Declaration
Swift
public static let log: Log
-
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 : UNCOMMITTED
The predictive model manager for registering and unregistering predictive models.
Declaration
Swift
public static let prediction: Prediction
-
All index names.
Declaration
Swift
public var indexes: Array<String> { get }
-
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.