workspace

Documentation

Index

• func EnsureSessionData(ctx context.Context, source *SessionDataSource, client db_common.Client) (err error)
• func LoadResourceNames(workspacePath string) (*modconfig.WorkspaceResources, error)
• type ConnectionWatcher
  • func NewConnectionWatcher(invoker constants.Invoker, errorHandler func(error)) (*ConnectionWatcher, error)
  • func (w *ConnectionWatcher) Close()
• type SessionDataSource
  • func NewSessionDataSource(source *modconfig.WorkspaceResourceMaps) *SessionDataSource
• type Workspace
  • func Load(workspacePath string) (*Workspace, error)
  • func (w *Workspace) CheckRequiredPluginsInstalled() error
  • func (w *Workspace) Close()
  • func (w *Workspace) GetChildControls() []*modconfig.Control
  • func (w *Workspace) GetControl(controlName string) (*modconfig.Control, bool)
  • func (w *Workspace) GetControlMap() map[string]*modconfig.Control
  • func (w *Workspace) GetMod(modName string) *modconfig.Mod
  • func (w *Workspace) GetQueriesFromArgs(args []string) ([]string, *modconfig.WorkspaceResourceMaps, error)
  • func (w *Workspace) GetQuery(queryName string) (*modconfig.Query, bool)
  • func (w *Workspace) GetQueryMap() map[string]*modconfig.Query
  • func (w *Workspace) GetResourceMaps() *modconfig.WorkspaceResourceMaps
  • func (w *Workspace) ModList() []*modconfig.Mod
  • func (w *Workspace) PublishReportEvent(e reportevents.ReportEvent)
  • func (w *Workspace) RegisterReportEventHandler(handler reportevents.ReportEventHandler)
  • func (w *Workspace) ResolveControlQuery(control *modconfig.Control) (string, error)
  • func (w *Workspace) ResolveQuery(sqlString string, args *modconfig.QueryArgs) (string, modconfig.PreparedStatementProvider, error)
  • func (w *Workspace) ResolveQueryAndArgs(sqlString string) (string, modconfig.PreparedStatementProvider, error)
  • func (w *Workspace) SaveWorkspaceMod() error
  • func (w *Workspace) SetupWatcher(client db_common.Client, errorHandler func(error)) error

Functions

func EnsureSessionData

func EnsureSessionData(ctx context.Context, source *SessionDataSource, client db_common.Client) (err error)

EnsureSessionData determines whether session scoped data (introspection tables and prepared statements) exists for this session, and if not, creates it

func LoadResourceNames

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

LoadResourceNames builds lists of all workspace respurce names

Types

type ConnectionWatcher

type ConnectionWatcher struct {
	// contains filtered or unexported fields
}

func NewConnectionWatcher

func NewConnectionWatcher(invoker constants.Invoker, errorHandler func(error)) (*ConnectionWatcher, error)

func (*ConnectionWatcher) Close

func (w *ConnectionWatcher) Close()

type SessionDataSource

type SessionDataSource struct {
	PreparedStatementSource, IntrospectionTableSource *modconfig.WorkspaceResourceMaps
}

func NewSessionDataSource

func NewSessionDataSource(source *modconfig.WorkspaceResourceMaps) *SessionDataSource

NewSessionDataSource creates a new SessionDataSource object it defaults to using the same source for prepared statemntrs and introspection tables

type Workspace

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

	// maps of mod resources from this mod and ALL DEPENDENCIES, keyed by long and short names
	Queries    map[string]*modconfig.Query
	Controls   map[string]*modconfig.Control
	Benchmarks map[string]*modconfig.Benchmark
	Mods       map[string]*modconfig.Mod
	Reports    map[string]*modconfig.Report
	Panels     map[string]*modconfig.Panel
	Variables  map[string]*modconfig.Variable
	// contains filtered or unexported fields
}

func Load

func Load(workspacePath string) (*Workspace, error)

Load creates a Workspace and loads the workspace mod

func (*Workspace) CheckRequiredPluginsInstalled

func (w *Workspace) CheckRequiredPluginsInstalled() error

func (*Workspace) Close

func (w *Workspace) Close()

func (*Workspace) GetChildControls

func (w *Workspace) GetChildControls() []*modconfig.Control

GetChildControls builds a flat list of all controls in the worlspace, including dependencies

func (*Workspace) GetControl

func (w *Workspace) GetControl(controlName string) (*modconfig.Control, bool)

func (*Workspace) GetControlMap

func (w *Workspace) GetControlMap() map[string]*modconfig.Control

func (*Workspace) GetMod

func (w *Workspace) GetMod(modName string) *modconfig.Mod

GetMod attempts to return the mod with a name matching 'modName' It first checks the workspace mod, then checks all mod dependencies

func (*Workspace) GetQueriesFromArgs

func (w *Workspace) GetQueriesFromArgs(args []string) ([]string, *modconfig.WorkspaceResourceMaps, 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) GetQuery

func (w *Workspace) GetQuery(queryName string) (*modconfig.Query, bool)

func (*Workspace) GetQueryMap

func (w *Workspace) GetQueryMap() map[string]*modconfig.Query

func (*Workspace) GetResourceMaps

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

GetResourceMaps returns all resource maps NOTE: this function DOES NOT LOCK the load lock so should only be called in a context where the file watcher is not running

func (*Workspace) ModList

func (w *Workspace) ModList() []*modconfig.Mod

ModList returns a flat list of all mods - the workspace mod and depenfency mods

func (*Workspace) PublishReportEvent

func (w *Workspace) PublishReportEvent(e reportevents.ReportEvent)

func (*Workspace) RegisterReportEventHandler

func (w *Workspace) RegisterReportEventHandler(handler reportevents.ReportEventHandler)

func (*Workspace) ResolveControlQuery

func (w *Workspace) ResolveControlQuery(control *modconfig.Control) (string, error)

ResolveControlQuery resolves the query for the given Control

func (*Workspace) ResolveQuery

func (w *Workspace) ResolveQuery(sqlString string, args *modconfig.QueryArgs) (string, modconfig.PreparedStatementProvider, error)

func (*Workspace) ResolveQueryAndArgs

func (w *Workspace) ResolveQueryAndArgs(sqlString string) (string, modconfig.PreparedStatementProvider, error)

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

func (*Workspace) SaveWorkspaceMod

func (w *Workspace) SaveWorkspaceMod() error

SaveWorkspaceMod searialises the workspace mode to <workspace path?.mod.sp

func (*Workspace) SetupWatcher

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