db

Documentation

Index

• type Config
  • func (cfg *Config) RegisterFlags(f *flag.FlagSet)
• type DB
  • func New(cfg Config) (DB, error)

Types

type Config

type Config struct {
	URI           string
	MigrationsDir string
	PasswordFile  string

	// Allow injection of mock DBs for unit testing.
	Mock DB `yaml:"-"`
}

Config configures the database.

func (*Config) RegisterFlags

func (cfg *Config) RegisterFlags(f *flag.FlagSet)

RegisterFlags adds the flags required to configure this to the given FlagSet.

type DB

type DB interface {
	// GetRulesConfig gets the user's ruler config
	GetRulesConfig(ctx context.Context, userID string) (configs.VersionedRulesConfig, error)

	// SetRulesConfig does a compare-and-swap (CAS) on the user's rules config.
	// `oldConfig` must precisely match the current config in order to change the config to `newConfig`.
	// Will return `true` if the config was updated, `false` otherwise.
	SetRulesConfig(ctx context.Context, userID string, oldConfig, newConfig configs.RulesConfig) (bool, error)

	// GetAllRulesConfigs gets all of the ruler configs
	GetAllRulesConfigs(ctx context.Context) (map[string]configs.VersionedRulesConfig, error)

	// GetRulesConfigs gets all of the configs that have been added or have
	// changed since the provided config.
	GetRulesConfigs(ctx context.Context, since configs.ID) (map[string]configs.VersionedRulesConfig, error)

	GetConfig(ctx context.Context, userID string) (configs.View, error)
	SetConfig(ctx context.Context, userID string, cfg configs.Config) error

	GetAllConfigs(ctx context.Context) (map[string]configs.View, error)
	GetConfigs(ctx context.Context, since configs.ID) (map[string]configs.View, error)

	DeactivateConfig(ctx context.Context, userID string) error
	RestoreConfig(ctx context.Context, userID string) error

	Close() error
}

DB is the interface for the database.

func New

func New(cfg Config) (DB, error)

New creates a new database.