config

Documentation

Index

• type Config
  • func LoadFromFile(fs afero.Fs, path string) (*Config, error)
  • func LoadOrCreate(fs afero.Fs, path string) (*Config, error)
  • func (c *Config) GetSecretByKey(key string) (string, error)
  • func (c *Config) Persist() error
  • func (c *Config) PersistToFs(fs afero.Fs) error
  • func (c *Config) SelectEnvironment(name string) error
• type Connections
• type Environment
  • func (e *Environment) GetSecretByKey(key string) (string, error)
• type GenericConnection
  • func (c GenericConnection) MarshalJSON() ([]byte, error)
• type GoogleCloudPlatformConnection
  • func (c *GoogleCloudPlatformConnection) GetCredentials() *google.Credentials
  • func (c GoogleCloudPlatformConnection) MarshalJSON() ([]byte, error)
  • func (c *GoogleCloudPlatformConnection) SetCredentials(cred *google.Credentials)
• type MongoConnection
• type MsSQLConnection
• type PostgresConnection
• type SnowflakeConnection
  • func (c SnowflakeConnection) MarshalJSON() ([]byte, error)

Types

type Config

type Config struct {
	DefaultEnvironmentName  string                 `yaml:"default_environment"`
	SelectedEnvironmentName string                 `yaml:"-"`
	SelectedEnvironment     *Environment           `yaml:"-"`
	Environments            map[string]Environment `yaml:"environments"`
	// contains filtered or unexported fields
}

func LoadFromFile

func LoadFromFile(fs afero.Fs, path string) (*Config, error)

func LoadOrCreate

func LoadOrCreate(fs afero.Fs, path string) (*Config, error)

func (*Config) GetSecretByKey

func (c *Config) GetSecretByKey(key string) (string, error)

func (*Config) Persist

func (c *Config) Persist() error

func (*Config) PersistToFs

func (c *Config) PersistToFs(fs afero.Fs) error

func (*Config) SelectEnvironment

func (c *Config) SelectEnvironment(name string) error

type Connections

type Connections struct {
	GoogleCloudPlatform []GoogleCloudPlatformConnection `yaml:"google_cloud_platform"`
	Snowflake           []SnowflakeConnection           `yaml:"snowflake"`
	Postgres            []PostgresConnection            `yaml:"postgres"`
	RedShift            []PostgresConnection            `yaml:"redshift"`
	MsSQL               []MsSQLConnection               `yaml:"mssql"`
	Synapse             []MsSQLConnection               `yaml:"synapse"`
	Mongo               []MongoConnection               `yaml:"mongo"`
	Generic             []GenericConnection             `yaml:"generic"`
	// contains filtered or unexported fields
}

type Environment

type Environment struct {
	Connections Connections `yaml:"connections"`
}

func (*Environment) GetSecretByKey

func (e *Environment) GetSecretByKey(key string) (string, error)

type GenericConnection

type GenericConnection struct {
	Name  string `yaml:"name"`
	Value string `yaml:"value"`
}

func (GenericConnection) MarshalJSON

func (c GenericConnection) MarshalJSON() ([]byte, error)

type GoogleCloudPlatformConnection

type GoogleCloudPlatformConnection struct {
	Name               string `yaml:"name"`
	ServiceAccountJSON string `yaml:"service_account_json"`
	ServiceAccountFile string `yaml:"service_account_file"`
	ProjectID          string `yaml:"project_id"`

	Location string `yaml:"location"`
	// contains filtered or unexported fields
}

func (*GoogleCloudPlatformConnection) GetCredentials

func (c *GoogleCloudPlatformConnection) GetCredentials() *google.Credentials

func (GoogleCloudPlatformConnection) MarshalJSON

func (c GoogleCloudPlatformConnection) MarshalJSON() ([]byte, error)

func (*GoogleCloudPlatformConnection) SetCredentials

func (c *GoogleCloudPlatformConnection) SetCredentials(cred *google.Credentials)

type MongoConnection

type MongoConnection struct {
	Name     string `yaml:"name" json:"name"`
	Username string `yaml:"username" json:"username"`
	Password string `yaml:"password" json:"password"`
	Host     string `yaml:"host"     json:"host"`
	Port     int    `yaml:"port"     json:"port"`
	Database string `yaml:"database" json:"database"`
}

type MsSQLConnection

type MsSQLConnection struct {
	Name     string `yaml:"name" json:"name"`
	Username string `yaml:"username" json:"username"`
	Password string `yaml:"password" json:"password"`
	Host     string `yaml:"host"     json:"host"`
	Port     int    `yaml:"port"     json:"port"`
	Database string `yaml:"database" json:"database"`
}

type PostgresConnection

type PostgresConnection struct {
	Name         string `yaml:"name" json:"name"`
	Username     string `yaml:"username" json:"username"`
	Password     string `yaml:"password" json:"password"`
	Host         string `yaml:"host" json:"host"`
	Port         int    `yaml:"port" json:"port"`
	Database     string `yaml:"database" json:"database"`
	Schema       string `yaml:"schema" json:"schema"`
	PoolMaxConns int    `yaml:"pool_max_conns" json:"pool_max_conns" default:"10"`
	SslMode      string `yaml:"ssl_mode" json:"ssl_mode" default:"disable"`
}

type SnowflakeConnection

type SnowflakeConnection struct {
	Name      string `yaml:"name"`
	Account   string `yaml:"account"`
	Username  string `yaml:"username"`
	Password  string `yaml:"password"`
	Region    string `yaml:"region"`
	Role      string `yaml:"role"`
	Database  string `yaml:"database"`
	Schema    string `yaml:"schema"`
	Warehouse string `yaml:"warehouse"`
}

func (SnowflakeConnection) MarshalJSON

func (c SnowflakeConnection) MarshalJSON() ([]byte, error)