Documentation ¶
Overview ¶
Package couchdb is a driver for connecting with a CouchDB server over HTTP.
Index ¶
Constants ¶
View Source
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" )
View Source
const ( CompatUnknown = iota CompatCouch16 CompatCouch20 )
Compatibility modes
View Source
const ( VendorCouchDB = "The Apache Software Foundation" VendorCloudant = "IBM Cloudant" )
Known vendor strings
Variables ¶
This section is empty.
Functions ¶
This section is empty.
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 ¶
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.
Source Files ¶
Click to show internal directories.
Click to hide internal directories.