couchdb

Documentation

Overview

Package couchdb is a driver for connecting with a CouchDB server over HTTP. This version of the package is deprecated, and no longer receiving updates. Please use github.com/go-kivik/couchdb instead.

Index

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

Constants

const (
	CompatUnknown = iota
	CompatCouch16
	CompatCouch20
)

Compatibility modes

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

Known vendor strings

Types

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.