README
¶
owl
Go yaml configuration lib,can get config value from yaml file or etcd cluster like viper lib.
Owl also support binary cli, help you store yaml file's content into etcd cluster.
1. Install as cli
# macos
wget https://github.com/gsxhnd/owl/releases/latest/download/owl-darwin-amd64 -O owl
# linux x64
wget https://github.com/gsxhnd/owl/releases/latest/download/owl-linux-amd64 -O owl
# windows x64
wget https://github.com/gsxhnd/owl/releases/latest/download/owl-windows-amd64.exe -O owl.exe
chmod +x /usr/local/bin/owl
## show version
owl version
owl version: 1.5.1
owl commit: 6840df54b9a566acb78b36195fd9e826bb04d6cf
owl tree state: clean
owl build date: 2020-12-29T15:49:14+0800
go version: go1.15.6
go compiler: gc
platform: darwin/amd64
1.1 CLI Usage
NAME:
owl - owl
USAGE:
owl [global options] command [command options] [arguments...]
COMMANDS:
get get value by key
get_keys get keys by prefix
put read file then put value to etcd
delete delete value by key
version show version
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--endpoint value, -e value (default: "http://127.0.0.1:2379")
--help, -h show help (default: false)
2. Add as lib
go get -u github.com/gsxhnd/owl
Putting Values into owl
Reading Config Files
Owl requires minimal configuration so it knows where to look for config files. Owl just supports YAML file.
Examples:
owl.SetConfName("test.yaml")
owl.AddConfPath("./mock/")
err := owl.ReadConf()
if err != nil { // Handle errors reading the config file
panic(fmt.Errorf("Fatal error config file: %s \n", err))
}
Getting Values From
In owl, there are a few ways to get a value depending on the value’s type. The following functions and methods exist:
Get(key string) : interface{}GetBool(key string) : boolGetFloat64(key string) : float64GetInt(key string) : intGetIntSlice(key string) : []intGetString(key string) : stringGetStringMap(key string) : map[string]interface{}GetStringMapString(key string) : map[string]stringGetStringSlice(key string) : []stringGetAll() : map[string]interface{}
Documentation
¶
Index ¶
- Variables
- func AddConfPath(path string)
- func DeleteRemote(key string) error
- func Get(key string) interface{}
- func GetAll() map[string]interface{}
- func GetBool(key string) bool
- func GetFloat64(key string) float64
- func GetInt(key string) int
- func GetInt64(key string) int64
- func GetIntSlice(key string) []int
- func GetRemote(key string) (string, error)
- func GetRemoteKeys(prefix string) ([]string, error)
- func GetString(key string) string
- func GetStringMap(key string) map[string]interface{}
- func GetStringMapString(key string) map[string]string
- func GetStringSlice(key string) []string
- func GetUint(key string) uint
- func PutRemote(key, value string) error
- func ReadConf() error
- func ReadInConf(content []byte) error
- func SetConfName(name string)
- func SetRemoteAddr(addr []string) error
- func Watcher(key string, c chan string)
- type Owl
- func (o *Owl) AddConfPath(path string)
- func (o *Owl) DeleteRemote(key string) error
- func (o *Owl) Get(key string) interface{}
- func (o *Owl) GetAll() map[string]interface{}
- func (o *Owl) GetBool(key string) bool
- func (o *Owl) GetFloat64(key string) float64
- func (o *Owl) GetInt(key string) int
- func (o *Owl) GetInt64(key string) int64
- func (o *Owl) GetIntSlice(key string) []int
- func (o *Owl) GetRemote(key string) (string, error)
- func (o *Owl) GetRemoteKeys(prefix string) ([]string, error)
- func (o *Owl) GetString(key string) string
- func (o *Owl) GetStringMap(key string) map[string]interface{}
- func (o *Owl) GetStringMapString(key string) map[string]string
- func (o *Owl) GetStringSlice(key string) []string
- func (o *Owl) GetUint(key string) uint
- func (o *Owl) PutRemote(key, value string) error
- func (o *Owl) ReadConf() error
- func (o *Owl) ReadInConf(content []byte) error
- func (o *Owl) SetConfName(name string)
- func (o *Owl) SetRemoteAddr(addr []string) error
- func (o *Owl) Watcher(key string, c chan string)
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func AddConfPath ¶
func AddConfPath(path string)
AddConfPath adds a path for owl to search for the config file in.
func Get ¶
func Get(key string) interface{}
Get returns the value associated with the key as interface.
func GetFloat64 ¶
GetFloat64 returns the value associated with the key as float64.
func GetIntSlice ¶
GetIntSlice returns the value associated with the key as int slice.
func GetRemoteKeys ¶
GetRemoteKeys get keys from etcd by prefix
func GetStringMap ¶
GetStringMap returns the value associated with the key as string map.
func GetStringMapString ¶
func GetStringSlice ¶
GetStringSlice returns the value associated with the key as string slice.
func ReadConf ¶
func ReadConf() error
ReadConf will read a configuration file, setting existing keys to nil if the key does not exist in the file.
func ReadInConf ¶
ReadInConf will read a configuration file, setting existing keys to nil if the key does not exist in the file.
func SetConfName ¶
func SetConfName(name string)
Types ¶
type Owl ¶
type Owl struct {
// contains filtered or unexported fields
}
Owl is a lib for get configure value from etcd.
Source Files
Directories