steampipeconfig

package
v0.16.0-rc.5 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 2, 2022 License: AGPL-3.0 Imports: 39 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var ConnectionDataStructVersion int64 = 20211125

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 GetVariableValues 

func GetVariableValues(ctx context.Context, runCtx *parse.RunContext, variableMap *modconfig.ModVariableMap, validate bool) (*modconfig.ModVariableMap, error)

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 LoadVariableDefinitions 

func LoadVariableDefinitions(variablePath string, runCtx *parse.RunContext) (*modconfig.ModVariableMap, error)

func NewConnectionUpdates 

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

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

func ValidatePlugins 

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

Types

type ActorMetadata 

type ActorMetadata struct {
	Id     string `json:"id,omitempty"`
	Handle string `json:"handle,omitempty"`
}

type CloudMetadata 

type CloudMetadata struct {
	Actor            *ActorMetadata     `json:"actor,omitempty"`
	Identity         *IdentityMetadata  `json:"identity,omitempty"`
	Workspace        *WorkspaceMetadata `json:"workspace,omitempty"`
	ConnectionString string             `json:"-"`
}

func NewCloudMetadata 

func NewCloudMetadata() *CloudMetadata

type ConnectionData 

type ConnectionData struct {
	StructVersion int64 `json:"struct_version,omitempty"`
	// the fully qualified name of the plugin
	Plugin string `json:"plugin,omitempty"`
	// the underlying connection object
	Connection *modconfig.Connection `json:"connection,omitempty"`
	// schema mode - static or dynamic
	SchemaMode string `json:"schema_mode,omitempty"`
	// the hash of the connection schema
	SchemaHash string `json:"schema_hash,omitempty"`
	// the creation time of the plugin file (only used for local plugins)
	ModTime time.Time `json:"mod_time"`

	// legacy properties included for backwards compatibility with v0.13
	LegacyPlugin     string                `json:"Plugin,omitempty"`
	LegacyConnection *modconfig.Connection `json:"Connection,omitempty"`
	LegacySchemaMode string                `json:"SchemaMode,omitempty"`
	LegacySchemaHash string                `json:"SchemaHash,omitempty"`
	LegacyModTime    time.Time             `json:"ModTime,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, connection *modconfig.Connection, creationTime time.Time) *ConnectionData

func (*ConnectionData) Equals 

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

func (*ConnectionData) IsValid 

func (s *ConnectionData) IsValid() bool

IsValid checks whether the struct was correctly deserialized, by checking if the StructVersion is populated

func (*ConnectionData) MaintainLegacy 

func (s *ConnectionData) MaintainLegacy()

MaintainLegacy keeps the values of the legacy properties intact while refreshing connections

func (*ConnectionData) MigrateLegacy 

func (s *ConnectionData) MigrateLegacy()

MigrateLegacy migrates the legacy properties into new properties

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 populates 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

func (*ConnectionDataMap) IsValid 

func (s *ConnectionDataMap) IsValid() bool

IsValid checks whether the struct was correctly deserialized, by checking if the ConnectionData StructVersion is populated

func (*ConnectionDataMap) MigrateFrom 

func (s *ConnectionDataMap) MigrateFrom() migrate.Migrateable

func (*ConnectionDataMap) Save 

func (f *ConnectionDataMap) Save() error

type ConnectionPlugin 

type ConnectionPlugin struct {
	// map of connection data (name, config, options)
	// keyed by connection name
	ConnectionMap       map[string]*ConnectionPluginData
	PluginName          string
	PluginClient        *sdkgrpc.PluginClient
	SupportedOperations *proto.SupportedOperations
}

ConnectionPlugin is a structure representing an instance of a plugin for non-legacy plugins, each plugin instance supportds multiple connections the config, options and schema for each connection is stored in ConnectionMap

func NewConnectionPlugin added in v0.16.0 

func NewConnectionPlugin(pluginName string, pluginClient *sdkgrpc.PluginClient, supportedOperations *proto.SupportedOperations) *ConnectionPlugin

func (ConnectionPlugin) IncludesConnection added in v0.16.0 

func (p ConnectionPlugin) IncludesConnection(name string) bool

type ConnectionPluginData added in v0.16.0 

type ConnectionPluginData struct {
	Name    string
	Config  string
	Options *options.Connection
	Schema  *sdkproto.Schema
}

type ConnectionSchemaMap 

type ConnectionSchemaMap map[string][]string

ConnectionSchemaMap is a map of connection to all connections with the same schema

func NewConnectionSchemaMap 

func NewConnectionSchemaMap() (ConnectionSchemaMap, error)

NewConnectionSchemaMap creates a ConnectionSchemaMap for all configured connections it uses the current connection state to determine if a connection has a dynamic schema (NOTE: this will no work for newly added plugins which will not have a state yet - which is why CreateConnectionPlugins loads the schemas for each new plugin and calls NewConnectionSchemaMapForConnections directly, passing the schema modes)

func NewConnectionSchemaMapForConnections 

func NewConnectionSchemaMapForConnections(connections []*modconfig.Connection, schemaModeMap map[string]string) ConnectionSchemaMap

func (ConnectionSchemaMap) UniqueSchemas 

func (c ConnectionSchemaMap) UniqueSchemas() []string

UniqueSchemas returns the unique schemas for all loaded connections

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
}

func (*ConnectionUpdates) HasUpdates 

func (u *ConnectionUpdates) HasUpdates() bool

type IdentityMetadata 

type IdentityMetadata struct {
	Id     string `json:"id,omitempty"`
	Handle string `json:"handle,omitempty"`
	Type   string `json:"type,omitempty"`
}

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(connectionsToCreate []*modconfig.Connection) (requestedConnectionPluginMap map[string]*ConnectionPlugin, res *RefreshConnectionResult)

CreateConnectionPlugins instantiates plugins for specified connections, and fetches schemas

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) ConnectionList 

func (c *SteampipeConfig) ConnectionList() []*modconfig.Connection

func (*SteampipeConfig) ConnectionNames 

func (c *SteampipeConfig) ConnectionNames() []string

ConnectionNames returns a flat list of connection names

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

type WorkspaceMetadata 

type WorkspaceMetadata struct {
	Id     string `json:"id,omitempty"`
	Handle string `json:"handle,omitempty"`
}

Source Files

View all Source files

Directories

Path Synopsis
typeexpr
var_config

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.