config

package

v1.4.0 Latest Latest Go to latest Published: May 30, 2021 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/powerman/go-service-example

Links

Open Source Insights

Documentation ¶

Overview ¶

Package config provides configurations for subcommands.

Default values can be obtained from various sources (constants, environment variables, etc.) and then overridden by flags.

As configuration is global you can get it only once for safety: you can call only one of Get… functions and call it just once.

Index ¶

func GetGooseMySQL() (c *cobrax.GooseMySQLConfig, err error)
func Init(flagsets FlagSets) error
type FlagSets
type ServeConfig
- func GetServe() (c *ServeConfig, err error)
- func MustGetServeTest() *ServeConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func GetGooseMySQL ¶ added in v1.3.0

func GetGooseMySQL() (c *cobrax.GooseMySQLConfig, err error)

func Init ¶

func Init(flagsets FlagSets) error

Init updates config defaults (from env) and setup subcommands flags.

Init must be called once before using this package.

Types ¶

type FlagSets ¶

type FlagSets struct {
	Serve      *pflag.FlagSet
	GooseMySQL *pflag.FlagSet
}

FlagSets for all CLI subcommands which use flags to set config values.

type ServeConfig ¶

type ServeConfig struct {
	MySQL           *mysql.Config
	GooseMySQLDir   string
	BindAddr        netx.Addr
	BindMetricsAddr netx.Addr
	APIKeyAdmin     string
}

ServeConfig contains configuration for subcommand.

func GetServe ¶

func GetServe() (c *ServeConfig, err error)

GetServe validates and returns configuration for subcommand.

func MustGetServeTest ¶

func MustGetServeTest() *ServeConfig

MustGetServeTest returns config suitable for use in tests.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL