README
¶
consul-kv
A consul key/value tool for golang
Usage
New Config
conf := NewConfig()
With Options
conf := NewConfig(
WithPrefix(prefix), // consul kv prefix
WithAddress(address), // consul address
WithAuth(username, password), // cosul auth
WithToken(token), // cousl token
WithLoger(loger), // loger
)
Init
if err := conf.Init();err !=nil {
return err
}
Put
if err := conf.Put(key, value);err !=nil {
return err
}
Delete
if err := conf.Delete(key);err !=nil {
return err
}
Get
// scan
if err := conf.Get(key).Scan(x);err !=nil {
return err
}
// get float
float := conf.Get(key).Float()
// get float with default
float := conf.Get(key).Float(defaultFloat)
// get int
i := conf.Get(key).Int()
// get int with default
i := conf.Get(key).Int(defaultInt)
// get uint
uInt := conf.Get(key).Uint()
// get uint with default
uInt := conf.Get(key).Uint(defaultUint)
// get bool
b := conf.Get(key).Bool()
// get bool with default
b := conf.Get(key).Bool(defaultBool)
// get []byte
bytes := conf.Get(key).Bytes()
// get uint with default
bytes := conf.Get(key).bytes(defaultBytes)
// get string
str := conf.Get(key).String()
// get string with default
str := conf.Get(key).String(defaultStr)
// get time
t := conf.Get(key).Time()
// get time with default
t := conf.Get(key).Time(defaultTime)
// get nested key values
conf.Get(key).Get(nextKey1).Get(nextKey2).String()
Watch
conf.Watch(path, func(r *Result){
r.Scan(x)
})
Stop Watch
// stop single watcher
conf.StopWatch(path)
// stop multiple watcher
conf.StopWatch(path1, path2)
// stop all watcher
conf.StopWatch()
Next Features:
- Distributed lock
- Transaction
Documentation
¶
Index ¶
- Variables
- func Delete(path string) error
- func Init(opts ...Option) error
- func Put(path string, value any) error
- func SetOptions(opts ...Option) error
- func StopWatch(path ...string)
- func Watch(path string, handler func(*Result)) error
- type Config
- func (c *Config) CheckWatcher(path string) error
- func (c *Config) Delete(path string) error
- func (c *Config) Get(keys ...string) (ret *Result)
- func (c *Config) Init() error
- func (c *Config) Put(path string, value any) error
- func (c *Config) StopWatch(path ...string)
- func (c *Config) Watch(path string, handler func(*Result)) error
- type Logger
- type Option
- type Result
- func (r *Result) Bool(defaultValue ...bool) bool
- func (r *Result) Bytes(defaultValue ...[]byte) []byte
- func (r *Result) Err() error
- func (r *Result) Float(defaultValue ...float64) float64
- func (r *Result) Get(path string) *Result
- func (r *Result) Int(defaultValue ...int64) int64
- func (r *Result) Key() string
- func (r *Result) Scan(x any) error
- func (r *Result) String(defaultValue ...string) string
- func (r *Result) Time(defaultValue ...time.Time) time.Time
- func (r *Result) Uint(defaultValue ...uint64) uint64
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrAlreadyWatch = errors.New("watch path already exist") ErrKeyNotFound = errors.New("key not found") )
Error defined
Functions ¶
Types ¶
type Logger ¶ added in v1.2.0
type Logger interface {
Info(msg string, args ...any)
Warn(msg string, args ...any)
Error(msg string, args ...any)
}
Logger ...
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.