common

Documentation

Overview

Package common provides the utility functions and type needed by all specialized step packages

Index

• Variables
• func CreateSuperseed() map[string]string
• func FindRecipes(log *logrus.Entry, args []string) ([]string, error)

Variables

var (
	// CfgFolder configuration folder
	CfgFolder string
	// Ctx root context of the application
	Ctx context.Context
	// DryRun would not really do the action but logs
	DryRun bool
	// Force the step execution without executing skip queries
	Force bool
	// Logger log engine of the application
	Logger = logrus.New()
	// Quiet no logs
	Quiet bool
	// Retry number of database ping
	Retry int
	// Sequential do not run step in parallel
	Sequential bool
	// Tags user provided tag list to limit the concerned datasource
	Tags []string
	// Timeout of each database ping try
	Timeout time.Duration
	// Verbose add debug logs
	Verbose bool
)

var ErrMissingParameter = errors.New("MISSING PARAMETER")

ErrMissingParameter raise when a parameter is missing in command line.

var ErrNoConfiguration = errors.New("NO CONFIGURATION FOUND")

ErrNoConfiguration raise when no configuration is found.

var ErrStep = errors.New("STEP")

ErrStep raise when a step fininished in error.

var ErrWrongParameterValue = errors.New("WRONG PARAMETER VALUE")

ErrWrongParameterValue raise when a parameter as a wrong value in command line.

Functions

func CreateSuperseed

func CreateSuperseed() map[string]string

CreateSuperseed creates the postload configuration map.

func FindRecipes

func FindRecipes(log *logrus.Entry, args []string) ([]string, error)

FindRecipes lookup the configuration folder and return a list of recipes if the args is empty.