consul

Documentation

Overview

Package consul contains an implementation of the `gokv.Store` interface for Consul.

Index

• Variables
• type Client
  • func NewClient(options Options) (Client, error)
  • func (c Client) Close() error
  • func (c Client) Delete(k string) error
  • func (c Client) Get(k string, v any) (found bool, err error)
  • func (c Client) Set(k string, v any) error
• type Options

Variables

var DefaultOptions = Options{
	Scheme:  "http",
	Address: "127.0.0.1:8500",
	Codec:   encoding.JSON,
}

DefaultOptions is an Options object with default values. Scheme: "http", Address: "127.0.0.1:8500", Folder: none, Codec: encoding.JSON

Types

type Client

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

Client is a gokv.Store implementation for Consul.

func NewClient

func NewClient(options Options) (Client, error)

NewClient creates a new Consul client.

func (Client) Close

func (c Client) Close() error

Close closes the client. In the Consul implementation this doesn't have any effect.

func (Client) Delete

func (c Client) Delete(k string) error

Delete deletes the stored value for the given key. Deleting a non-existing key-value pair does NOT lead to an error. The key must not be "".

func (Client) Get

func (c Client) Get(k string, v any) (found bool, err error)

Get retrieves the stored value for the given key. You need to pass a pointer to the value, so in case of a struct the automatic unmarshalling can populate the fields of the object that v points to with the values of the retrieved object's values. If no value is found it returns (false, nil). The key must not be "" and the pointer must not be nil.

func (Client) Set

func (c Client) Set(k string, v any) error

Set stores the given value for the given key. Values are automatically marshalled to JSON or gob (depending on the configuration). The key must not be "" and the value must not be nil.

type Options

type Options struct {
	// URI scheme for the Consul server.
	// Optional ("http" by default).
	Scheme string
	// Address of the Consul server, including port number.
	// Optional ("127.0.0.1:8500" by default).
	Address string
	// Directory under which to store the key-value pairs.
	// The Consul UI calls this "folder".
	// Optional (none by default).
	Folder string
	// Encoding format.
	// Optional (encoding.JSON by default).
	Codec encoding.Codec
}

Options are the options for the Consul client.