constants

Documentation

Overview

Package constants contains constant values that are used throughout Steampipe

Index

• Constants
• Variables
• func ArgFromMetaquery(cmd string) string
• func BoldBlack(arg interface{}) aurora.Value
• func BoldBlue(arg interface{}) aurora.Value
• func BoldBrightBlack(arg interface{}) aurora.Value
• func BoldBrightBlue(arg interface{}) aurora.Value
• func BoldBrightCyan(arg interface{}) aurora.Value
• func BoldBrightGreen(arg interface{}) aurora.Value
• func BoldBrightMagenta(arg interface{}) aurora.Value
• func BoldBrightRed(arg interface{}) aurora.Value
• func BoldBrightWhite(arg interface{}) aurora.Value
• func BoldBrightYellow(arg interface{}) aurora.Value
• func BoldCyan(arg interface{}) aurora.Value
• func BoldGreen(arg interface{}) aurora.Value
• func BoldMagenta(arg interface{}) aurora.Value
• func BoldRed(arg interface{}) aurora.Value
• func BoldWhite(arg interface{}) aurora.Value
• func BoldYellow(arg interface{}) aurora.Value
• func BoolToEnableDisable(val bool) string
• func BoolToOnOff(val bool) string
• func Gray1(arg interface{}) aurora.Value
• func Gray2(arg interface{}) aurora.Value
• func Gray3(arg interface{}) aurora.Value
• func Gray4(arg interface{}) aurora.Value
• func Gray5(arg interface{}) aurora.Value
• func IsYamlExtension(ext string) bool
• type Invoker
  • func (i Invoker) IsValid() error

Constants

const (
	AppName = "steampipe"
	FdwName = "steampipe-postgres-fdw"
)

const (
	ArgHelp                 = "help"
	ArgVersion              = "version"
	ArgForce                = "force"
	ArgAll                  = "all"
	ArgTiming               = "timing"
	ArgOn                   = "on"
	ArgOff                  = "off"
	ArgClear                = "clear"
	ArgDatabasePort         = "database-port"
	ArgDatabaseQueryTimeout = "query-timeout"
	ArgListenAddress        = "database-listen"
	ArgServicePassword      = "database-password"
	ArgServiceShowPassword  = "show-password"
	ArgDashboard            = "dashboard"
	ArgDashboardListen      = "dashboard-listen"
	ArgDashboardPort        = "dashboard-port"
	ArgForeground           = "foreground"
	ArgInvoker              = "invoker"
	ArgUpdateCheck          = "update-check"
	ArgTelemetry            = "telemetry"
	ArgInstallDir           = "install-dir"
	ArgWorkspaceChDir       = "workspace-chdir"
	ArgWorkspaceDatabase    = "workspace-database"
	ArgSchemaComments       = "schema-comments"
	ArgCloudHost            = "cloud-host"
	ArgCloudToken           = "cloud-token"
	ArgSearchPath           = "search-path"
	ArgSearchPathPrefix     = "search-path-prefix"
	ArgWatch                = "watch"
	ArgTheme                = "theme"
	ArgProgress             = "progress"
	ArgExport               = "export"
	ArgMaxParallel          = "max-parallel"
	ArgDryRun               = "dry-run"
	ArgWhere                = "where"
	ArgTag                  = "tag"
	ArgVariable             = "var"
	ArgVarFile              = "var-file"
	ArgConnectionString     = "connection-string"
	ArgCheckDisplayWidth    = "check-display-width"
	ArgPrune                = "prune"
	ArgModInstall           = "mod-install"
	ArgServiceMode          = "service-mode"
	ArgBrowser              = "browser"
	ArgInput                = "input"
	ArgDashboardInput       = "dashboard-input"
	ArgMaxCacheSizeMb       = "max-cache-size-mb"
	ArgIntrospection        = "introspection"
	ArgShare                = "share"
	ArgSnapshot             = "snapshot"
	ArgSnapshotTag          = "snapshot-tag"
	ArgWorkspaceProfile     = "workspace"
	ArgModLocation          = "mod-location"
	ArgSnapshotLocation     = "snapshot-location"
	ArgSnapshotTitle        = "snapshot-title"
)

Argument name constants

const (
	// ConfigKeyDatabaseSearchPath is used to store the search path set in the database config in viper
	// the viper value will be set via via a call to getScopedKey in steampipeconfig/steampipeconfig.go
	ConfigKeyDatabaseSearchPath = "database.search-path"
	ConfigKeyInteractive        = "interactive"
	ConfigKeyActiveCommand      = "cmd"
	ConfigKeyActiveCommandArgs  = "cmd_args"
	ConfigInteractiveVariables  = "interactive_var"
	ConfigKeyIsTerminalTTY      = "is_terminal"
)

viper config keys

const (
	// ControlQueryCancellationTimeoutSecs is maximum number of seconds to wait for control queries to finish cancelling
	ControlQueryCancellationTimeoutSecs = 30
	// MaxControlRunAttempts determines how many time should a cotnrol run should be retried
	// in the case of a GRPC connectivity error
	MaxControlRunAttempts = 2
)

const (
	ControlOk    = "ok"
	ControlAlarm = "alarm"
	ControlSkip  = "skip"
	ControlInfo  = "info"
	ControlError = "error"
)

const (
	DashboardServerDefaultPort    = 9194
	DashboardAssetsImageRefFormat = "us-docker.pkg.dev/steampipe/steampipe/assets:%s"
)

const (
	// MaxParallelClientInits is the number of clients to initialize in parallel
	// if we start initializing all clients together, it leads to bad performance on all
	MaxParallelClientInits = 3

	// MaxBackups is the maximum number of backups that will be retained
	MaxBackups = 100
)

dbClient constants

const (
	DatabaseDefaultPort              = 9193
	DatabaseDefaultCheckQueryTimeout = 240
	DatabaseSuperUser                = "root"
	DatabaseUser                     = "steampipe"
	DatabaseName                     = "steampipe"
	DatabaseUsersRole                = "steampipe_users"
	DefaultMaxConnections            = 10
)

const (
	DatabaseVersion = "14.2.0"
	FdwVersion      = "1.5.0"

	// PostgresImageRef is the OCI Image ref for the database binaries
	PostgresImageRef    = "us-docker.pkg.dev/steampipe/steampipe/db:14.2.0"
	PostgresImageDigest = "sha256:a75637209f1bc2fa9885216f7972dfa0d82010a25d3cbfc07baceba8d16f4a93"

	FdwImageRef       = "us-docker.pkg.dev/steampipe/steampipe/fdw:" + FdwVersion
	FdwBinaryFileName = "steampipe_postgres_fdw.so"
)

constants for installing db and fdw images

const (
	// FunctionSchema is the schema container for all steampipe helper functions
	FunctionSchema = "internal"

	// CommandSchema is the schema which is used to send commands to the FDW
	CommandSchema = "steampipe_command"

	CommandTableCache                = "cache"
	CommandTableCacheOperationColumn = "operation"
	CommandCacheOn                   = "cache_on"
	CommandCacheOff                  = "cache_off"
	CommandCacheClear                = "cache_clear"

	CommandTableScanMetadata = "scan_metadata"
)

schema names

const (
	IntrospectionTableQuery              = "steampipe_query"
	IntrospectionTableControl            = "steampipe_control"
	IntrospectionTableBenchmark          = "steampipe_benchmark"
	IntrospectionTableMod                = "steampipe_mod"
	IntrospectionTableDashboard          = "steampipe_dashboard"
	IntrospectionTableDashboardContainer = "steampipe_dashboard_container"
	IntrospectionTableDashboardCard      = "steampipe_dashboard_card"
	IntrospectionTableDashboardChart     = "steampipe_dashboard_chart"
	IntrospectionTableDashboardFlow      = "steampipe_dashboard_flow"
	IntrospectionTableDashboardGraph     = "steampipe_dashboard_graph"
	IntrospectionTableDashboardHierarchy = "steampipe_dashboard_hierarchy"
	IntrospectionTableDashboardImage     = "steampipe_dashboard_image"
	IntrospectionTableDashboardInput     = "steampipe_dashboard_input"
	IntrospectionTableDashboardTable     = "steampipe_dashboard_table"
	IntrospectionTableDashboardText      = "steampipe_dashboard_text"
	IntrospectionTableVariable           = "steampipe_variable"
	IntrospectionTableReference          = "steampipe_reference"
)

introspection table names

const (
	// InvokerService is set when invoked by `service start`
	InvokerService Invoker = "service"
	// InvokerQuery is set when invoked by query command
	InvokerQuery = "query"
	// InvokerCheck is set when invoked by check command
	InvokerCheck = "check"
	// InvokerPlugin is set when invoked by a plugin command
	InvokerPlugin = "plugin"
	// InvokerDashboard is set when invoked by dashboard command
	InvokerDashboard = "dashboard"
	// InvokerConnectionWatcher is set when invoked by the connection watcher process
	InvokerConnectionWatcher = "connection-watcher"
)

const (
	// SpinnerShowTimeout is the duration after which spinner should be shown
	SpinnerShowTimeout = 1 * time.Second

	MaxColumnWidth = 1024

	// NullString is the string which is displayed for null column values
	NullString = "<null>"
)

Display constants

const (
	EnvUpdateCheck     = "STEAMPIPE_UPDATE_CHECK"
	EnvInstallDir      = "STEAMPIPE_INSTALL_DIR"
	EnvInstallDatabase = "STEAMPIPE_INITDB_DATABASE_NAME"
	EnvServicePassword = "STEAMPIPE_DATABASE_PASSWORD"
	EnvMaxParallel     = "STEAMPIPE_MAX_PARALLEL"

	EnvSnapshotLocation  = "STEAMPIPE_SNAPSHOT_LOCATION"
	EnvWorkspaceDatabase = "STEAMPIPE_WORKSPACE_DATABASE"
	EnvWorkspaceProfile  = "STEAMPIPE_WORKSPACE"
	EnvCloudHost         = "STEAMPIPE_CLOUD_HOST"
	EnvCloudToken        = "STEAMPIPE_CLOUD_TOKEN"

	EnvCheckDisplayWidth = "STEAMPIPE_CHECK_DISPLAY_WIDTH"
	EnvCacheEnabled      = "STEAMPIPE_CACHE"
	EnvCacheTTL          = "STEAMPIPE_CACHE_TTL"
	EnvCacheMaxSize      = "STEAMPIPE_CACHE_MAX_SIZE_MB"
	EnvQueryTimeout      = "STEAMPIPE_QUERY_TIMEOUT"

	EnvConnectionWatcher        = "STEAMPIPE_CONNECTION_WATCHER"
	EnvWorkspaceChDir           = "STEAMPIPE_WORKSPACE_CHDIR"
	EnvModLocation              = "STEAMPIPE_MOD_LOCATION"
	EnvTelemetry                = "STEAMPIPE_TELEMETRY"
	EnvIntrospection            = "STEAMPIPE_INTROSPECTION"
	EnvWorkspaceProfileLocation = "STEAMPIPE_WORKSPACE_PROFILES_LOCATION"
	EnvDiagnostics              = "STEAMPIPE_DIAGNOSTICS"

	// EnvInputVarPrefix is the prefix for environment variables that represent values for input variables.
	EnvInputVarPrefix = "SP_VAR_"
)

Environment Variables

const (
	ExitCodeSuccessful                   = 0
	ExitCodeUnknownErrorPanic            = 1
	ExitCodeInsufficientOrWrongArguments = 2
	ExitCodeLoadingError                 = 3
	ExitCodePluginListFailure            = 4
	ExitCodeNoModFile                    = 15
	ExitCodeBindPortUnavailable          = 31
)

const (
	PluginExtension        = ".plugin"
	ConfigExtension        = ".spc"
	SqlExtension           = ".sql"
	MarkdownExtension      = ".md"
	ModDataExtension       = ".sp"
	VariablesExtension     = ".spvars"
	AutoVariablesExtension = ".auto.spvars"
	JsonExtension          = ".json"
	CsvExtension           = ".csv"
	TextExtension          = ".txt"
	SnapshotExtension      = ".sps"
	TokenExtension         = ".sptt"
)

const (
	HistoryFile = "history.json" // File to store historical data
	HistorySize = 500            // Number of historical records to store
)

Constants for History

const (
	IntrospectionNone    = "none"
	IntrospectionInfo    = "info"
	IntrospectionControl = "control"
)

constants for introspection config flag

const (
	CmdTableList        = ".tables"             // List all tables
	CmdOutput           = ".output"             // Set output mode
	CmdTiming           = ".timing"             // Toggle query timer
	CmdHeaders          = ".header"             // Toggle headers output
	CmdSeparator        = ".separator"          // Set the column separator
	CmdExit             = ".exit"               // Exit the interactive prompt
	CmdQuit             = ".quit"               // Alias for .exit
	CmdInspect          = ".inspect"            // inspect
	CmdConnections      = ".connections"        // list all connections
	CmdMulti            = ".multi"              // toggle multi line query
	CmdClear            = ".clear"              // clear the console
	CmdHelp             = ".help"               // list all meta commands
	CmdSearchPath       = ".search_path"        // Set or show search-path
	CmdSearchPathPrefix = ".search_path_prefix" // set search path prefix
	CmdCache            = ".cache"              // cache control
	CmdAutoComplete     = ".autocomplete"       // enable or disable auto complete
)

const (
	OutputFormatCSV           = "csv"
	OutputFormatJSON          = "json"
	OutputFormatTable         = "table"
	OutputFormatLine          = "line"
	OutputFormatNone          = "none"
	OutputFormatText          = "text"
	OutputFormatBrief         = "brief"
	OutputFormatSnapshot      = "snapshot"
	OutputFormatSnapshotShort = "sps"
)

const (
	ArchAMD64 = "amd64"
	ArchARM64 = "arm64"
	OSLinux   = "linux"
	OSDarwin  = "darwin"
)

const (
	PluginAlreadyInstalled       = "Already installed"
	PluginLatestAlreadyInstalled = "Latest already installed"
	PluginNotInstalled           = "Not installed"
	PluginNotFound               = "Not found"
)

const (
	ServerCertKey = "server.key"
	RootCertKey   = "root.key"
	ServerCert    = "server.crt"
	RootCert      = "root.crt"
	SslConfDir    = "/etc/ssl"
)

constants for ssl key and certificate

const (
	TelemetryNone = "none"
	TelemetryInfo = "info"
)

constants for telemetry config flag

const (
	DefaultCloudHost         = "cloud.steampipe.io"
	DefaultWorkspaceDatabase = "local"
)

const DefaultConnectionConfigContent = `` /* 971-byte string literal not displayed */

DefaultConnectionConfigContent is the content of the default connection config file, default.spc, that is created if it does not exist

const DefaultMaxCacheSizeMb = 16384

const MaxPreparedStatementNameLength = 63

const PostgresqlConfContent = `` /* 810-byte string literal not displayed */

const PreparedStatementCardSuffix = "_cd"

const PreparedStatementChartSuffix = "_ch"

const PreparedStatementControlSuffix = "_c"

const PreparedStatementFlowSuffix = "_f"

const PreparedStatementGraphSuffix = "_g"

const PreparedStatementHierarchySuffix = "_h"

const PreparedStatementImageSuffix = "_im"

const PreparedStatementInputSuffix = "_ip"

const PreparedStatementQuerySuffix = "_q"

const PreparedStatementTableSuffix = "_t"

const SteampipeConfContent = `` /* 1552-byte string literal not displayed */

Variables

var (
	// OptLeftArrowASCIICode ::
	OptLeftArrowASCIICode = []byte{0x1b, 0x62}
	// OptRightArrowASCIICode ::
	OptRightArrowASCIICode = []byte{0x1b, 0x66}
	// AltLeftArrowASCIICode ::
	AltLeftArrowASCIICode = []byte{0x1b, 0x1b, 0x5B, 0x44}
	// AltRightArrowASCIICode ::
	AltRightArrowASCIICode = []byte{0x1b, 0x1b, 0x5B, 0x43}
)

var (
	DashboardServiceStartTimeout = 30 * time.Second
	DBConnectionTimeout          = 5 * time.Second
	ServicePingInterval          = 50 * time.Millisecond
)

var ArgAutoComplete = ArgFromMetaquery(CmdAutoComplete)

var ArgHeader = ArgFromMetaquery(CmdHeaders)

var ArgMultiLine = ArgFromMetaquery(CmdMulti)

var ArgOutput = ArgFromMetaquery(CmdOutput)

var ArgSeparator = ArgFromMetaquery(CmdSeparator)

var Black = aurora.Black

var Blink = aurora.Blink

var Blue = aurora.Blue

var Bold = aurora.Bold

var BrightBlack = aurora.BrightBlack

var BrightBlue = aurora.BrightBlue

var BrightCyan = aurora.BrightCyan

var BrightGreen = aurora.BrightGreen

var BrightMagenta = aurora.BrightMagenta

var BrightRed = aurora.BrightRed

var BrightWhite = aurora.BrightWhite

var BrightYellow = aurora.BrightYellow

var Colors = map[string]func(arg interface{}) aurora.Value{
	"bold":       Bold,
	"italic":     Italic,
	"underline":  Underline,
	"slow-blink": SlowBlink,

	"black":   Black,
	"red":     Red,
	"green":   Green,
	"yellow":  Yellow,
	"blue":    Blue,
	"magenta": Magenta,
	"cyan":    Cyan,
	"white":   White,

	"bold-black":   BoldBlack,
	"bold-red":     BoldRed,
	"bold-green":   BoldGreen,
	"bold-yellow":  BoldYellow,
	"bold-blue":    BoldBlue,
	"bold-magenta": BoldMagenta,
	"bold-cyan":    BoldCyan,
	"bold-white":   BoldWhite,

	"bright-black":   BrightBlack,
	"bright-red":     BrightRed,
	"bright-green":   BrightGreen,
	"bright-yellow":  BrightYellow,
	"bright-blue":    BrightBlue,
	"bright-magenta": BrightMagenta,
	"bright-cyan":    BrightCyan,
	"bright-white":   BrightWhite,

	"bold-bright-black":   BoldBrightBlack,
	"bold-bright-red":     BoldBrightRed,
	"bold-bright-green":   BoldBrightGreen,
	"bold-bright-yellow":  BoldBrightYellow,
	"bold-bright-blue":    BoldBrightBlue,
	"bold-bright-magenta": BoldBrightMagenta,
	"bold-bright-cyan":    BoldBrightCyan,
	"bold-bright-white":   BoldBrightWhite,

	"gray1": Gray1,
	"gray2": Gray2,
	"gray3": Gray3,
	"gray4": Gray4,
	"gray5": Gray5,
}

Colors is a map of string to aurora colour value

var ConnectionConfigExtensions = append(YamlExtensions, ConfigExtension, JsonExtension)

var Cyan = aurora.Cyan

var (
	DashboardAssetsImageRef = fmt.Sprintf(DashboardAssetsImageRefFormat, version.VersionString)
)

var DatabaseListenAddresses = []string{"localhost", "127.0.0.1"}

DatabaseListenAddresses is an arrays is listen addresses which Steampipe accepts

var Functions = []schema.SQLFunc{
	{
		Name:     "glob",
		Params:   map[string]string{"input_glob": "text"},
		Returns:  "text",
		Language: "plpgsql",
		Body: `
declare
	output_pattern text;
begin
	output_pattern = replace(input_glob, '*', '%');
	output_pattern = replace(output_pattern, '?', '_');
	return output_pattern;
end;
`,
	},
}

Functions :: a list of SQLFunc objects that are installed in the db 'internal' schema startup

var Green = aurora.Green

var Italic = aurora.Italic

var Magenta = aurora.Magenta

var MinimalPgHbaContent string = `
hostssl all root samehost trust
host all root samehost trust
`

var PgHbaTemplate string = `` /* 1099-byte string literal not displayed */

PgHbaTemplate is to be formatted with two variables:

• databaseName
• username

Example:

fmt.Sprintf(template, datName, username)

var Red = aurora.Red

var ReservedConnectionNames = []string{
	"public",
	FunctionSchema,
}

var SlowBlink = aurora.SlowBlink

var TelemetryLevels = []string{TelemetryNone, TelemetryInfo}

var Underline = aurora.Underline

var White = aurora.White

var YamlExtensions = []string{".yml", ".yaml"}

var Yellow = aurora.Yellow

Functions

func ArgFromMetaquery

func ArgFromMetaquery(cmd string) string

ArgFromMetaquery converts a metaquery of form '.header' into the config argument used to set the mode, i.e. 'header'

func BoldBlack

func BoldBlack(arg interface{}) aurora.Value

func BoldBlue

func BoldBlue(arg interface{}) aurora.Value

func BoldBrightBlack

func BoldBrightBlack(arg interface{}) aurora.Value

func BoldBrightBlue

func BoldBrightBlue(arg interface{}) aurora.Value

func BoldBrightCyan

func BoldBrightCyan(arg interface{}) aurora.Value

func BoldBrightGreen

func BoldBrightGreen(arg interface{}) aurora.Value

func BoldBrightMagenta

func BoldBrightMagenta(arg interface{}) aurora.Value

func BoldBrightRed

func BoldBrightRed(arg interface{}) aurora.Value

func BoldBrightWhite

func BoldBrightWhite(arg interface{}) aurora.Value

func BoldBrightYellow

func BoldBrightYellow(arg interface{}) aurora.Value

func BoldCyan

func BoldCyan(arg interface{}) aurora.Value

func BoldGreen

func BoldGreen(arg interface{}) aurora.Value

func BoldMagenta

func BoldMagenta(arg interface{}) aurora.Value

func BoldRed

func BoldRed(arg interface{}) aurora.Value

func BoldWhite

func BoldWhite(arg interface{}) aurora.Value

func BoldYellow

func BoldYellow(arg interface{}) aurora.Value

func BoolToEnableDisable

func BoolToEnableDisable(val bool) string

BoolToEnableDisable converts a boolean value onto the string "enable" or "disable"

func BoolToOnOff

func BoolToOnOff(val bool) string

BoolToOnOff converts a boolean value onto the string "on" or "off"

func Gray1

func Gray1(arg interface{}) aurora.Value

func Gray2

func Gray2(arg interface{}) aurora.Value

func Gray3

func Gray3(arg interface{}) aurora.Value

func Gray4

func Gray4(arg interface{}) aurora.Value

func Gray5

func Gray5(arg interface{}) aurora.Value

func IsYamlExtension

func IsYamlExtension(ext string) bool

Types

type Invoker

type Invoker string

Invoker is a pseudoEnum for the command/operation which starts the service

func (Invoker) IsValid

func (i Invoker) IsValid() error

IsValid is a validator for Invoker known values