crdbx

Documentation

Overview

Package crdbx provides shared functions used to initialize connections with a cockroachdb instance.

Index

• func MustViperFlags(v *viper.Viper, _ *pflag.FlagSet)
• func NewDB(cfg Config, tracing bool) (*sql.DB, error)
• type Config
  • func ConfigFromArgs(v *viper.Viper, dbName string) Config
  • func (c Config) GetURI() string

Functions

func MustViperFlags

func MustViperFlags(v *viper.Viper, _ *pflag.FlagSet)

MustViperFlags returns the cobra flags and viper config to prevent code duplication and help provide consistent flags across the applications

func NewDB

func NewDB(cfg Config, tracing bool) (*sql.DB, error)

NewDB will open a connection to the database based on the config provided

Types

type Config

type Config struct {
	Name        string `mapstructure:"name"`
	Host        string `mapstructure:"host"`
	User        string `mapstructure:"user"`
	Password    string `mapstructure:"password"`
	Params      string `mapstructure:"params"`
	URI         string `mapstructure:"uri"`
	Connections struct {
		MaxOpen     int           `mapstructure:"max_open"`
		MaxIdle     int           `mapstructure:"max_idle"`
		MaxLifetime time.Duration `mapstructure:"max_lifetime"`
	}
}

Config is used to configure a new cockroachdb connection

func ConfigFromArgs

func ConfigFromArgs(v *viper.Viper, dbName string) Config

ConfigFromArgs returns a crdbx.Config from the provided viper-provided flags.

func (Config) GetURI

func (c Config) GetURI() string

GetURI returns the connection URI, if a config URI is provided that will be returned, otherwise the host, user, password, and params will be put together to make a URI that is returned.