steampipeconfig

Documentation

Index

• Variables
• func BuildValidationWarningString(failures []*ValidationFailure) string
• func GetModFileExtensions() []string
• func LoadMod(modPath string, runCtx *parse.RunContext) (mod *modconfig.Mod, err error)
• func LoadModResourceNames(modPath string, runCtx *parse.RunContext) (resources *modconfig.WorkspaceResources, err error)
• func NewConnectionUpdates(schemaNames []string) (*ConnectionUpdates, *RefreshConnectionResult)
• func SaveConnectionState(state ConnectionDataMap) error
• func ValidatePlugins(updates ConnectionDataMap, plugins map[string]*ConnectionPlugin) ([]*ValidationFailure, ConnectionDataMap, []*ConnectionPlugin)
• type ConnectionData
  • func NewConnectionData(remoteSchema string, checksum string, connection *modconfig.Connection) *ConnectionData
  • func (p *ConnectionData) Equals(other *ConnectionData) bool
• type ConnectionDataMap
  • func GetConnectionState(schemaNames []string) (ConnectionDataMap, error)
  • func NewConnectionDataMap(connectionMap map[string]*modconfig.Connection) (ConnectionDataMap, []string, error)
  • func (m ConnectionDataMap) Connections() []*modconfig.Connection
  • func (m ConnectionDataMap) Equals(other ConnectionDataMap) bool
• type ConnectionPlugin
  • func CreateConnectionPlugin(connection *modconfig.Connection) (res *ConnectionPlugin, err error)
• type ConnectionUpdates
• type RefreshConnectionResult
  • func CreateConnectionPlugins(requiredConnections []*modconfig.Connection, ...) (map[string]*ConnectionPlugin, *RefreshConnectionResult)
  • func (r *RefreshConnectionResult) AddWarning(warning string)
  • func (r *RefreshConnectionResult) Merge(other *RefreshConnectionResult)
  • func (r *RefreshConnectionResult) ShowWarnings()
• type SteampipeConfig
  • func LoadConnectionConfig() (*SteampipeConfig, error)
  • func LoadSteampipeConfig(workspacePath string, commandName string) (*SteampipeConfig, error)
  • func NewSteampipeConfig(commandName string) *SteampipeConfig
  • func (c *SteampipeConfig) ConfigMap() map[string]interface{}
  • func (c *SteampipeConfig) ConnectionsForPlugin(pluginLongName string, pluginVersion *version.Version) []*modconfig.Connection
  • func (c *SteampipeConfig) GetConnectionOptions(connectionName string) *options.Connection
  • func (c *SteampipeConfig) SetOptions(opts options.Options)
  • func (c *SteampipeConfig) String() string
  • func (c *SteampipeConfig) Validate() error
• type ValidationFailure
  • func (v ValidationFailure) String() string

Variables

var ConnectionDataStructVersion int64 = 20211020

ConnectionDataStructVersion is used to force refreshing connections If we need to force a connection refresh (for example if any of the underlying schema generation code changes), updating this version will force all connections to refresh, as the deserialized data will have an old version

Functions

func BuildValidationWarningString

func BuildValidationWarningString(failures []*ValidationFailure) string

func GetModFileExtensions

func GetModFileExtensions() []string

GetModFileExtensions :: return list of all file extensions we care about this will be the mod data extension, plus any registered extensions registered in fileToResourceMap

func LoadMod

func LoadMod(modPath string, runCtx *parse.RunContext) (mod *modconfig.Mod, err error)

LoadMod parses all hcl files in modPath and returns a single mod if CreatePseudoResources flag is set, construct hcl resources for files with specific extensions NOTE: it is an error if there is more than 1 mod defined, however zero mods is acceptable - a default mod will be created assuming there are any resource files

func LoadModResourceNames

func LoadModResourceNames(modPath string, runCtx *parse.RunContext) (resources *modconfig.WorkspaceResources, err error)

LoadModResourceNames parses all hcl files in modPath and returns the names of all resources

func NewConnectionUpdates

func NewConnectionUpdates(schemaNames []string) (*ConnectionUpdates, *RefreshConnectionResult)

NewConnectionUpdates returns updates to be made to the database to sync with connection config

func SaveConnectionState

func SaveConnectionState(state ConnectionDataMap) error

func ValidatePlugins

func ValidatePlugins(updates ConnectionDataMap, plugins map[string]*ConnectionPlugin) ([]*ValidationFailure, ConnectionDataMap, []*ConnectionPlugin)

Types

type ConnectionData

type ConnectionData struct {
	StructVersion int64
	// the fully qualified name of the plugin
	Plugin string
	// the checksum of the plugin file
	CheckSum string
	// the underlying connection object
	Connection *modconfig.Connection
	// schema mode - static or dynamic
	SchemaMode string `json:"SchemaMode,omitempty"`
	// the hash of the connection schema
	SchemaHash string `json:"SchemaHash,omitempty"`
}

ConnectionData is a struct containing all details for a connection - the plugin name and checksum, the connection config and options json tags needed as this is stored in the connection state file

func NewConnectionData

func NewConnectionData(remoteSchema string, checksum string, connection *modconfig.Connection) *ConnectionData

func (*ConnectionData) Equals

func (p *ConnectionData) Equals(other *ConnectionData) bool

type ConnectionDataMap

type ConnectionDataMap map[string]*ConnectionData

func GetConnectionState

func GetConnectionState(schemaNames []string) (ConnectionDataMap, error)

GetConnectionState loads the connection state file, and remove any connections which do not exist in the db

func NewConnectionDataMap

func NewConnectionDataMap(connectionMap map[string]*modconfig.Connection) (ConnectionDataMap, []string, error)

NewConnectionDataMap tries to populate a map of connection data for all connections in connectionMap

func (ConnectionDataMap) Connections

func (m ConnectionDataMap) Connections() []*modconfig.Connection

func (ConnectionDataMap) Equals

func (m ConnectionDataMap) Equals(other ConnectionDataMap) bool

type ConnectionPlugin

type ConnectionPlugin struct {
	ConnectionName      string
	ConnectionConfig    string
	ConnectionOptions   *options.Connection
	PluginName          string
	PluginClient        *sdkgrpc.PluginClient
	Schema              *sdkproto.Schema
	SupportedOperations *sdkproto.GetSupportedOperationsResponse
}

ConnectionPlugin is a structure representing an instance of a plugin NOTE: currently this corresponds to a single steampipe connection, i.e. we have 1 plugin instance per steampipe connection

func CreateConnectionPlugin

func CreateConnectionPlugin(connection *modconfig.Connection) (res *ConnectionPlugin, err error)

CreateConnectionPlugin instantiates a plugin for a connection, fetches schema and sends connection config

type ConnectionUpdates

type ConnectionUpdates struct {
	Update         ConnectionDataMap
	Delete         ConnectionDataMap
	MissingPlugins []string
	// the connections which will exist after the update
	RequiredConnectionState ConnectionDataMap
	// connection plugins required to perform the updates
	ConnectionPlugins map[string]*ConnectionPlugin
	// contains filtered or unexported fields
}

type RefreshConnectionResult

type RefreshConnectionResult struct {
	UpdatedConnections bool
	Warnings           []string
	Error              error
}

RefreshConnectionResult is a structure used to contain the result of either a RefreshConnections or a NewLocalClient operation

func CreateConnectionPlugins

func CreateConnectionPlugins(requiredConnections []*modconfig.Connection, alreadyLoaded map[string]*ConnectionPlugin) (map[string]*ConnectionPlugin, *RefreshConnectionResult)

func (*RefreshConnectionResult) AddWarning

func (r *RefreshConnectionResult) AddWarning(warning string)

func (*RefreshConnectionResult) Merge

func (r *RefreshConnectionResult) Merge(other *RefreshConnectionResult)

func (*RefreshConnectionResult) ShowWarnings

func (r *RefreshConnectionResult) ShowWarnings()

type SteampipeConfig

type SteampipeConfig struct {
	// map of connection name to partially parsed connection config
	Connections map[string]*modconfig.Connection

	// Steampipe options
	DefaultConnectionOptions *options.Connection
	DatabaseOptions          *options.Database
	TerminalOptions          *options.Terminal
	GeneralOptions           *options.General
	// contains filtered or unexported fields
}

SteampipeConfig is a struct to hold Connection map and Steampipe options

var GlobalConfig *SteampipeConfig

func LoadConnectionConfig

func LoadConnectionConfig() (*SteampipeConfig, error)

LoadConnectionConfig loads the connection config but not the workspace options this is called by the fdw

func LoadSteampipeConfig

func LoadSteampipeConfig(workspacePath string, commandName string) (*SteampipeConfig, error)

LoadSteampipeConfig loads the HCL connection config and workspace options

func NewSteampipeConfig

func NewSteampipeConfig(commandName string) *SteampipeConfig

func (*SteampipeConfig) ConfigMap

func (c *SteampipeConfig) ConfigMap() map[string]interface{}

ConfigMap creates a config map to pass to viper

func (*SteampipeConfig) ConnectionsForPlugin

func (c *SteampipeConfig) ConnectionsForPlugin(pluginLongName string, pluginVersion *version.Version) []*modconfig.Connection

func (*SteampipeConfig) GetConnectionOptions

func (c *SteampipeConfig) GetConnectionOptions(connectionName string) *options.Connection

func (*SteampipeConfig) SetOptions

func (c *SteampipeConfig) SetOptions(opts options.Options)

func (*SteampipeConfig) String

func (c *SteampipeConfig) String() string

func (*SteampipeConfig) Validate

func (c *SteampipeConfig) Validate() error

type ValidationFailure

type ValidationFailure struct {
	Plugin             string
	ConnectionName     string
	Message            string
	ShouldDropIfExists bool
}

func (ValidationFailure) String

func (v ValidationFailure) String() string