consul

Documentation

Index

• type Backend
  • func NewBackend(client *api.Client, opts ...Option) *Backend
  • func (b *Backend) Get(ctx context.Context, key string) ([]byte, error)
  • func (b *Backend) Name() string
• type Option
  • func WithPrefetch() Option
  • func WithPrefix(prefix string) Option

Types

type Backend

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

Backend loads keys from Consul.

func NewBackend

func NewBackend(client *api.Client, opts ...Option) *Backend

NewBackend creates a configuration loader that loads from Consul.

func (*Backend) Get

func (b *Backend) Get(ctx context.Context, key string) ([]byte, error)

Get loads the given key from Consul.

func (*Backend) Name

func (b *Backend) Name() string

Name returns the name of the backend.

type Option

type Option func(*Backend)

Option is used to configure the Consul backend.

func WithPrefetch

func WithPrefetch() Option

WithPrefetch is used to prefetch the entire tree and cache it to avoid further round trips. If the WithPrefix option is used, will fetch the tree under the specified prefix.

func WithPrefix

func WithPrefix(prefix string) Option

WithPrefix is used to specify the prefix to prepend on every keys.