couchdb

Documentation

Overview

Package couchdb provides support for access the database.

Index

• func Open(cfg Config) (*kivik.Client, error)
• func StatusCheck(ctx context.Context, db *kivik.Client) error
• type Config

Functions

func Open

func Open(cfg Config) (*kivik.Client, error)

Open knows how to open a database connection based on the configuration.

func StatusCheck

func StatusCheck(ctx context.Context, db *kivik.Client) error

StatusCheck returns nil if it can successfully talk to the database. It returns a non-nil error otherwise.

Types

type Config

type Config struct {
	Protocol string
	User     string
	Password string
	Host     string
}

Config is the required properties to use the database.