kivik

package module

Go to main page

Versions in this module

v3

v3.2.4

Mar 30, 2023

v3.2.3

Dec 2, 2020

v3.2.2

Nov 28, 2020

v3.2.1

Nov 27, 2020

v3.2.0

Jul 10, 2020

Changes in this version

type Client

+ func (c *Client) Membership(ctx context.Context) (*ClusterMembership, error)

+ type ClusterMembership struct

+ AllNodes []string

+ ClusterNodes []string

v3.1.2

May 2, 2020

v3.1.1

May 2, 2020

v3.1.0

May 2, 2020

Changes in this version

type BulkResults

+ func (i BulkResults) EOQ() bool

type Changes

+ func (i Changes) EOQ() bool

type DB

+ func (db *DB) PartitionStats(ctx context.Context, name string) (*PartitionStats, error)

type DBUpdates

+ func (i DBUpdates) EOQ() bool

+ type PartitionStats struct

+ ActiveSize int64

+ DBName string

+ DeletedDocCount int64

+ DocCount int64

+ ExternalSize int64

+ Partition string

+ RawResponse json.RawMessage

type Rows

+ func (i Rows) EOQ() bool

+ func (r *Rows) QueryIndex() int

v3.0.3

May 1, 2020

v3.0.2

Mar 1, 2020

v3.0.1

Feb 29, 2020

v3.0.0

Feb 16, 2020

Changes in this version

+ const EndKeySuffix

+ const KivikVendor

+ const KivikVersion

+ const SessionCookieName

+ const UserPrefix

+ func Register(name string, driver driver.Driver)

+ func StatusCode(err error) int

+ type Attachment struct

+ Content io.ReadCloser

+ ContentEncoding string

+ ContentType string

+ Digest string

+ EncodedLength int64

+ Filename string

+ Follows bool

+ RevPos int64

+ Size int64

+ Stub bool

+ func (a *Attachment) MarshalJSON() ([]byte, error)

+ func (a *Attachment) UnmarshalJSON(data []byte) error

+ type Attachments map[string]*Attachment

+ func (a *Attachments) Delete(filename string)

+ func (a *Attachments) Get(filename string) *Attachment

+ func (a *Attachments) Set(filename string, att *Attachment)

+ func (a *Attachments) UnmarshalJSON(data []byte) error

+ type AttachmentsIterator struct

+ func (i *AttachmentsIterator) Next() (*Attachment, error)

+ type BulkGetReference struct

+ AttsSince string

+ ID string

+ Rev string

+ type BulkResults struct

+ func (r *BulkResults) Close() error

+ func (r *BulkResults) Err() error

+ func (r *BulkResults) ID() string

+ func (r *BulkResults) Next() bool

+ func (r *BulkResults) Rev() string

+ func (r *BulkResults) UpdateErr() error

+ type Changes struct

+ func (c *Changes) Changes() []string

+ func (c *Changes) Close() error

+ func (c *Changes) Deleted() bool

+ func (c *Changes) ETag() string

+ func (c *Changes) Err() error

+ func (c *Changes) ID() string

+ func (c *Changes) LastSeq() string

+ func (c *Changes) Next() bool

+ func (c *Changes) Pending() int64

+ func (c *Changes) ScanDoc(dest interface{}) error

+ func (c *Changes) Seq() string

+ type Client struct

+ func New(driverName, dataSourceName string) (*Client, error)

+ func (c *Client) AllDBs(ctx context.Context, options ...Options) ([]string, error)

+ func (c *Client) Authenticate(ctx context.Context, a interface{}) error

+ func (c *Client) Close(ctx context.Context) error

+ func (c *Client) ClusterSetup(ctx context.Context, action interface{}) error

+ func (c *Client) ClusterStatus(ctx context.Context, options ...Options) (string, error)

+ func (c *Client) Config(ctx context.Context, node string) (Config, error)

+ func (c *Client) ConfigSection(ctx context.Context, node, section string) (ConfigSection, error)

+ func (c *Client) ConfigValue(ctx context.Context, node, section, key string) (string, error)

+ func (c *Client) CreateDB(ctx context.Context, dbName string, options ...Options) error

+ func (c *Client) DB(ctx context.Context, dbName string, options ...Options) *DB

+ func (c *Client) DBExists(ctx context.Context, dbName string, options ...Options) (bool, error)

+ func (c *Client) DBUpdates(ctx context.Context) (*DBUpdates, error)

+ func (c *Client) DBsStats(ctx context.Context, dbnames []string) ([]*DBStats, error)

+ func (c *Client) DSN() string

+ func (c *Client) DeleteConfigKey(ctx context.Context, node, section, key string) (string, error)

+ func (c *Client) DestroyDB(ctx context.Context, dbName string, options ...Options) error

+ func (c *Client) Driver() string

+ func (c *Client) GetReplications(ctx context.Context, options ...Options) ([]*Replication, error)

+ func (c *Client) Ping(ctx context.Context) (bool, error)

+ func (c *Client) Replicate(ctx context.Context, targetDSN, sourceDSN string, options ...Options) (*Replication, error)

+ func (c *Client) Session(ctx context.Context) (*Session, error)

+ func (c *Client) SetConfigValue(ctx context.Context, node, section, key, value string) (string, error)

+ func (c *Client) Version(ctx context.Context) (*Version, error)

+ type ClusterConfig struct

+ ReadQuorum int

+ Replicas int

+ Shards int

+ WriteQuorum int

+ type Config map[string]ConfigSection

+ type ConfigSection map[string]string

+ type DB struct

+ func (db *DB) AllDocs(ctx context.Context, options ...Options) (*Rows, error)

+ func (db *DB) BulkDocs(ctx context.Context, docs []interface{}, options ...Options) (*BulkResults, error)

+ func (db *DB) BulkGet(ctx context.Context, docs []BulkGetReference, options ...Options) (*Rows, error)

+ func (db *DB) Changes(ctx context.Context, options ...Options) (*Changes, error)

+ func (db *DB) Client() *Client

+ func (db *DB) Close(ctx context.Context) error

+ func (db *DB) Compact(ctx context.Context) error

+ func (db *DB) CompactView(ctx context.Context, ddocID string) error

+ func (db *DB) Copy(ctx context.Context, targetID, sourceID string, options ...Options) (targetRev string, err error)

+ func (db *DB) CreateDoc(ctx context.Context, doc interface{}, options ...Options) (docID, rev string, err error)

+ func (db *DB) CreateIndex(ctx context.Context, ddoc, name string, index interface{}) error

+ func (db *DB) Delete(ctx context.Context, docID, rev string, options ...Options) (newRev string, err error)

+ func (db *DB) DeleteAttachment(ctx context.Context, docID, rev, filename string, options ...Options) (newRev string, err error)

+ func (db *DB) DeleteIndex(ctx context.Context, ddoc, name string) error

+ func (db *DB) DesignDocs(ctx context.Context, options ...Options) (*Rows, error)

+ func (db *DB) Err() error

+ func (db *DB) Explain(ctx context.Context, query interface{}) (*QueryPlan, error)

+ func (db *DB) Find(ctx context.Context, query interface{}) (*Rows, error)

+ func (db *DB) Flush(ctx context.Context) error

+ func (db *DB) Get(ctx context.Context, docID string, options ...Options) *Row

+ func (db *DB) GetAttachment(ctx context.Context, docID, filename string, options ...Options) (*Attachment, error)

+ func (db *DB) GetAttachmentMeta(ctx context.Context, docID, filename string, options ...Options) (*Attachment, error)

+ func (db *DB) GetIndexes(ctx context.Context) ([]Index, error)

+ func (db *DB) GetMeta(ctx context.Context, docID string, options ...Options) (size int64, rev string, err error)

+ func (db *DB) LocalDocs(ctx context.Context, options ...Options) (*Rows, error)

+ func (db *DB) Name() string

+ func (db *DB) Purge(ctx context.Context, docRevMap map[string][]string) (*PurgeResult, error)

+ func (db *DB) Put(ctx context.Context, docID string, doc interface{}, options ...Options) (rev string, err error)

+ func (db *DB) PutAttachment(ctx context.Context, docID, rev string, att *Attachment, options ...Options) (newRev string, err error)

+ func (db *DB) Query(ctx context.Context, ddoc, view string, options ...Options) (*Rows, error)

+ func (db *DB) RevsDiff(ctx context.Context, revMap interface{}) (*Rows, error)

+ func (db *DB) Security(ctx context.Context) (*Security, error)

+ func (db *DB) SetSecurity(ctx context.Context, security *Security) error

+ func (db *DB) Stats(ctx context.Context) (*DBStats, error)

+ func (db *DB) ViewCleanup(ctx context.Context) error

+ type DBStats struct

+ ActiveSize int64

+ Cluster *ClusterConfig

+ CompactRunning bool

+ DeletedCount int64

+ DiskSize int64

+ DocCount int64

+ ExternalSize int64

+ Name string

+ RawResponse json.RawMessage

+ UpdateSeq string

+ type DBUpdates struct

+ func (f *DBUpdates) Close() error

+ func (f *DBUpdates) DBName() string

+ func (f *DBUpdates) Err() error

+ func (f *DBUpdates) Next() bool

+ func (f *DBUpdates) Seq() string

+ func (f *DBUpdates) Type() string

+ type Diffs map[string]RevDiff

+ type Error struct

+ Err error

+ FromServer bool

+ HTTPStatus int

+ Message string

+ func (e *Error) Cause() error

+ func (e *Error) Error() string

+ func (e *Error) Format(f fmt.State, c rune)

+ func (e *Error) FormatError(p printer) error

+ func (e *Error) StatusCode() int

+ func (e *Error) Unwrap() error

+ type Index struct

+ Definition interface{}

+ DesignDoc string

+ Name string

+ Type string

+ type Members struct

+ Names []string

+ Roles []string

+ type Options map[string]interface

+ type PurgeResult struct

+ Purged map[string][]string

+ Seq int64

+ type QueryPlan struct

+ DBName string

+ Fields []interface{}

+ Index map[string]interface{}

+ Limit int64

+ Options map[string]interface{}

+ Range map[string]interface{}

+ Selector map[string]interface{}

+ Skip int64

+ type Replication struct

+ Source string

+ Target string

+ func (r *Replication) Delete(ctx context.Context) error

+ func (r *Replication) DocWriteFailures() int64

+ func (r *Replication) DocsRead() int64

+ func (r *Replication) DocsWritten() int64

+ func (r *Replication) EndTime() time.Time

+ func (r *Replication) Err() error

+ func (r *Replication) IsActive() bool

+ func (r *Replication) Progress() float64

+ func (r *Replication) ReplicationID() string

+ func (r *Replication) StartTime() time.Time

+ func (r *Replication) State() ReplicationState

+ func (r *Replication) Update(ctx context.Context) error

+ type ReplicationInfo struct

+ DocWriteFailures int64

+ DocsRead int64

+ DocsWritten int64

+ Progress float64

+ type ReplicationState string

+ const ReplicationComplete

+ const ReplicationCrashing

+ const ReplicationError

+ const ReplicationFailed

+ const ReplicationInitializing

+ const ReplicationNotStarted

+ const ReplicationPending

+ const ReplicationRunning

+ const ReplicationStarted

+ type RevDiff struct

+ Missing []string

+ PossibleAncestors []string

+ type Row struct

+ Attachments *AttachmentsIterator

+ Body io.ReadCloser

+ ContentLength int64

+ Err error

+ Rev string

+ func (r *Row) ScanDoc(dest interface{}) error

+ type Rows struct

+ func (r *Rows) Bookmark() string

+ func (r *Rows) Close() error

+ func (r *Rows) Err() error

+ func (r *Rows) ID() string

+ func (r *Rows) Key() string

+ func (r *Rows) Next() bool

+ func (r *Rows) Offset() int64

+ func (r *Rows) ScanDoc(dest interface{}) error

+ func (r *Rows) ScanKey(dest interface{}) error

+ func (r *Rows) ScanValue(dest interface{}) error

+ func (r *Rows) TotalRows() int64

+ func (r *Rows) UpdateSeq() string

+ func (r *Rows) Warning() string

+ type Security struct

+ Admins Members

+ Members Members

+ type Session struct

+ AuthenticationDB string

+ AuthenticationHandlers []string

+ AuthenticationMethod string

+ Name string

+ RawResponse json.RawMessage

+ Roles []string

+ type Version struct

+ Features []string

+ RawResponse json.RawMessage

+ Vendor string

+ Version string

v3.0.0-pre1

Feb 9, 2020

Other modules containing this package

github.com/go-kivik/kivik

github.com/go-kivik/kivik/v4

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL