README
¶
#Config
Config is a Go package to manage yaml configuration files.
For usage information, read our package documentation: http://godoc.org/github.com/tsuru/config.
Documentation
¶
Overview ¶
Package config provide configuration facilities, handling configuration files in yaml format.
Index ¶
- func Bytes() ([]byte, error)
- func Check(checkers []Checker) error
- func Get(key string) (interface{}, error)
- func GetBool(key string) (bool, error)
- func GetDuration(key string) (time.Duration, error)
- func GetFloat(key string) (float64, error)
- func GetInt(key string) (int, error)
- func GetList(key string) ([]string, error)
- func GetString(key string) (string, error)
- func GetUint(key string) (uint, error)
- func ReadAndWatchConfigFile(filePath string) error
- func ReadConfigBytes(data []byte) error
- func ReadConfigFile(filePath string) error
- func Set(key string, value interface{})
- func Unset(key string) error
- func WriteConfigFile(filePath string, perm os.FileMode) error
- type Checker
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Get ¶
Get returns the value for the given key, or an eror if the key is undefined.
The key is composed by all the key names separated by :, in case of nested keys. For example, suppose we have the following configuration yaml:
databases:
mysql:
host: localhost
port: 3306
The key "databases:mysql:host" would return "localhost", while the key "port" would return an error.
Get will expand the value with environment values, ex.:
mongo: $MONGOURI
If there is an environment variable MONGOURI=localhost/test, the key "mongo" would return "localhost/test"
func GetDuration ¶
GetDuration parses and returns a duration from the config file. It may be an integer or a number specifying the amount of nanoseconds.
Here are some examples of valid durations:
- 1h30m0s
- 1e9 (one second)
- 100e6 (one hundred milliseconds)
- 1 (one nanosecond)
- 1000000000 (one billion nanoseconds, or one second)
func GetFloat ¶
GetFloat works like Get, but doing type assertion and attempting conversions before returning the value.
It returns error if the key is undefined or if it is not a float.
func GetInt ¶
GetInt works like Get, but doing a int type assertion before return the value.
It returns error if the key is undefined or if it is not a int.
func GetList ¶
GetList works like Get, but returns a slice of strings instead. It must be written down in the config as YAML lists.
Here are two example of YAML lists:
names: - Mary - John - Paul - Petter
If GetList find an item that is not a string (for example 5.08734792), it will convert the item.
func GetString ¶
GetString works like Get, but doing a string type assertion before return the value.
It returns error if the key is undefined or if it is not a string.
func ReadAndWatchConfigFile ¶
ReadAndWatchConfigFile reads and watchs for changes in the configuration file. Whenever the file change, and its contents are valid YAML, the configuration gets updated. With this function, daemons that use this package may reload configuration without restarting.
func ReadConfigBytes ¶
ReadConfigBytes receives a slice of bytes and builds the internal configuration object.
If the given slice is not a valid yaml file, ReadConfigBytes returns a non-nil error.
func ReadConfigFile ¶
ReadConfigFile reads the content of a file and calls ReadConfigBytes to build the internal configuration object.
It returns error if it can not read the given file or if the file contents is not valid yaml.
func Set ¶
func Set(key string, value interface{})
Set redefines or defines a value for a key. The key has the same format that it has in Get and GetString.
Values defined by this function affects only runtime informatin, nothing defined by Set is persisted in the filesystem or any database.
Source Files