cmd

Documentation

Overview

The cmd package is used for Cobra integration.

0.5.2 Created by make-go-github-file.yaml on Tue Jan 30 16:23:47 UTC 2024

Index

• Constants
• Variables
• func Execute()
• func PreRun(cobraCommand *cobra.Command, args []string)
• func RunE(_ *cobra.Command, _ []string) error
• func Version() string

Constants

const (
	Short string = "Initialize a database with the Senzing schema and configuration"
	Use   string = "init-database"
)

Variables

var ContextVariables = append(ContextVariablesForMultiPlatform, ContextVariablesForOsArch...)

var ContextVariablesForMultiPlatform = []option.ContextVariable{
	option.Configuration,
	option.DatabaseUrl,
	option.Datasources,
	option.EngineConfigurationJson,
	option.EngineLogLevel,
	option.EngineModuleName,
	option.LicenseStringBase64,
	option.LogLevel,
	option.ObserverOrigin,
	option.ObserverUrl,
}

var ContextVariablesForOsArch = []option.ContextVariable{}

var (
	Long string = getLong()
)

var OptionEngineConfigurationFile = option.ContextVariable{
	Arg:     "engine-configuration-file",
	Default: getEngineConfigurationFileDefault(),
	Envar:   envarEngineConfigurationFile,
	Help:    "Path to file of JSON used to configure Senzing engine [%s]",
	Type:    optiontype.String,
}

var OptionSqlFile = option.ContextVariable{
	Arg:     "sql-file",
	Default: getSqlFileDefault(),
	Envar:   envarSqlFile,
	Help:    "Path to file of SQL used to create Senzing database schema [%s]",
	Type:    optiontype.String,
}

var RootCmd = &cobra.Command{
	Use:     Use,
	Short:   Short,
	Long:    Long,
	PreRun:  PreRun,
	RunE:    RunE,
	Version: Version(),
}

RootCmd represents the command.

Functions

func Execute

func Execute()

Execute adds all child commands to the root command and sets flags appropriately. This is called by main.main(). It only needs to happen once to the RootCmd.

func PreRun

func PreRun(cobraCommand *cobra.Command, args []string)

Used in construction of cobra.Command

func RunE

func RunE(_ *cobra.Command, _ []string) error

Used in construction of cobra.Command

func Version

func Version() string

Used in construction of cobra.Command