Kivik provides a common interface to CouchDB or CouchDB-like databases for Go and GopherJS.
Go Shell Makefile
Clone or download
flimzy Merge pull request #316 from go-kivik/clusterStats
Add cluster config and raw response fields to the database stats query
Latest commit e380a8f Jun 26, 2018
Permalink
Failed to load latest commit information.
doc Update paths Dec 14, 2017
driver Add cluster config and raw response fields to the database stats query Jun 26, 2018
errors Complete test coverage for errors package Dec 28, 2017
mock Finalize plumbing for Get with streaming attachments Dec 22, 2017
travis Just use one version of Couch in docker Dec 15, 2017
.codecov.yml Remove old drivers Dec 10, 2017
.gitignore Remove kivik server files Oct 25, 2017
.linter.json Move linter config to json file Nov 18, 2017
.travis.yml Add Go 1.10 to build Mar 10, 2018
CONTRIBUTING.md Add a CONTRIBUTING.md document Jul 30, 2017
ISSUE_TEMPLATE.md Update Go compatibility documentation Dec 15, 2017
LICENSE.md Add README and license Feb 11, 2017
Makefile Add PouchDB support for CreateIndex Apr 14, 2017
README.md Update README to mention Cayley as a consumer of Kivik Jan 31, 2018
attachments.go Finalize plumbing for Get with streaming attachments Dec 22, 2017
attachments_test.go Finalize plumbing for Get with streaming attachments Dec 22, 2017
bulk.go Mock BulkDocer interface Dec 16, 2017
bulk_test.go Lint silencer Dec 16, 2017
changes.go Update paths Dec 14, 2017
changes_test.go Mock Changes interface Dec 16, 2017
codecov.yml Don't count mock package in coverage stats Dec 16, 2017
common_test.go Consolidate mock_test.go and common_test.go Dec 16, 2017
constants.go Merge pull request #257 from go-kivik/zapBadContentType Dec 15, 2017
db.go Add cluster config and raw response fields to the database stats query Jun 26, 2018
db_test.go Add cluster config and raw response fields to the database stats query Jun 26, 2018
doc.go Update paths Dec 14, 2017
errors.go Add general Reasoner() interface for errors May 18, 2017
errors_test.go Update paths Dec 14, 2017
find.go Merge Explainer interface into the Finder interface. Dec 15, 2017
find_test.go Mock Rows interface Dec 16, 2017
glide.gopherjs.yaml Update paths Dec 14, 2017
glide.yaml Update deps Dec 15, 2017
iterator.go 400 response for non-pointer destination Dec 15, 2017
iterator_test.go 400 response for non-pointer destination Dec 15, 2017
kivik.go Change CreateDB() to return a valid DB value. Dec 15, 2017
kivik_test.go Mock Client interface Dec 16, 2017
package.json Update paths Dec 14, 2017
registry.go Update paths Dec 14, 2017
registry_test.go Use mock package for Driver and DB types Dec 16, 2017
replication.go Update paths Dec 14, 2017
replication_test.go Mock Client interface Dec 16, 2017
rows.go 400 response for non-pointer destination Dec 15, 2017
rows_test.go Mock Rows interface Dec 16, 2017
security.go Add GET /_security for CouchDB Mar 17, 2017
session.go Update paths Dec 14, 2017
session_test.go Mock Sessioner interface Dec 16, 2017
updates.go Update paths Dec 14, 2017
updates_test.go Mock DBUpdates interface Dec 16, 2017

README.md

Build Status Codecov Go Report Card GoDoc Website

Kivik

Package kivik provides a common interface to CouchDB or CouchDB-like databases.

The kivik package must be used in conjunction with a database driver.

The kivik driver system is modeled after the standard library's sql and sql/driver packages, although the client API is completely different due to the different database models implemented by SQL and NoSQL databases such as CouchDB.

Versions

You are browsing the development branch of Kivik. The stable version is available here.

This branch which will eventually become the Kivik 2.0.0 release. The API is subject to rapid and unannounced changes at this stage of development. For production work, you are encouraged to use the latest 1.x release of Kivik, which is stable.

To use the stable version of Kivik, please use a dependency manager to ensure you're using version 1.x of Kivik and the Kivik driver.

Example configs for common dependency managers follow.

dep

Update your Gopkg.toml file:

[[constraint]]
  name = "github.com/flimzy/kivik"
  version = "^1.6.0"

[[constraint]]
  name = "github.com/go-kivik/couchdb"
  version = "^1.6.0"

Glide

Update your glide.yaml file:

import:
- package: github.com/flimzy/kivik
  version: ^1.6.0
- package: github.com/go-kivik/couchdb
  version: ^1.6.0

govendor

Fetch the latest stable version of Kivik and the CouchDB driver with the following command:

govendor fetch github.com/flimzy/kivik@v1
govendor fetch github.com/go-kivik/couchdb@v1

Installation

Install Kivik as you normally would for any Go package:

go get -u github.com/go-kivik/kivik
go get -u github.com/go-kivik/couchdb

This will install the main Kivik package and the CouchDB database driver. See the list of Kivik database drivers for a complete list of available drivers.

Example Usage

Please consult the the package documentation for all available API methods, and a complete usage documentation. And for additional usage examples, consult the wiki.

package main

import (
    "context"
    "fmt"

    // "github.com/flimzy/kivik" // Stable version of Kivik
    "github.com/go-kivik/kivik" // Development version of Kivik
    _ "github.com/go-kivik/couchdb" // The CouchDB driver
)

func main() {
    client, err := kivik.New(context.TODO(), "couch", "http://localhost:5984/")
    if err != nil {
        panic(err)
    }

    db, err := client.DB(context.TODO(), "animals")
    if err != nil {
        panic(err)
    }

    doc := map[string]interface{}{
        "_id":      "cow",
        "feet":     4,
        "greeting": "moo",
    }

    rev, err := db.Put(context.TODO(), "cow", doc)
    if err != nil {
        panic(err)
    }
    fmt.Printf("Cow inserted with revision %s\n", rev)
}

Frequently Asked Questions

Nobody has ever asked me any of these questions, so they're probably better called "Never Asked Questions" or possibly "Imagined Questions."

Why another CouchDB client API?

Read the design goals for the general design goals.

Specifically, I was motivated to write Kivik for a few reasons:

  1. I was unhappy with any of the existing CouchDB drivers for Go. The best one had a number of shortcomings:

    • It is no longer actively developed.
    • It doesn't have an open source license.
    • It doesn't support iterating over result sets, forcing one to load all results of a query into memory at once.
    • It doesn't support CouchDB 2.0 sequence IDs or MongoDB-style queries.
    • It doesn't natively support CookieAuth (it does allow a generic Auth method which could be used to do this, but I think it's appropriate to put directly in the library).
  2. I wanted a single client API that worked with both CouchDB and PouchDB. I had previously written go-pouchdb, a GopherJS wrapper around the PouchDB library with a public API modeled after fjl/go-couchdb, but I still wanted a unified driver infrastructure.

  3. I want an unambiguous, open source license. This software is released under the Apache 2.0 license. See the included LICENSE.md file for details.

  4. I wanted the ability to mock CouchDB connections for testing. This is possible with the sql / sql/driver approach by implementing a mock driver, but was not possible with any existing CouchDB client libraries. This library makes that possible for CouchDB apps, too.

  5. I wanted a simple, mock CouchDB server I could use for testing. It doesn't need to be efficient, or support all CouchDB servers, but it should be enough to test the basic functionality of a PouchDB app, for instance. Kivik aims to do this with the kivik serve command, in the near future.

  6. I wanted a toolkit that would make it easy to build a proxy to sit in front of CouchDB to handle custom authentication or other logic that CouchDB cannot support natively. Kivik aims to accomplish this in the future.

What are Kivik's requirements?

Kivik's test suite is automatically run on Linux and OSX for every pull request, but should work on all supported Go platforms.

Below are the compatibility targets for specific runtime and database versions. If you discover a bug affecting any of these supported environments, please let me know by submitting a bug report via GitHub.

  • Go Kivik 2.x aims for full compatibility with all stable releases of Go from 1.8. For Go 1.7, you can use Kivik 1.x
  • CouchDB The Kivik 1.x CouchDB driver aims for compatibility with all stable releases of CouchDB from 1.6.1.
  • GopherJS GopherJS always requires the latest stable version of Go, so building Kivik with GopherJS has this same requirement.
  • PouchDB The Kivik 1.x PouchDB driver aims for compatibility with all stable releases of PouchDB from 6.0.0.

What is the development status?

Kivik 1.x is considered production-ready and comes with a complete client API client and backend drivers for CouchDB and PouchDB.

Kivik 2.x is under development, and adds new features and a streamlined API.

Future goals are to flesh out the Memory driver, which will make automated testing without a real CouchDB server easier. Then I will work on completing the 'serve' mode.

You can see a complete overview of the current status on the Compatibility chart

Why the name "Kivik"?

Kivik is a line of sofas (couches) from IKEA. And in the spirit of IKEA, and build-your-own furniture, Kivik aims to allow you to "build your own" CouchDB client, server, and proxy applications.

What license is Kivik released under?

This software is released under the terms of the Apache 2.0 license. See LICENCE.md, or read the full license.

What projects currently use Kivik?

If your project uses Kivik, and you'd like to be added to this list, create an issue or submit a pull request.

  • Cayley is an open-source graph database. It uses Kivik for the CouchDB and PouchDB storage backends.