stage

Documentation

Overview

Package stage defines a means of storing and retrieving mutations to be applied to a table.

Index

• Variables
• func EnableSanityChecks()
• func ProvideFactory(cfg *Config, db *types.StagingPool, stagingDB ident.StagingSchema, ...) types.Stagers
• type Config
  • func (c *Config) Bind(f *pflag.FlagSet)
  • func (c *Config) Preflight() error

Variables

var Set = wire.NewSet(
	ProvideFactory,
)

Set is used by Wire.

Functions

func EnableSanityChecks

func EnableSanityChecks()

EnableSanityChecks can be called by test code to enable additional validation of the staging tables.

func ProvideFactory

func ProvideFactory(
	cfg *Config, db *types.StagingPool, stagingDB ident.StagingSchema, stop *stopper.Context,
) types.Stagers

ProvideFactory is called by Wire to construct the Stagers factory.

Types

type Config

type Config struct {
	MarkAppliedLimit  int           // Maximum batch size for the MarkApplied method.
	SanityCheckPeriod time.Duration // If positive, refresh [stageConsistencyErrors].
	SanityCheckWindow time.Duration // If positive, limit time range of records.
	UnappliedPeriod   time.Duration // If positive, report number of unapplied mutations.
}

Config sets tuneables when interacting with the staging tables.

func (*Config) Bind

func (c *Config) Bind(f *pflag.FlagSet)

Bind adds configuration flags to the set.

func (*Config) Preflight

func (c *Config) Preflight() error

Preflight ensures the Config is in a known-good state.