couchdb

README

Kivik CouchDB

CouchDB driver for Kivik.

Usage

This package provides an implementation of the github.com/flimzy/kivik/driver interface. You must import the driver and can then use the full Kivik API. Please consult the Kivik wiki for complete documentation and coding examples.

package main

import (
    "context"

    "github.com/flimzy/kivik"
    _ "github.com/go-kivik/couchdb" // The CouchDB driver
)

func main() {
    client, err := kivik.New(context.TODO(), "pouch", "")
    // ...
}

License

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

Documentation

Overview

Package couchdb is a driver for connecting with a CouchDB server over HTTP.

Index

• Constants
• type Authenticator
  • func SetTransport(t http.RoundTripper) Authenticator
• type CompatMode
• type Couch
  • func (d *Couch) NewClient(ctx context.Context, dsn string) (driver.Client, error)

Constants

const (
	// OptionFullCommit is the option key used to set the `X-Couch-Full-Commit`
	// header in the request when set to true.
	//
	// Example:
	//
	//    db.Put(ctx, "doc_id", doc, kivik.Options{couchdb.OptionFullCommit: true})
	OptionFullCommit = "X-Couch-Full-Commit"

	// OptionIfNoneMatch sets the If-None-Match header on the request.
	//
	// Example:
	//
	//    row, err := db.Get(ctx, "doc_id", kivik.Options(couchdb.OptionIfNoneMatch: "1-xxx"))
	OptionIfNoneMatch = "If-None-Match"
)

const (
	CompatUnknown = iota
	CompatCouch16
	CompatCouch20
)

Compatibility modes

const (
	VendorCouchDB  = "The Apache Software Foundation"
	VendorCloudant = "IBM Cloudant"
)

Known vendor strings

Types

type Authenticator

type Authenticator interface {
	// contains filtered or unexported methods
}

Authenticator is a CouchDB authenticator.

func SetTransport

func SetTransport(t http.RoundTripper) Authenticator

SetTransport returns an authenticator that can be used to set a client connection's HTTP Transport. This can be used to control proxies, TLS configuration, keep-alives, compression, etc.

Example:

setXport := couchdb.SetTransport(&http.Transport{
    // .. custom config
})
client, _ := kivik.New( ... )
client.Authenticate(setXport)

type CompatMode

type CompatMode int

CompatMode is a flag indicating the compatibility mode of the driver.

type Couch

type Couch struct{}

Couch represents the parent driver instance.

func (*Couch) NewClient

func (d *Couch) NewClient(ctx context.Context, dsn string) (driver.Client, error)

NewClient establishes a new connection to a CouchDB server instance. If auth credentials are included in the URL, they are used to authenticate using CookieAuth (or BasicAuth if compiled with GopherJS). If you wish to use a different auth mechanism, do not specify credentials here, and instead call Authenticate() later.