config

Documentation

Overview

Package config is used to parse config. Usage:

import "github.com/beego/beego/v2/core/config"

Examples.

cnf, err := config.NewConfig("ini", "config.conf")

cnf APIS:

cnf.Set(key, val string) error
cnf.String(key string) string
cnf.Strings(key string) []string
cnf.Int(key string) (int, error)
cnf.Int64(key string) (int64, error)
cnf.Bool(key string) (bool, error)
cnf.Float(key string) (float64, error)
cnf.DefaultString(key string, defaultVal string) string
cnf.DefaultStrings(key string, defaultVal []string) []string
cnf.DefaultInt(key string, defaultVal int) int
cnf.DefaultInt64(key string, defaultVal int64) int64
cnf.DefaultBool(key string, defaultVal bool) bool
cnf.DefaultFloat(key string, defaultVal float64) float64
cnf.DIY(key string) (interface{}, error)
cnf.GetSection(section string) (map[string]string, error)
cnf.SaveConfigFile(filename string) error

More docs http://beego.vip/docs/module/config.md

Index

• func ExpandValueEnv(value string) string
• func ExpandValueEnvForMap(m map[string]interface{}) map[string]interface{}
• func ParseBool(val interface{}) (value bool, err error)
• func Register(name string, adapter Config)
• func ToString(x interface{}) string
• type Config
• type Configer
  • func NewConfig(adapterName, filename string) (Configer, error)
  • func NewConfigData(adapterName string, data []byte) (Configer, error)
  • func NewFakeConfig() Configer

Functions

func ExpandValueEnv

func ExpandValueEnv(value string) string

ExpandValueEnv returns value of convert with environment variable.

Return environment variable if value start with "${" and end with "}". Return default value if environment variable is empty or not exist.

It accept value formats "${env}" , "${env||}}" , "${env||defaultValue}" , "defaultvalue". Examples:

v1 := config.ExpandValueEnv("${GOPATH}")			// return the GOPATH environment variable.
v2 := config.ExpandValueEnv("${GOAsta||/usr/local/go}")	// return the default value "/usr/local/go/".
v3 := config.ExpandValueEnv("Astaxie")				// return the value "Astaxie".

func ExpandValueEnvForMap

func ExpandValueEnvForMap(m map[string]interface{}) map[string]interface{}

ExpandValueEnvForMap convert all string value with environment variable.

func ParseBool

func ParseBool(val interface{}) (value bool, err error)

ParseBool returns the boolean value represented by the string.

It accepts 1, 1.0, t, T, TRUE, true, True, YES, yes, Yes,Y, y, ON, on, On, 0, 0.0, f, F, FALSE, false, False, NO, no, No, N,n, OFF, off, Off. Any other value returns an error.

func Register

func Register(name string, adapter Config)

Register makes a config adapter available by the adapter name. If Register is called twice with the same name or if driver is nil, it panics.

func ToString

func ToString(x interface{}) string

ToString converts values of any type to string.

Types

type Config

type Config interface {
	Parse(key string) (Configer, error)
	ParseData(data []byte) (Configer, error)
}

Config is the adapter interface for parsing config file to get raw data to Configer.

type Configer

type Configer interface {
	Set(key, val string) error   // support section::key type in given key when using ini type.
	String(key string) string    // support section::key type in key string when using ini and json type; Int,Int64,Bool,Float,DIY are same.
	Strings(key string) []string // get string slice
	Int(key string) (int, error)
	Int64(key string) (int64, error)
	Bool(key string) (bool, error)
	Float(key string) (float64, error)
	DefaultString(key string, defaultVal string) string      // support section::key type in key string when using ini and json type; Int,Int64,Bool,Float,DIY are same.
	DefaultStrings(key string, defaultVal []string) []string // get string slice
	DefaultInt(key string, defaultVal int) int
	DefaultInt64(key string, defaultVal int64) int64
	DefaultBool(key string, defaultVal bool) bool
	DefaultFloat(key string, defaultVal float64) float64
	DIY(key string) (interface{}, error)
	GetSection(section string) (map[string]string, error)
	SaveConfigFile(filename string) error
}

Configer defines how to get and set value from configuration raw data.

func NewConfig

func NewConfig(adapterName, filename string) (Configer, error)

NewConfig adapterName is ini/json/xml/yaml. filename is the config file path.

func NewConfigData

func NewConfigData(adapterName string, data []byte) (Configer, error)

NewConfigData adapterName is ini/json/xml/yaml. data is the config data.

func NewFakeConfig

func NewFakeConfig() Configer

NewFakeConfig return a fake Configer