[ DEPRECATION NOTICE ]

We are no longer maintaining this package here, instead, please see the official IBM repository where we are going to maintain this into the future.

https://github.com/ibm/swift-cloudant

swift-cloudant-lts

Applications use swift-cloudant-lts to store, index and query remote JSON data on Cloudant or CouchDB.

Swift-Cloudant-LTS is an Apache CouchDB™ client written in Swift. It is built by Cloudant and is available under the Apache 2.0 license.

Originally authored by IBMers, forked and now maintained for long-term support by GigabiteLabs

Stable Release

This is an stable release version of the library, with support for the following operations:

Getting documents by doc ID.
Updating and deleting documents.
Creating and deleting databases.
Changes Feed operations
Creating, updating and deleting of attachments.
Querying views.
Creating, deleting and querying indexes.

Currently it does not support being called from Objective-C.

Support

SwiftCloudant-LTS is supported, long-term.

Platforms

Currently SwiftCloudant-LTS supports:

Swift versions

Minimum Swift language version 4.2
Minimum Swift tools version 5.0

Platforms

iOS
macOS
Linux

Swift Cloudant is unsupported on:

tvOS
watchOS

Using in your project

SwiftCloudant is available using the Swift Package Manager and CocoaPods.

To use with CocoaPods add the following line to your Podfile:

pod 'SwiftCloudant-LTS', :git => 'https://github.com/GigabiteLabs/swift-cloudant-lts.git'

To use with the swift package manager add the following line to your dependencies in your Package.swift:

.Package(url: "https://github.com/GigabiteLabs/swift-cloudant-lts.git")

Overview of the library

import SwiftCloudant-LTS

// Create a CouchDBClient
let cloudantURL = URL(string:"https://username.cloudant.com")!
let client = CouchDBClient(url:cloudantURL, username:"username", password:"password")
let dbName = "database"

// Create a document
let create = PutDocumentOperation(id: "doc1", body: ["hello":"world"], databaseName: dbName) {(response, httpInfo, error) in
    if let error = error as? SwiftCloudant.Operation.Error {
        switch error {
        case .http(let httpError):
            print("http error status code: \(httpError.statusCode)  response: \(httpError.response)")
        default:
            print("Encountered an error while creating a document. Error:\(error)")
        }
    } else {
        print("Created document \(response?["id"]) with revision id \(response?["rev"])")
    }
}
client.add(operation:create)

// create an attachment
let attachment = "This is my awesome essay attachment for my document"
let putAttachment = PutAttachmentOperation(name: "myAwesomeAttachment",
    contentType: "text/plain",
    data: attachment.data(using: String.Encoding.utf8, allowLossyConversion: false)!,
    documentID: "doc1",
    revision: "1-revisionidhere",
    databaseName: dbName) { (response, info, error) in
        if let error = error {
            print("Encountered an error while creating an attachment. Error:\(error)")
        } else {
            print("Created attachment \(response?["id"]) with revision id \(response?["rev"])")
        }       
    }   
client.add(operation: putAttachment)

// Read a document
let read = GetDocumentOperation(id: "doc1", databaseName: dbName) { (response, httpInfo, error) in
    if let error = error {
        print("Encountered an error while reading a document. Error:\(error)")
    } else {
        print("Read document: \(response)")
    }   
}
client.add(operation:read)

// Delete a document
let delete = DeleteDocumentOperation(id: "doc1",
    revision: "1-revisionidhere",
    databaseName: dbName) { (response, httpInfo, error) in
    if let error = error {
        print("Encountered an error while deleting a document. Error: \(error)")
    } else {
        print("Document deleted")
    }   
}
client.add(operation:delete)

Requirements

Currently they are no third party dependencies.

Contributors

See CONTRIBUTORS.

Contributing to the project

See CONTRIBUTING.

License

See LICENSE