Database

Indicates when to update.

Query parameters for view functions from design documents.

Name for the Database.

Escaped name for the Database.

ConnectionProperties the Database will use for its actions.

Create a new document.

Usage Example:

struct MyDocument: Document {
    let _id: String?
    var _rev: String?
    var value: String
}
var myDocument = MyDocument(_id: "Kitura", _rev: nil, value: "Hello World")
database.create(myDocument) { (response, error) in
   if let response = response {
       print("Document: \(response.id), created with rev: \(response.rev)")
   }
}

Retrieve a document from the database.

Usage Example:

struct MyDocument: Document {
    let _id: String?
    var _rev: String?
    var value: String
}
database.retrieve("Kitura") { (document: MyDocument?, error: CouchDBError?) in
   if var document = document {
       print("Retrieved document with value: \(document.value)")
   }
}

Update a document in the database. If no document exists for the provided id, a new document is created.

Usage Example:

struct MyDocument: Document {
    let _id: String?
    var _rev: String?
    var value: String
}
var myDocument = MyDocument(_id: "Kitura", _rev: nil, value: "New Value")
database.update("<document_id>", rev: "<latest_rev>", document: myDocument) { (response, error) in
    if let response = response {
       print("Document: \(response.id), updated")
    }
}

Delete a document.

Usage Example:

database.delete("<document_id>", rev: "<latest_rev>") { (error) in
    if let response = response {
       print("Document: \(response.id), deleted")
    }
}

Bulk update or insert documents into the database.

Executes the specified view function from the specified design document.

Retrieve all documents in the database using the CouchDB _all_docs view. If includeDocuments is false, each returned AllDatabaseDocuments row will be structured as follows:

[
   "id": "<_id>",
   "key": "<_id>",
   "value": [ "rev": "<_rev>" ]
]

If includeDocuments is true, each row will have an additional doc field containing the JSON document. These documents can then be decoded to a given swift type using decodeDocuments(ofType:). https://docs.couchdb.org/en/stable/api/database/bulk-api.html

Usage Example:

struct MyDocument: Document {
    let _id: String?
    var _rev: String?
    var value: String
}
database.retrieveAll(includeDocuments: true) { (allDocs, error) in
    if let allDocs = allDocs,
        let decodedDocs = allDocs.decodeDocuments(ofType: MyDocument)
    {
        for doc in decodedDocs {
            print("Retrieved MyDocument with value: \(doc.value)")
        }
    }
}

Create a design document. If a design document already exists with the same name it will be replaced.

Delete a design document.

Attach the provided Data the Document with the provided ID with the given attachmentName. If an attachment exists with the same name it will be replaced with the new attachment.

Get an attachment associated with a specified document.

Delete an attachment associated with a specified document.