43 lines
1.6 KiB
Go
43 lines
1.6 KiB
Go
// 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
|
|
package store
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
)
|
|
|
|
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()
|
|
)
|
|
|
|
// Store is a data storage interface
|
|
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
|
|
}
|