Etcd
A Etcd storage driver using etcd-io/etcd
.
Table of Contents
Signatures
func New(config ...Config) *Storage
func (s *Storage) Get(key string) ([]byte, error)
func (s *Storage) Set(key string, val []byte, exp time.Duration) error
func (s *Storage) Delete(key string) error
func (s *Storage) Reset() error
func (s *Storage) Close() error
func (s *Storage) Conn() *clientv3.Client
Installation
Etcd is tested on the 2 last Go versions with support for modules. So make sure to initialize one first if you didn't do that yet:
go mod init github.com/<user>/<repo>
And then install the etcd implementation:
go get github.com/gofiber/storage/etcd
Examples
Import the storage package.
import "github.com/gofiber/storage/etcd"
You can use the following possibilities to create a storage:
// Initialize default config
store := etcd.New()
// Initialize custom config
store := etcd.New(Config{
Endpoints: []string{"localhost:2379"},
})
Config
type Config struct {
// Endpoints is a list of URLs.
Endpoints []string
// DialTimeout is the timeout for failing to establish a connection.
DialTimeout time.Duration
// Username is a username for authentication.
Username string
// Password is a password for authentication.
Password string
// TLS holds the client secure credentials, if any.
TLS *tls.Config
}
Default Config
var ConfigDefault = Config{
Endpoints: []string{"localhost:2379"},
DialTimeout: 2 * time.Second,
Username: "",
Password: "",
TLS: nil,
}