# README
Kivik CouchDB
CouchDB driver for Kivik.
Usage
This package provides an implementation of the
github.com/go-kivik/kivik/v3/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"
kivik "github.com/go-kivik/kivik/v3"
_ "github.com/go-kivik/couchdb/v3" // The CouchDB driver
)
func main() {
client, err := kivik.New(context.TODO(), "couch", "")
// ...
}
License
This software is released under the terms of the Apache 2.0 license. See LICENCE.md, or read the full license.
# Functions
BasicAuth provides support for HTTP Basic authentication.
CookieAuth provides support for CouchDB cookie-based authentication.
JWTAuth provides support for CouchDB JWT-based authentication.
NewAttachment is a convenience function, which sets the size of the attachment based on content.
ProxyAuth provides support for Proxy authentication.
SetCookie adds cookie to all outbound requests.
SetTransport returns an authenticator that can be used to set a client connection's HTTP Transport.
# Constants
Couch1ConfigNode can be passed to any of the Config-related methods as the node name, to query the /_config endpoint in a CouchDB 1.x-compatible way.
NoMultipartGet instructs the Get() method not to use CouchDB's ability to download attachments with the multipart/related media type.
NoMultipartPut instructs the Put() method not to use CouchDB's multipart/related upload capabilities.
OptionFullCommit is the option key used to set the `X-Couch-Full-Commit` header in the request when set to true.
OptionIfNoneMatch is an option key to set the If-None-Match header on the request.
OptionPartition instructs supporting methods to limit the query to the specified partition.
Known vendor strings.
Known vendor strings.
Version is the current version of this package.
# Structs
BulkGetError represents an error for a single document returned by a GetBulk call.
Couch represents the parent driver instance.
# Interfaces
Authenticator is a CouchDB authenticator.