constants

Documentation

Index

• Constants
• Variables
• func ConfigDir() string
• func ConnectionStatePath() string
• func DatabaseDir() string
• func InternalDir() string
• func ModsDir() string
• func PluginDir() string
• func SteampipeDir() string

Constants

const (
	APPNAME = "steampipe"
	// SpinnerShowTimeout :: duration after which spinner should be shown
	SpinnerShowTimeout = 100 * time.Millisecond
)

Application constants

const (
	ValJSON  = "json"
	ValTable = "table"
	ValCSV   = "csv"
	ValOn    = "on"
	ValOff   = "off"
)

Argument values

const (
	ArgConfig            = "config"
	ArgNullString        = "null-string"
	ArgJSON              = "json"
	ArgPretty            = "pretty"
	ArgCSV               = "csv"
	ArgSeparator         = "separator"
	ArgOutput            = "output"
	ArgHeader            = "header"
	ArgMultiLine         = "multi"
	ArgListAllTableNames = "L"
	ArgSelectAll         = "A"
	ArgModPath           = "mod-path"
	ArgWatch             = "watch"
	ArgForce             = "force"
	ArgTimer             = "timing"
)

Argument name constants

const (
	SteampipeDirName         = ".steampipe"
	PluginExtension          = ".plugin"
	DefaultConfigFileName    = "config.yml"
	ConfigExtension          = ".spc"
	ConnectionsStateFileName = "connection.json"
)

Constants for Config

const (
	DatabaseHost      = "localhost"
	DatabasePort      = 9193
	DatabaseSuperUser = "root"
	DatabaseUser      = "steampipe"
	DatabaseName      = "steampipe"
)

const (
	DatabaseVersion = "12.1.0"
	FdwVersion      = "0.0.21"

	// The 12.1.0 image uses the older jar format 12.1.0-v2 is the same version of postgres,
	// just packaged as gzipped tar files (consistent with oras, faster to unzip).  Once everyone is
	// on a newer build, we can delete the old image move the 12.1.0 tag to the new image, and
	// change this back for consistency
	//DefaultEmbeddedPostgresImage = "us-docker.pkg.dev/steampipe/steampipe/db:" + DatabaseVersion
	DefaultEmbeddedPostgresImage = "us-docker.pkg.dev/steampipe/steampipe/db:12.1.0-v2"
	DefaultFdwImage              = "us-docker.pkg.dev/steampipe/steampipe/fdw:" + FdwVersion
)

constants for installing db and fdw images

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

Constants for History

const (
	ModDataExtension = "sp"
)

mod related constants

const PgHbaContent = `` /* 5133-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 Bold = color.New(color.Bold).SprintFunc()

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

Arrays cannot be constants, so do the next most convenient thing

Functions

func ConfigDir

func ConfigDir() string

ConfigDir :: returns the path to the config directory (creates if missing)

func ConnectionStatePath

func ConnectionStatePath() string

ConnectionStatePath :: returns the path of the connections state file

func DatabaseDir

func DatabaseDir() string

DatabaseDir :: returns the path to the db directory (creates if missing)

func InternalDir

func InternalDir() string

InternalDir :: returns the path to the internal directory (creates if missing)

func ModsDir

func ModsDir() string

ModsDir :: returns the path to the mods directory (creates if missing)

func PluginDir

func PluginDir() string

PluginDir :: returns the path to the plugins directory (creates if missing)

func SteampipeDir

func SteampipeDir() string

SteampipeDir :: returns the top level ~/.steampipe folder (creates if it doesnt exist)