config

Documentation

Index

• Constants
• func Parse(filename string, output Configurable) error
• func ParseWithValidator(filename string, val *validator.Validate, output Configurable) error
• type Alias
  • func (a *Alias[Type]) Name() string
  • func (a *Alias[Type]) SetStruct(entity Type)
  • func (a *Alias[Type]) Struct() Type
  • func (a *Alias[Type]) UnmarshalYAML(unmarshal func(interface{}) error) error
• type ApiKey
• type Config
  • func Load(filename string) (*Config, error)
  • func (c *Config) Substitute() error
• type Configurable
• type Contract
• type Credentials
• type DataSource
• type Database
• type Hasura
  • func (h *Hasura) UnmarshalYAML(unmarshal func(interface{}) error) error
• type HasuraSource
• type Prometheus
• type UserCredentials

Constants

const (
	DBKindSqlite        = "sqlite"
	DBKindPostgres      = "postgres"
	DBKindMysql         = "mysql"
	DBKindClickhouse    = "clickhouse"
	DBKindElasticSearch = "elasticsearch"
)

Supported database kinds

Functions

func Parse

func Parse(filename string, output Configurable) error

Parse -

func ParseWithValidator

func ParseWithValidator(filename string, val *validator.Validate, output Configurable) error

ParseWithValidator - parse config with custom validator. If validator is nil validation will be skipped.

Types

type Alias

type Alias[Type any] struct {
	// contains filtered or unexported fields
}

Alias - type for aliasing in config

func (*Alias[Type]) Name

func (a *Alias[Type]) Name() string

Name - returns alias name if it exists

func (*Alias[Type]) SetStruct

func (a *Alias[Type]) SetStruct(entity Type)

SetStruct - set entity. Use in Substitute

func (*Alias[Type]) Struct

func (a *Alias[Type]) Struct() Type

Struct - returns substitute struct

func (*Alias[Type]) UnmarshalYAML

func (a *Alias[Type]) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML -

type ApiKey

type ApiKey struct {
	Header string `yaml:"header" validate:"required"`
	Key    string `yaml:"key"    validate:"required"`
}

type Config

type Config struct {
	Version     string                `yaml:"version" validate:"required"`
	Database    Database              `yaml:"database" validate:"required"`
	DataSources map[string]DataSource `yaml:"datasources,omitempty"`
	Contracts   map[string]Contract   `yaml:"contracts,omitempty"`
	Hasura      *Hasura               `yaml:"hasura,omitempty" validate:"omitempty"`
	Prometheus  *Prometheus           `yaml:"prometheus,omitempty" validate:"omitempty"`
}

Config

func Load

func Load(filename string) (*Config, error)

Load - load default config from `filename`

func (*Config) Substitute

func (c *Config) Substitute() error

Substitute -

type Configurable

type Configurable interface {
	Substitute() error
}

Configurable -

type Contract

type Contract struct {
	Address  string `yaml:"address" validate:"required,len=36"`
	TypeName string `yaml:"typename"`
}

Contracts -

type Credentials

type Credentials struct {
	User   *UserCredentials `yaml:"user,omitempty"    validate:"omitempty"`
	ApiKey *ApiKey          `yaml:"api_key,omitempty" validate:"omitempty"`
}

Credentials -

type DataSource

type DataSource struct {
	Kind              string       `yaml:"kind"`
	URL               string       `yaml:"url" validate:"required,url"`
	Credentials       *Credentials `yaml:"credentials,omitempty" validate:"omitempty"`
	Timeout           uint         `yaml:"timeout" validate:"omitempty"`
	RequestsPerSecond int          `yaml:"rps" validate:"omitempty,min=1"`
}

DataSource -

type Database

type Database struct {
	Path                   string `yaml:"path,omitempty"`
	Kind                   string `yaml:"kind" validate:"required,oneof=sqlite postgres mysql clickhouse elasticsearch"`
	Host                   string `yaml:"host" validate:"required_with=Port User Database"`
	Port                   int    `yaml:"port" validate:"required_with=Host User Database,gt=-1,lt=65535"`
	User                   string `yaml:"user" validate:"required_with=Host Port Database"`
	Password               string `yaml:"password"`
	Database               string `yaml:"database" validate:"required_with=Host Port User"`
	SchemaName             string `yaml:"schema_name"`
	ApplicationName        string `yaml:"application_name"`
	MaxOpenConnections     int    `yaml:"max_open_connections"`
	MaxIdleConnections     int    `yaml:"max_idle_connections"`
	MaxLifetimeConnections int    `yaml:"max_lifetime_connections"`
}

Database

type Hasura

type Hasura struct {
	URL                string        `yaml:"url" validate:"required,url"`
	Secret             string        `yaml:"admin_secret" validate:"required"`
	RowsLimit          uint64        `yaml:"select_limit" validate:"gt=0"`
	EnableAggregations bool          `yaml:"allow_aggregation"`
	Source             *HasuraSource `yaml:"source"`
	Rest               *bool         `yaml:"rest"`
	UnauthorizedRole   string        `yaml:"unauthorized_role"`
}

Hasura -

func (*Hasura) UnmarshalYAML

func (h *Hasura) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML -

type HasuraSource

type HasuraSource struct {
	Name                  string `yaml:"name" validate:"required"`
	DatabaseHost          string `yaml:"database_host"`
	UsePreparedStatements bool   `yaml:"use_prepared_statements"`
	IsolationLevel        string `yaml:"isolation_level"`
}

type Prometheus

type Prometheus struct {
	URL string `yaml:"url" validate:"required"`
}

Prometheus -

type UserCredentials

type UserCredentials struct {
	Name     string `yaml:"name" validate:"required"`
	Password string `yaml:"password" validate:"required"`
}

UserCredentials -