Documentation ¶
Overview ¶
Package store is an interface for distributed data storage. The design document is located at https://github.com/micro/development/blob/master/design/framework/store.md
Index ¶
- Variables
- func NewContext(ctx context.Context, c Store) context.Context
- type DeleteOption
- type DeleteOptions
- type ExistsOption
- type ExistsOptions
- type ListOption
- type ListOptions
- type NamespaceStore
- func (w *NamespaceStore) Connect(ctx context.Context) error
- func (w *NamespaceStore) Delete(ctx context.Context, key string, opts ...DeleteOption) error
- func (w *NamespaceStore) Disconnect(ctx context.Context) error
- func (w *NamespaceStore) Exists(ctx context.Context, key string, opts ...ExistsOption) error
- func (w *NamespaceStore) Init(opts ...Option) error
- func (w *NamespaceStore) List(ctx context.Context, opts ...ListOption) ([]string, error)
- func (w *NamespaceStore) Name() string
- func (w *NamespaceStore) Options() Options
- func (w *NamespaceStore) Read(ctx context.Context, key string, val interface{}, opts ...ReadOption) error
- func (w *NamespaceStore) String() string
- func (w *NamespaceStore) Write(ctx context.Context, key string, val interface{}, opts ...WriteOption) error
- type Option
- func Addrs(addrs ...string) Option
- func Codec(c codec.Codec) Option
- func Context(ctx context.Context) Option
- func Logger(l logger.Logger) Option
- func Meter(m meter.Meter) Option
- func Name(n string) Option
- func Namespace(ns string) Option
- func SetOption(k, v interface{}) Option
- func TLSConfig(t *tls.Config) Option
- func Tracer(t tracer.Tracer) Option
- type Options
- type ReadOption
- type ReadOptions
- type Store
- type WriteOption
- type WriteOptions
Constants ¶
This section is empty.
Variables ¶
var ( // ErrNotFound is returned when a key doesn't exist ErrNotFound = errors.New("not found") // ErrInvalidKey is returned when a key has empty or have invalid format ErrInvalidKey = errors.New("invalid key") // DefaultStore is the global default store DefaultStore Store = NewStore() )
Functions ¶
Types ¶
type DeleteOption ¶
type DeleteOption func(d *DeleteOptions)
DeleteOption sets values in DeleteOptions
func DeleteContext ¶ added in v3.4.9
func DeleteContext(ctx context.Context) DeleteOption
DeleteContext pass context.Context to delete options
func DeleteNamespace ¶ added in v3.4.9
func DeleteNamespace(ns string) DeleteOption
DeleteNamespace pass namespace to delete options
func SetDeleteOption ¶ added in v3.1.8
func SetDeleteOption(k, v interface{}) DeleteOption
SetDeleteOption returns a function to setup a context with given value
type DeleteOptions ¶
type DeleteOptions struct { // Context holds external options Context context.Context // Namespace holds namespace Namespace string }
DeleteOptions configures an individual Delete operation
func NewDeleteOptions ¶ added in v3.1.0
func NewDeleteOptions(opts ...DeleteOption) DeleteOptions
NewDeleteOptions fills DeleteOptions struct with opts slice
type ExistsOption ¶ added in v3.1.8
type ExistsOption func(*ExistsOptions)
ExistsOption specifies Exists call options
func ExistsContext ¶ added in v3.4.9
func ExistsContext(ctx context.Context) ExistsOption
ExistsContext pass context.Context to exist options
func ExistsNamespace ¶ added in v3.4.9
func ExistsNamespace(ns string) ExistsOption
ExistsNamespace pass namespace to exist options
func SetExistsOption ¶ added in v3.1.8
func SetExistsOption(k, v interface{}) ExistsOption
SetExistsOption returns a function to setup a context with given value
type ExistsOptions ¶ added in v3.1.8
type ExistsOptions struct { // Context holds external options Context context.Context // Namespace contains namespace Namespace string }
ExistsOptions holds options for Exists method
func NewExistsOptions ¶ added in v3.1.8
func NewExistsOptions(opts ...ExistsOption) ExistsOptions
NewExistsOptions helper for Exists method
type ListOption ¶
type ListOption func(l *ListOptions)
ListOption sets values in ListOptions
func ListContext ¶ added in v3.4.9
func ListContext(ctx context.Context) ListOption
ListContext pass context.Context to list options
func ListNamespace ¶ added in v3.4.9
func ListNamespace(ns string) ListOption
ListNamespace pass namespace to list options
func ListPrefix ¶
func ListPrefix(s string) ListOption
ListPrefix returns all keys that are prefixed with key
func ListSuffix ¶
func ListSuffix(s string) ListOption
ListSuffix returns all keys that end with key
func SetListOption ¶ added in v3.1.8
func SetListOption(k, v interface{}) ListOption
SetListOption returns a function to setup a context with given value
type ListOptions ¶
type ListOptions struct { Context context.Context Prefix string Suffix string Namespace string Limit uint Offset uint }
ListOptions configures an individual List operation
func NewListOptions ¶ added in v3.1.0
func NewListOptions(opts ...ListOption) ListOptions
NewListOptions fills ListOptions struct with opts slice
type NamespaceStore ¶ added in v3.4.9
type NamespaceStore struct {
// contains filtered or unexported fields
}
NamespaceStore wrap store with namespace
func (*NamespaceStore) Connect ¶ added in v3.4.9
func (w *NamespaceStore) Connect(ctx context.Context) error
func (*NamespaceStore) Delete ¶ added in v3.4.9
func (w *NamespaceStore) Delete(ctx context.Context, key string, opts ...DeleteOption) error
func (*NamespaceStore) Disconnect ¶ added in v3.4.9
func (w *NamespaceStore) Disconnect(ctx context.Context) error
func (*NamespaceStore) Exists ¶ added in v3.4.9
func (w *NamespaceStore) Exists(ctx context.Context, key string, opts ...ExistsOption) error
func (*NamespaceStore) Init ¶ added in v3.4.9
func (w *NamespaceStore) Init(opts ...Option) error
func (*NamespaceStore) List ¶ added in v3.4.9
func (w *NamespaceStore) List(ctx context.Context, opts ...ListOption) ([]string, error)
func (*NamespaceStore) Name ¶ added in v3.4.9
func (w *NamespaceStore) Name() string
func (*NamespaceStore) Options ¶ added in v3.4.9
func (w *NamespaceStore) Options() Options
func (*NamespaceStore) Read ¶ added in v3.4.9
func (w *NamespaceStore) Read(ctx context.Context, key string, val interface{}, opts ...ReadOption) error
func (*NamespaceStore) String ¶ added in v3.4.9
func (w *NamespaceStore) String() string
func (*NamespaceStore) Write ¶ added in v3.4.9
func (w *NamespaceStore) Write(ctx context.Context, key string, val interface{}, opts ...WriteOption) error
type Option ¶
type Option func(o *Options)
Option sets values in Options
func Addrs ¶ added in v3.4.9
Addrs contains the addresses or other connection information of the backing storage. For example, an etcd implementation would contain the nodes of the cluster. A SQL implementation could contain one or more connection strings.
func SetOption ¶ added in v3.1.0
func SetOption(k, v interface{}) Option
SetOption returns a function to setup a context with given value
type Options ¶
type Options struct { // Meter used for metrics Meter meter.Meter // Tracer used for tracing Tracer tracer.Tracer // Context holds external options Context context.Context // Codec used to marshal/unmarshal Codec codec.Codec // Logger used for logging Logger logger.Logger // TLSConfig holds tls.TLSConfig options TLSConfig *tls.Config // Name specifies store name Name string // Namespace of the records Namespace string // Addrs contains store address Addrs []string }
Options contains configuration for the Store
type ReadOption ¶
type ReadOption func(r *ReadOptions)
ReadOption sets values in ReadOptions
func ReadContext ¶ added in v3.4.9
func ReadContext(ctx context.Context) ReadOption
ReadContext pass context.Context to ReadOptions
func ReadNamespace ¶ added in v3.4.9
func ReadNamespace(ns string) ReadOption
ReadNamespace pass namespace to ReadOptions
func SetReadOption ¶ added in v3.1.8
func SetReadOption(k, v interface{}) ReadOption
SetReadOption returns a function to setup a context with given value
type ReadOptions ¶
type ReadOptions struct { // Context holds external options Context context.Context // Namespace holds namespace Namespace string }
ReadOptions configures an individual Read operation
func NewReadOptions ¶ added in v3.1.0
func NewReadOptions(opts ...ReadOption) ReadOptions
NewReadOptions fills ReadOptions struct with opts slice
type Store ¶
type Store interface { Name() string // Init initialises the store Init(opts ...Option) error // Connect is used when store needs to be connected Connect(ctx context.Context) error // Options allows you to view the current options. Options() Options // Exists check that key exists in store Exists(ctx context.Context, key string, opts ...ExistsOption) error // Read reads a single key name to provided value with optional ReadOptions Read(ctx context.Context, key string, val interface{}, opts ...ReadOption) error // Write writes a value to key name to the store with optional WriteOption Write(ctx context.Context, key string, val interface{}, opts ...WriteOption) error // Delete removes the record with the corresponding key from the store. Delete(ctx context.Context, key string, opts ...DeleteOption) error // List returns any keys that match, or an empty list with no error if none matched. List(ctx context.Context, opts ...ListOption) ([]string, error) // Disconnect the store Disconnect(ctx context.Context) error // String returns the name of the implementation. String() string }
Store is a data storage interface
func FromContext ¶ added in v3.1.0
FromContext get store from context
func NewNamespaceStore ¶ added in v3.4.9
type WriteOption ¶
type WriteOption func(w *WriteOptions)
WriteOption sets values in WriteOptions
func SetWriteOption ¶ added in v3.1.8
func SetWriteOption(k, v interface{}) WriteOption
SetWriteOption returns a function to setup a context with given value
func WriteContext ¶ added in v3.4.9
func WriteContext(ctx context.Context) WriteOption
WriteContext pass context.Context to wirte options
func WriteMetadata ¶ added in v3.1.0
func WriteMetadata(md metadata.Metadata) WriteOption
WriteMetadata add metadata.Metadata
func WriteNamespace ¶ added in v3.4.9
func WriteNamespace(ns string) WriteOption
WriteNamespace pass namespace to write options
type WriteOptions ¶
type WriteOptions struct { // Context holds external options Context context.Context // Metadata contains additional metadata Metadata metadata.Metadata // Namespace holds namespace Namespace string // TTL specifies key TTL TTL time.Duration }
WriteOptions configures an individual Write operation
func NewWriteOptions ¶ added in v3.1.0
func NewWriteOptions(opts ...WriteOption) WriteOptions
NewWriteOptions fills WriteOptions struct with opts slice