workspace

package
v0.24.2 Latest Latest
Warning

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

 Go to latest Published: Sep 13, 2024 License: AGPL-3.0 Imports: 43 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrorNoModDefinition = fmt.Errorf("This command requires a mod definition file (mod.sp) - could not find in the current directory tree.\n\nYou can either clone a mod repository or install a mod using %s and run this command from the cloned/installed mod directory.\nPlease refer to: https://steampipe.io/docs/mods/overview", constants.Bold("steampipe mod install"))
)
View Source 
var EventCount int64 = 0

Functions

func EnsureSessionData 

func EnsureSessionData(ctx context.Context, source *modconfig.ResourceMaps, conn *pgx.Conn) error

EnsureSessionData determines whether introspection tables exists for this session, and if not, creates them if needed

func FindModFilePath added in v0.21.0 

func FindModFilePath(folder string) (string, error)

FindModFilePath looks in the current folder for mod.sp if not found it looks in the parent folder - right up to the root

func HomeDirectoryModfileCheck added in v0.21.0 

func HomeDirectoryModfileCheck(ctx context.Context, workspacePath string) error

func LoadResourceNames 

func LoadResourceNames(ctx context.Context, workspacePath string) (*modconfig.WorkspaceResources, error)

LoadResourceNames builds lists of all workspace resource names

func LoadVariables 

func LoadVariables(ctx context.Context, workspacePath string) ([]*modconfig.Variable, error_helpers.ErrorAndWarnings)

LoadVariables creates a Workspace and uses it to load all variables, ignoring any value resolution errors this is use for the variable list command

Types

type Workspace 

type Workspace struct {
	Path                string
	ModInstallationPath string
	Mod                 *modconfig.Mod

	Mods map[string]*modconfig.Mod
	// the input variables used in the parse
	VariableValues map[string]string
	CloudMetadata  *steampipeconfig.CloudMetadata

	// source snapshot paths
	// if this is set, no other mod resources are loaded and
	// the ResourceMaps returned by GetModResources will contain only the snapshots
	SourceSnapshots []string
	// contains filtered or unexported fields
}

func LoadWorkspacePromptingForVariables added in v0.17.0 

func LoadWorkspacePromptingForVariables(ctx context.Context) (*Workspace, error_helpers.ErrorAndWarnings)

func LoadWorkspaceVars added in v0.21.5 

func LoadWorkspaceVars(ctx context.Context) (*Workspace, *modconfig.ModVariableMap, error_helpers.ErrorAndWarnings)

LoadWorkspaceVars creates a Workspace and loads the variables

func (*Workspace) CheckRequiredPluginsInstalled 

func (w *Workspace) CheckRequiredPluginsInstalled(ctx context.Context) error

func (*Workspace) Close 

func (w *Workspace) Close()

func (*Workspace) GetQueriesFromArgs 

func (w *Workspace) GetQueriesFromArgs(args []string) ([]*modconfig.ResolvedQuery, error)

GetQueriesFromArgs retrieves queries from args

For each arg check if it is a named query or a file, before falling back to treating it as sql

func (*Workspace) GetQueryProvider added in v0.17.0 

func (w *Workspace) GetQueryProvider(queryName string) (modconfig.QueryProvider, bool)

func (*Workspace) GetResource added in v0.19.0 

func (w *Workspace) GetResource(parsedName *modconfig.ParsedResourceName) (resource modconfig.HclResource, found bool)

func (*Workspace) GetResourceMaps 

func (w *Workspace) GetResourceMaps() *modconfig.ResourceMaps

GetResourceMaps implements ResourceMapsProvider

func (*Workspace) LoadWorkspaceMod added in v0.21.5 

func (w *Workspace) LoadWorkspaceMod(ctx context.Context, inputVariables *modconfig.ModVariableMap) error_helpers.ErrorAndWarnings

func (*Workspace) ModfileExists 

func (w *Workspace) ModfileExists() bool

func (*Workspace) PopulateVariables added in v0.21.7 

func (w *Workspace) PopulateVariables(ctx context.Context) (*modconfig.ModVariableMap, error_helpers.ErrorAndWarnings)

func (*Workspace) PublishDashboardEvent 

func (w *Workspace) PublishDashboardEvent(ctx context.Context, e dashboardevents.DashboardEvent)

func (*Workspace) RegisterDashboardEventHandler 

func (w *Workspace) RegisterDashboardEventHandler(ctx context.Context, handler dashboardevents.DashboardEventHandler)

RegisterDashboardEventHandler starts the event handler goroutine if necessary and adds the event handler to our list

func (*Workspace) ResolveQueryAndArgsFromSQLString 

func (w *Workspace) ResolveQueryAndArgsFromSQLString(sqlString string) (*modconfig.ResolvedQuery, modconfig.QueryProvider, error)

ResolveQueryAndArgsFromSQLString attempts to resolve 'arg' to a query and query args

func (*Workspace) ResolveQueryFromQueryProvider 

func (w *Workspace) ResolveQueryFromQueryProvider(queryProvider modconfig.QueryProvider, runtimeArgs *modconfig.QueryArgs) (*modconfig.ResolvedQuery, error)

ResolveQueryFromQueryProvider resolves the query for the given QueryProvider

func (*Workspace) SetOnFileWatcherEventMessages 

func (w *Workspace) SetOnFileWatcherEventMessages(f func())

func (*Workspace) SetupWatcher 

func (w *Workspace) SetupWatcher(ctx context.Context, client db_common.Client, errorHandler func(context.Context, error)) error

func (*Workspace) UnregisterDashboardEventHandlers added in v0.17.0 

func (w *Workspace) UnregisterDashboardEventHandlers()

UnregisterDashboardEventHandlers clears all event handlers used when generating multiple snapshots

Source Files

View all Source files

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.