schema

package
v1.4.2-prerelease14 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 10, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Update

func Update(ctx context.Context, options Options) error

Update updates the schema for all DBs referenced in the specified config

func Verify

func Verify(ctx context.Context, opts Options) error

Types

type Options

type Options struct {
	// Required
	// ClusterName is the name of the current cluster
	ClusterName string
	// Config is the persistence config to use for connecting to the DBs. It must be non-nil.
	Config *config.Persistence
	// Optional
	// SetupOptions are parameters passed to SetupDB.Setup. Defaults to empty
	SetupOptions map[string]string
	// Logger is the logger. Defaults to zap production defaults
	Logger log.Logger
	// ConnectTimeout is the amount of time allowed to spend connecting to all DB instances. Defaults to 10s.
	// During this time period, any errors are retried with a short backoff. This is to tolerate the DBs not yet
	// being available.
	ConnectTimeout time.Duration
	// Time is the time source. Defaults to real time.
	Time clock.TimeSource
}

func OptionsFromConfig

func OptionsFromConfig(cfg config.Config) Options

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL