etcd

README

etcd

A helper ETCD Client designed for use within Loophole Labs projects

Documentation

Index

• Constants
• Variables
• type ETCD
  • func New(options *Options, loader loader.Loader, zapLogger *zap.Logger, ...) (*ETCD, error)
  • func (e *ETCD) Close() error
  • func (e *ETCD) Delete(ctx context.Context, key string) (*clientv3.DeleteResponse, error)
  • func (e *ETCD) Get(ctx context.Context, key string) (*clientv3.GetResponse, error)
  • func (e *ETCD) GetBatch(ctx context.Context, keys ...string) (*clientv3.TxnResponse, error)
  • func (e *ETCD) GetLimit(ctx context.Context, key string, limit int64) (*clientv3.GetResponse, error)
  • func (e *ETCD) GetPrefix(ctx context.Context, prefix string) (*clientv3.GetResponse, error)
  • func (e *ETCD) Set(ctx context.Context, key string, value string) (*clientv3.PutResponse, error)
  • func (e *ETCD) SetDelete(ctx context.Context, key string, value string, delete string) error
  • func (e *ETCD) SetExpiry(ctx context.Context, key string, value string, ttl time.Duration) (*clientv3.PutResponse, error)
  • func (e *ETCD) SetIfNotExist(ctx context.Context, key string, value string) (*clientv3.TxnResponse, error)
  • func (e *ETCD) SetIfNotExistExpiry(ctx context.Context, key string, value string, ttl time.Duration) (*clientv3.TxnResponse, error)
  • func (e *ETCD) SetKeepAlive(ctx context.Context, key string, value string) (*clientv3.PutResponse, error)
  • func (e *ETCD) Watch(ctx context.Context, key string) clientv3.WatchChan
  • func (e *ETCD) WatchPrefix(ctx context.Context, prefix string) clientv3.WatchChan
• type Options

Constants

const (
	DefaultTTL = 10
)

Variables

var (
	ErrDisabled            = errors.New("etcd is disabled")
	ErrSetDelete           = errors.New("set-delete failed")
	ErrSetIfNotExist       = errors.New("set-if-not-exists failed")
	ErrInvalidBatchRequest = errors.New("invalid batch request")
	ErrBatchRequestFailed  = errors.New("batch request failed")
)

Types

type ETCD

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

ETCD is a wrapper for the etcd client

func New

func New(options *Options, loader loader.Loader, zapLogger *zap.Logger, logger *zerolog.Logger) (*ETCD, error)

func (*ETCD) Close

func (e *ETCD) Close() error

func (*ETCD) Delete

func (e *ETCD) Delete(ctx context.Context, key string) (*clientv3.DeleteResponse, error)

func (*ETCD) Get

func (e *ETCD) Get(ctx context.Context, key string) (*clientv3.GetResponse, error)

func (*ETCD) GetBatch

func (e *ETCD) GetBatch(ctx context.Context, keys ...string) (*clientv3.TxnResponse, error)

func (*ETCD) GetLimit

func (e *ETCD) GetLimit(ctx context.Context, key string, limit int64) (*clientv3.GetResponse, error)

func (*ETCD) GetPrefix

func (e *ETCD) GetPrefix(ctx context.Context, prefix string) (*clientv3.GetResponse, error)

func (*ETCD) Set

func (e *ETCD) Set(ctx context.Context, key string, value string) (*clientv3.PutResponse, error)

func (*ETCD) SetDelete

func (e *ETCD) SetDelete(ctx context.Context, key string, value string, delete string) error

func (*ETCD) SetExpiry

func (e *ETCD) SetExpiry(ctx context.Context, key string, value string, ttl time.Duration) (*clientv3.PutResponse, error)

func (*ETCD) SetIfNotExist

func (e *ETCD) SetIfNotExist(ctx context.Context, key string, value string) (*clientv3.TxnResponse, error)

func (*ETCD) SetIfNotExistExpiry

func (e *ETCD) SetIfNotExistExpiry(ctx context.Context, key string, value string, ttl time.Duration) (*clientv3.TxnResponse, error)

func (*ETCD) SetKeepAlive

func (e *ETCD) SetKeepAlive(ctx context.Context, key string, value string) (*clientv3.PutResponse, error)

func (*ETCD) Watch

func (e *ETCD) Watch(ctx context.Context, key string) clientv3.WatchChan

func (*ETCD) WatchPrefix

func (e *ETCD) WatchPrefix(ctx context.Context, prefix string) clientv3.WatchChan

type Options

type Options struct {
	LogName     string
	Disabled    bool
	SrvDomain   string
	ServiceName string
}