etcd

Documentation

Index

• Variables
• func FromEtcdError(err error) error
• type Config
• type ListPagedContinuation
• type ListPagedResp
• type Store
  • func New(cfg Config) (*Store, error)
  • func (s *Store) AtomicDelete(ctx context.Context, key string, revision int64) (*etcdclientv3.TxnResponse, error)
  • func (s *Store) AtomicPut(ctx context.Context, key string, value []byte, prevRevision int64, ...) (*etcdclientv3.TxnResponse, error)
  • func (s *Store) Client() *etcdclientv3.Client
  • func (s *Store) Close() error
  • func (s *Store) Delete(ctx context.Context, key string) error
  • func (s *Store) DeletePrefix(ctx context.Context, prefix string) error
  • func (s *Store) Get(ctx context.Context, key string, revision int64) (*etcdclientv3.GetResponse, error)
  • func (s *Store) List(ctx context.Context, directory, start string, revision int64) (*etcdclientv3.GetResponse, error)
  • func (s *Store) ListPaged(ctx context.Context, directory string, revision, limit int64, ...) (*ListPagedResp, error)
  • func (s *Store) Put(ctx context.Context, key string, value []byte, options *WriteOptions) (*etcdclientv3.PutResponse, error)
  • func (s *Store) Watch(ctx context.Context, prefix string, revision int64) etcdclientv3.WatchChan
  • func (s *Store) WatchKey(ctx context.Context, prefix string, revision int64) etcdclientv3.WatchChan
• type WriteOptions

Variables

var (
	// ErrKeyNotFound is thrown when the key is not found in the store during a Get operation
	ErrKeyNotFound = errors.New("key not found")
	ErrKeyModified = errors.New("unable to complete atomic operation, key modified")
)

Functions

func FromEtcdError

func FromEtcdError(err error) error

Types

type Config

type Config struct {
	Logger        *zap.Logger
	Endpoints     string
	Prefix        string
	CertFile      string
	KeyFile       string
	CAFile        string
	SkipTLSVerify bool

	CompactionInterval time.Duration
}

type ListPagedContinuation

type ListPagedContinuation struct {
	Revision int64
	LastKey  string
}

type ListPagedResp

type ListPagedResp struct {
	Resp         *clientv3.GetResponse
	HasMore      bool
	Continuation *ListPagedContinuation
}

type Store

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

func New

func New(cfg Config) (*Store, error)

func (*Store) AtomicDelete

func (s *Store) AtomicDelete(ctx context.Context, key string, revision int64) (*etcdclientv3.TxnResponse, error)

func (*Store) AtomicPut

func (s *Store) AtomicPut(ctx context.Context, key string, value []byte, prevRevision int64, options *WriteOptions) (*etcdclientv3.TxnResponse, error)

func (*Store) Client

func (s *Store) Client() *etcdclientv3.Client

func (*Store) Close

func (s *Store) Close() error

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, key string) error

func (*Store) DeletePrefix

func (s *Store) DeletePrefix(ctx context.Context, prefix string) error

func (*Store) Get

func (s *Store) Get(ctx context.Context, key string, revision int64) (*etcdclientv3.GetResponse, error)

func (*Store) List

func (s *Store) List(ctx context.Context, directory, start string, revision int64) (*etcdclientv3.GetResponse, error)

func (*Store) ListPaged

func (s *Store) ListPaged(ctx context.Context, directory string, revision, limit int64, continuation *ListPagedContinuation) (*ListPagedResp, error)

func (*Store) Put

func (s *Store) Put(ctx context.Context, key string, value []byte, options *WriteOptions) (*etcdclientv3.PutResponse, error)

func (*Store) Watch

func (s *Store) Watch(ctx context.Context, prefix string, revision int64) etcdclientv3.WatchChan

func (*Store) WatchKey

func (s *Store) WatchKey(ctx context.Context, prefix string, revision int64) etcdclientv3.WatchChan

type WriteOptions

type WriteOptions struct {
	TTL time.Duration
}