package
2.0.0-pre2+incompatible
Repository: https://github.com/codeocean/kivik.git
Documentation: pkg.go.dev

# Structs

Attachment represents a file attachment to a document.
BulkGetReference is a reference to a document given in a BulkGet query.
BulkResult is the result of a single doc update in a BulkDocs request.
Change represents the changes to a single document.
ClusterStats contains the cluster configuration for the database.
DBStats contains database statistics.
DBUpdate represents a database update event.
Document represents a single document returned by Get.
Index is a MonboDB-style index definition.
Members represents the members of a database security document.
PurgeResult is the result of a purge request.
QueryPlan is the response of an Explain query.
ReplicationInfo represents a snap-shot state of a replication, as provided by the _active_tasks endpoint.
RevDiff represents a rev diff for a single document, as returned by the RevsDiff method.
Row is a generic view result row.
Security represents a database security document.
Session is a copy of kivik.Session.
Version represents a server version response.

# Interfaces

AttachmentMetaGetter is an optional interface which may be satisfied by a DB.
Attachments is an iterator over the attachments included in a document when Get is called with `include_docs=true`.
Authenticator is an optional interface that may be implemented by a Client that supports authenitcated connections.
Bookmarker is an optional interface that may be implemented by a Rows for returning a paging bookmark.
BulkDocer is an optional interface which may be implemented by a DB to support bulk insert/update operations.
BulkGetter is an optional interface which may be implemented by a driver to support bulk get operations.
BulkResults is an iterator over the results for a BulkDocs call.
Changes is an iterator of the database changes feed.
Client is a connection to a database server.
ClientCloser is an optional interface that may be implemented by a Client to clean up resources when a Client is no longer needed.
ClientReplicator is an optional interface that may be implemented by a Client that supports replication between two database.
Cluster is an optional interface that may be implemented by a Client to support CouchDB cluster configuration operations.
No description provided by the author
Copier is an optional interface that may be implemented by a DB.
DB is a database handle.
DBCloser is an optional interface that may be implemented by a DB to clean up resources when a DB is no longer needed.
DBsStatser is an optional interface, added to support CouchDB 2.2.0's /_dbs_info endpoint.
DBUpdater is an optional interface that may be implemented by a Client to provide access to the DB Updates feed.
DBUpdates is a DBUpdates iterator.
DesignDocer is an optional interface that may be implemented by a DB.
Driver is the interface that must be implemented by a database driver.
Finder is an optional interface which may be implemented by a DB.
Flusher is an optional interface that may be implemented by a DB that can force a flush of the database backend file(s) to disk or other permanent storage.
LocalDocer is an optional interface that may be implemented by a DB.
MetaGetter is an optional interface that may be implemented by a DB.
Pinger is an optional interface that may be implemented by a Client.
Purger is an optional interface which may be implemented by a DB to support document purging.
Replication represents a _replicator document.
RevsDiffer is an optional interface that may be implemented by a DB.
Rows is an iterator over a view's results.
RowsWarner is an optional interface that may be implemented by a Rows, which allows a rows iterator to return a non-fatal warning.
Sessioner is an optional interface that a Client may satisfy to provide access to the authenticated session information.

# Type aliases

ChangedRevs represents a "changes" field of a result in the /_changes stream.
Config represents all the config sections.
ConfigSection represents all key/value pairs for a section of configuration.