dbconfigs

Documentation

Overview

Package dbconfigs provides the registration for command line options to collect db connection parameters. Once registered and collected, it provides variables and functions to build connection parameters for connecting to the database.

Index

• Constants
• Variables
• func HasConnectionParams() bool
• func RegisterFlags(userKeys ...string)
• func WithCredentials(cp *mysql.ConnParams) (*mysql.ConnParams, error)
• type CredentialsServer
  • func GetCredentialsServer() CredentialsServer
• type DBConfigs
  • func Init(defaultSocketFile string) (*DBConfigs, error)
  • func NewTestDBConfigs(genParams, appDebugParams mysql.ConnParams, dbName string) *DBConfigs
  • func (dbcfgs *DBConfigs) AllPrivsWithDB() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) AppDebugWithDB() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) AppWithDB() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) Copy() *DBConfigs
  • func (dbcfgs *DBConfigs) Dba() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) DbaWithDB() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) FilteredWithDB() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) IsZero() bool
  • func (dbcfgs *DBConfigs) Repl() *mysql.ConnParams
  • func (dbcfgs *DBConfigs) String() string
• type FileCredentialsServer
  • func (fcs *FileCredentialsServer) GetUserAndPassword(user string) (string, string, error)

Constants

const (
	App      = "app"
	AppDebug = "appdebug"
	// AllPrivs user should have more privileges than App (should include possibility to do
	// schema changes and write to internal Vitess tables), but it shouldn't have SUPER
	// privilege like Dba has.
	AllPrivs = "allprivs"
	Dba      = "dba"
	Filtered = "filtered"
	Repl     = "repl"
)

config flags

Variables

var All = []string{App, AppDebug, AllPrivs, Dba, Filtered, Repl}

All can be used to register all flags: RegisterFlags(All...)

var AllCredentialsServers = make(map[string]CredentialsServer)

AllCredentialsServers contains all the known CredentialsServer implementations. Note we will only access this after flags have been parsed.

var (

	// ErrUnknownUser is returned by credential server when the
	// user doesn't exist
	ErrUnknownUser = errors.New("unknown user")
)

Functions

func HasConnectionParams

func HasConnectionParams() bool

HasConnectionParams returns true if connection parameters were specified in the command-line. This will allow the caller to search for alternate ways to connect, like looking in the my.cnf file.

func RegisterFlags

func RegisterFlags(userKeys ...string)

RegisterFlags registers the flags for the given DBConfigFlag. For instance, vttablet will register client, dba and repl. Returns all registered flags.

func WithCredentials

func WithCredentials(cp *mysql.ConnParams) (*mysql.ConnParams, error)

WithCredentials returns a copy of the provided ConnParams that we can use to connect, after going through the CredentialsServer.

Types

type CredentialsServer

type CredentialsServer interface {
	// GetUserAndPassword returns the user / password to use for a given
	// user. May return ErrUnknownUser. The user might be altered
	// to support versioned users.
	// Note this call needs to be thread safe, as we may call this from
	// multiple go routines.
	GetUserAndPassword(user string) (string, string, error)
}

CredentialsServer is the interface for a credential server

func GetCredentialsServer

func GetCredentialsServer() CredentialsServer

GetCredentialsServer returns the current CredentialsServer. Only valid after flag.Init was called.

type DBConfigs

type DBConfigs struct {
	DBName        sync2.AtomicString
	SidecarDBName sync2.AtomicString
	// contains filtered or unexported fields
}

DBConfigs stores all the data needed to build various connection parameters for the db. It stores credentials for app, appdebug, allprivs, dba, filtered and repl users. It contains other connection parameters like socket, charset, etc. It also stores the default db name, which it can combine with the rest of the data to build db-sepcific connection parameters. It also supplies the SidecarDBName. This is currently hardcoded to "_vt", but will soon become customizable. The life-cycle of this package is as follows: App must call RegisterFlags to request the types of connections it wants support for. This must be done before involing flags.Parse. After flag parsing, app invokes the Init function, which will return a DBConfigs object. The app must store the DBConfigs object internally, and use it to build connection parameters as needed. The DBName is initially empty and may later be set or changed by the app.

func Init

func Init(defaultSocketFile string) (*DBConfigs, error)

Init will initialize all the necessary connection parameters. Precedence is as follows: if baseConfig command line options are set, they supersede all other settings. If baseConfig is not set, the next priority is with per-user connection parameters. This is only for legacy support. If no per-user parameters are supplied, then the defaultSocketFile is used to initialize the per-user conn params.

func NewTestDBConfigs

func NewTestDBConfigs(genParams, appDebugParams mysql.ConnParams, dbName string) *DBConfigs

NewTestDBConfigs returns a DBConfigs meant for testing.

func (*DBConfigs) AllPrivsWithDB

func (dbcfgs *DBConfigs) AllPrivsWithDB() *mysql.ConnParams

AllPrivsWithDB returns connection parameters for appdebug with dbname set.

func (*DBConfigs) AppDebugWithDB

func (dbcfgs *DBConfigs) AppDebugWithDB() *mysql.ConnParams

AppDebugWithDB returns connection parameters for appdebug with dbname set.

func (*DBConfigs) AppWithDB

func (dbcfgs *DBConfigs) AppWithDB() *mysql.ConnParams

AppWithDB returns connection parameters for app with dbname set.

func (*DBConfigs) Copy

func (dbcfgs *DBConfigs) Copy() *DBConfigs

Copy returns a copy of the DBConfig.

func (*DBConfigs) Dba

func (dbcfgs *DBConfigs) Dba() *mysql.ConnParams

Dba returns connection parameters for dba with no dbname set.

func (*DBConfigs) DbaWithDB

func (dbcfgs *DBConfigs) DbaWithDB() *mysql.ConnParams

DbaWithDB returns connection parameters for appdebug with dbname set.

func (*DBConfigs) FilteredWithDB

func (dbcfgs *DBConfigs) FilteredWithDB() *mysql.ConnParams

FilteredWithDB returns connection parameters for appdebug with dbname set.

func (*DBConfigs) IsZero

func (dbcfgs *DBConfigs) IsZero() bool

IsZero returns true if DBConfigs was uninitialized.

func (*DBConfigs) Repl

func (dbcfgs *DBConfigs) Repl() *mysql.ConnParams

Repl returns connection parameters for appdebug with no dbname set.

func (*DBConfigs) String

func (dbcfgs *DBConfigs) String() string

type FileCredentialsServer

type FileCredentialsServer struct {
	// contains filtered or unexported fields
}

FileCredentialsServer is a simple implementation of CredentialsServer using a json file. Protected by mu.

func (*FileCredentialsServer) GetUserAndPassword

func (fcs *FileCredentialsServer) GetUserAndPassword(user string) (string, string, error)

GetUserAndPassword is part of the CredentialsServer interface