couchdb

package module

v0.0.0-...-8f6edbe Latest Latest Go to latest Published: May 30, 2023 License: Apache-2.0 Imports: 6 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Client struct {
	// contains filtered or unexported fields
}

Client - Implements a couchDB client

type Connector struct {
	// contains filtered or unexported fields
}

Connector - Implements a CouchDB connector

func NewConnector(addr string, dbName string) (rc *Connector, err error)

NewConnector - Creates and initialize a CouchDB connector to a database

func (dbCon *Connector) AddDoc(docName string, doc []byte) (string, error)

addDoc - Add scenario to DB

func (dbCon *Connector) DeleteAllDocs() error

deleteAllDocs - Remove all documents from DB

func (dbCon *Connector) DeleteDoc(docName string) error

deleteDoc - Remove a document from DB

func (dbCon *Connector) GetDoc(returnNilOnNotFound bool, docName string) (doc []byte, err error)

getDocument - Get document from DB

func (dbCon *Connector) GetDocList() (docNameList []string, docList [][]byte, err error)

getDocList - Get document list from DB

func (dbCon *Connector) UpdateDoc(docName string, doc []byte) (string, error)

updateDoc - Update a document in DB