cockroachkv

Documentation

Index

• Variables
• type Client
  • func NewWith(db tagsql.DB, dbURL string) *Client
  • func Open(ctx context.Context, dbURL string, app string) (*Client, error)
  • func (client *Client) Close() error
  • func (client *Client) CompareAndSwap(ctx context.Context, key storage.Key, oldValue, newValue storage.Value) (err error)
  • func (client *Client) Delete(ctx context.Context, key storage.Key) (err error)
  • func (client *Client) DeleteMultiple(ctx context.Context, keys []storage.Key) (items storage.Items, err error)
  • func (client *Client) Get(ctx context.Context, key storage.Key) (_ storage.Value, err error)
  • func (client *Client) GetAll(ctx context.Context, keys storage.Keys) (values storage.Values, err error)
  • func (client *Client) Iterate(ctx context.Context, opts storage.IterateOptions, ...) (err error)
  • func (client *Client) IterateWithoutLookupLimit(ctx context.Context, opts storage.IterateOptions, ...) (err error)
  • func (client *Client) List(ctx context.Context, first storage.Key, limit int) (_ storage.Keys, err error)
  • func (client *Client) LookupLimit() int
  • func (client *Client) MigrateToLatest(ctx context.Context) error
  • func (client *Client) Put(ctx context.Context, key storage.Key, value storage.Value) (err error)
  • func (client *Client) SetLookupLimit(v int)

Variables

var Error = errs.Class("cockroachkv error")

Error is the default postgreskv errs class.

Types

type Client

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

Client is the entrypoint into a cockroachkv data store.

func NewWith

func NewWith(db tagsql.DB, dbURL string) *Client

NewWith instantiates a new cockroachkv client given db.

func Open

func Open(ctx context.Context, dbURL string, app string) (*Client, error)

Open connects a new cockroachkv client given db URL.

func (*Client) Close

func (client *Client) Close() error

Close closes the client.

func (*Client) CompareAndSwap

func (client *Client) CompareAndSwap(ctx context.Context, key storage.Key, oldValue, newValue storage.Value) (err error)

CompareAndSwap atomically compares and swaps oldValue with newValue.

func (*Client) Delete

func (client *Client) Delete(ctx context.Context, key storage.Key) (err error)

Delete deletes the given key and its associated value.

func (*Client) DeleteMultiple

func (client *Client) DeleteMultiple(ctx context.Context, keys []storage.Key) (items storage.Items, err error)

DeleteMultiple deletes keys ignoring missing keys.

func (*Client) Get

func (client *Client) Get(ctx context.Context, key storage.Key) (_ storage.Value, err error)

Get looks up the provided key and returns its value (or an error).

func (*Client) GetAll

func (client *Client) GetAll(ctx context.Context, keys storage.Keys) (values storage.Values, err error)

GetAll finds all values for the provided keys (up to LookupLimit). If more keys are provided than the maximum, an error will be returned.

func (*Client) Iterate

func (client *Client) Iterate(ctx context.Context, opts storage.IterateOptions, fn func(context.Context, storage.Iterator) error) (err error)

Iterate calls the callback with an iterator over the keys.

func (*Client) IterateWithoutLookupLimit

func (client *Client) IterateWithoutLookupLimit(ctx context.Context, opts storage.IterateOptions, fn func(context.Context, storage.Iterator) error) (err error)

IterateWithoutLookupLimit calls the callback with an iterator over the keys, but doesn't enforce default limit on opts.

func (*Client) List

func (client *Client) List(ctx context.Context, first storage.Key, limit int) (_ storage.Keys, err error)

List returns either a list of known keys, in order, or an error.

func (*Client) LookupLimit

func (client *Client) LookupLimit() int

LookupLimit returns the maximum limit that is allowed.

func (*Client) MigrateToLatest

func (client *Client) MigrateToLatest(ctx context.Context) error

MigrateToLatest migrates to latest schema version.

func (*Client) Put

func (client *Client) Put(ctx context.Context, key storage.Key, value storage.Value) (err error)

Put sets the value for the provided key.

func (*Client) SetLookupLimit

func (client *Client) SetLookupLimit(v int)

SetLookupLimit sets the lookup limit.