dbms

Documentation

Index

• type ClientSettings
• type DBMS
  • func New(t api.DBMS, conn api.Connection) DBMS
• type InitSettings
• type InitUser

Types

type ClientSettings

type ClientSettings struct {
	// Username to use when connecting to the database
	Username string
	// Password to use when connecting (if empty, passwordless auth will be used)
	Password string
	// Host to connect to (if blank, defaults to "127.0.0.1"
	Host string
	// Database database to connect to (leave blank to not connect to any database)
	Database string
	// Nickname optional short username to use in terminal prompt -- useful for
	// long Cloud IAM usernames like "thelma-sql-rw-terra-dev@broad-dsde-dev.iam"
	Nickname string

	// Init initialization script settings
	Init InitSettings
}

type DBMS

type DBMS interface {
	// Type returns type of database
	Type() api.DBMS
	// PodSpec returns information about Kubernetes resources that should be created in order to execute commands
	// against the database
	PodSpec(ClientSettings) (podrun.DBMSSpec, error)
	// InitCommand returns a command that should be run during `thelma sql init` to set up the database
	InitCommand() []string
	// ShellCommand returns a command that should be run during `thelma sql connect` to launch an interactive shell
	ShellCommand() []string
}

DBMS the kind of remote database that Thelma is trying to connect to (Postgres or MySQL)

func New

func New(t api.DBMS, conn api.Connection) DBMS

type InitSettings

type InitSettings struct {
	// CreateUsers if true, create users instead of assuming they exist
	CreateUsers bool
	// ReadOnlyUser information about Thelma's read only user
	ReadOnlyUser InitUser
	// ReadWriteUser information about Thelma's read write user
	ReadWriteUser InitUser
}

InitSettings controlling Thelma user initialization

type InitUser

type InitUser struct {
	// Name (local username) for the user
	Name string
	// Password (optional). If not empty, the user's password will be set to this value
	Password string
}

InitUser settings for initializing a new local database user