modconfig

package
v0.23.0-alpha.7 Latest Latest
Warning

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

 Go to latest Published: Apr 26, 2024 License: AGPL-3.0 Imports: 38 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// require blocks
	BlockTypeSteampipe = "steampipe"
	BlockTypeMod       = "mod"
	// resource blocks
	BlockTypeQuery          = "query"
	BlockTypeControl        = "control"
	BlockTypeBenchmark      = "benchmark"
	BlockTypeDashboard      = "dashboard"
	BlockTypeContainer      = "container"
	BlockTypeChart          = "chart"
	BlockTypeCard           = "card"
	BlockTypeFlow           = "flow"
	BlockTypeGraph          = "graph"
	BlockTypeHierarchy      = "hierarchy"
	BlockTypeImage          = "image"
	BlockTypeInput          = "input"
	BlockTypeTable          = "table"
	BlockTypeText           = "text"
	BlockTypeLocals         = "locals"
	BlockTypeVariable       = "variable"
	BlockTypeParam          = "param"
	BlockTypeRequire        = "require"
	BlockTypeNode           = "node"
	BlockTypeEdge           = "edge"
	BlockTypeLegacyRequires = "requires"
	BlockTypeCategory       = "category"
	BlockTypeWith           = "with"

	// config blocks
	BlockTypeRateLimiter      = "limiter"
	BlockTypePlugin           = "plugin"
	BlockTypeConnection       = "connection"
	BlockTypeOptions          = "options"
	BlockTypeWorkspaceProfile = "workspace"

	ResourceTypeSnapshot = "snapshot"
	AttributeArgs        = "args"
	AttributeQuery       = "query"
)

NOTE: when adding a block type, be sure to update QueryProviderBlocks/ReferenceBlocks/AllBlockTypes as needed

View Source 
const (
	ConnectionTypePlugin     = "plugin"
	ConnectionTypeAggregator = "aggregator"
	ImportSchemaEnabled      = "enabled"
	ImportSchemaDisabled     = "disabled"
)
View Source 
const (
	LimiterSourceConfig     = "config"
	LimiterSourcePlugin     = "plugin"
	LimiterStatusActive     = "active"
	LimiterStatusOverridden = "overridden"
)
View Source 
const RuntimeDependencyDashboardScope = "self"
View Source 
const SnapshotQueryTableName = "custom.table.results"

Variables

View Source 
var NodeAndEdgeProviderBlocks = []string{
	BlockTypeHierarchy,
	BlockTypeFlow,
	BlockTypeGraph,
}

NodeAndEdgeProviderBlocks is a list of block types which implementnodeAndEdgeProvider

View Source 
var QueryProviderBlocks = []string{
	BlockTypeCard,
	BlockTypeChart,
	BlockTypeControl,
	BlockTypeEdge,
	BlockTypeFlow,
	BlockTypeGraph,
	BlockTypeHierarchy,
	BlockTypeImage,
	BlockTypeInput,
	BlockTypeQuery,
	BlockTypeNode,
	BlockTypeTable,
	BlockTypeWith,
}

QueryProviderBlocks is a list of block types which implement QueryProvider

View Source 
var ReferenceBlocks = []string{
	BlockTypeMod,
	BlockTypeQuery,
	BlockTypeControl,
	BlockTypeBenchmark,
	BlockTypeDashboard,
	BlockTypeContainer,
	BlockTypeCard,
	BlockTypeChart,
	BlockTypeFlow,
	BlockTypeGraph,
	BlockTypeHierarchy,
	BlockTypeImage,
	BlockTypeInput,
	BlockTypeTable,
	BlockTypeText,
	BlockTypeParam,
	BlockTypeCategory,
	BlockTypeWith,
}

ReferenceBlocks is a list of block types we store references for

View Source 
var ResourceTypeMap = map[string]factoryFunc{
	constants.SqlExtension: func(modPath, filePath string, mod *Mod) (MappableResource, []byte, error) {
		return QueryFromFile(modPath, filePath, mod)
	},
}
View Source 
var ValidImportSchemaValues = []string{ImportSchemaEnabled, ImportSchemaDisabled}
View Source 
var ValidResourceItemTypes = []string{
	BlockTypeMod,
	BlockTypeQuery,
	BlockTypeControl,
	BlockTypeBenchmark,
	BlockTypeDashboard,
	BlockTypeContainer,
	BlockTypeChart,
	BlockTypeCard,
	BlockTypeFlow,
	BlockTypeGraph,
	BlockTypeHierarchy,
	BlockTypeImage,
	BlockTypeInput,
	BlockTypeTable,
	BlockTypeText,
	BlockTypeLocals,
	BlockTypeVariable,
	BlockTypeParam,
	BlockTypeRequire,
	BlockTypeNode,
	BlockTypeEdge,
	BlockTypeLegacyRequires,
	BlockTypeCategory,
	BlockTypeConnection,
	BlockTypeOptions,
	BlockTypeWorkspaceProfile,
	BlockTypeWith,

	"local",

	"ref",

	"var",
}

Functions

func BuildFullResourceName added in v0.17.0 

func BuildFullResourceName(mod, blockType, name string) (string, error)

BuildFullResourceName generates a fully qualified name from the given components e.g: aws_compliance.benchmark.cis_v150_1

func BuildModDependencyPath added in v0.20.0 

func BuildModDependencyPath(dependencyName string, version *semver.Version) string

BuildModDependencyPath converts a mod dependency name of form github.com/turbot/steampipe-mod-m2 

and a version into a dependency path of form github.com/turbot/steampipe-mod-m2@v1.0.0

func BuildModResourceName 

func BuildModResourceName(blockType, name string) string

func GetCtyTypes 

func GetCtyTypes(item interface{}) map[string]cty.Type

GetCtyTypes builds a map of cty types for all tagged properties. It is used to convert the struct to a cty value

func GetCtyValue added in v0.19.0 

func GetCtyValue(item interface{}) (cty.Value, error)

GetCtyValue converts the item into a cty value

func IsValidResourceItemType added in v0.17.0 

func IsValidResourceItemType(blockType string) bool

func ParseModDependencyPath added in v0.20.0 

func ParseModDependencyPath(fullName string) (modDependencyName string, modVersion *semver.Version, err error)

ParseModDependencyPath converts a mod depdency path of form github.com/turbot/steampipe-mod-m2@v1.0.0 into the dependency name (github.com/turbot/steampipe-mod-m2) and version

func PseudoResourceNameFromPath 

func PseudoResourceNameFromPath(modPath, filePath string) (string, error)

PseudoResourceNameFromPath converts a filepath into a resource name

It operates as follows:

  1. get filename
  2. remove extension
  3. sluggify, with '_' as the divider

func RegisteredFileExtensions 

func RegisteredFileExtensions() []string

func ResolveArgs added in v0.19.0 

func ResolveArgs(qp QueryProvider, runtimeArgs *QueryArgs) ([]any, error)

ResolveArgs resolves the argument values, falling back on defaults from param definitions in the source (if present) it returns the arg values as a csv string which can be used in a query invocation (the arg values and param defaults will already have been converted to postgres format)

func ResolvePluginImageRef added in v0.21.0 

func ResolvePluginImageRef(pluginAlias string) string

ResolvePluginImageRef resolves the plugin image ref from the plugin alias (this handles the special case of locally developed plugins in the plugins/local folder)

func UnqualifiedResourceName 

func UnqualifiedResourceName(fullName string) string

UnqualifiedResourceName removes the mod prefix from the given name

Types

type Benchmark 

type Benchmark struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	// child names as NamedItem structs - used to allow setting children via the 'children' property
	ChildNames NamedItemList `cty:"child_names" json:"-"`
	// used for introspection tables
	ChildNameStrings []string `cty:"child_name_strings" column:"children,jsonb" json:"-"`

	// dashboard specific properties
	Base    *Benchmark `hcl:"base" json:"-"`
	Width   *int       `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string    `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string    `cty:"display" hcl:"display" json:"-"`
}

Benchmark is a struct representing the Benchmark resource

func (*Benchmark) CtyValue 

func (b *Benchmark) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Benchmark) Diff 

func (b *Benchmark) Diff(other *Benchmark) *DashboardTreeItemDiffs

func (*Benchmark) Equals 

func (b *Benchmark) Equals(other *Benchmark) bool

func (*Benchmark) GetChildControls 

func (b *Benchmark) GetChildControls() []*Control

GetChildControls return a flat list of controls underneath the benchmark in the tree

func (*Benchmark) GetDisplay 

func (b *Benchmark) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*Benchmark) GetType 

func (b *Benchmark) GetType() string

GetType implements DashboardLeafNode

func (*Benchmark) GetUnqualifiedName 

func (b *Benchmark) GetUnqualifiedName() string

GetUnqualifiedName implements DashboardLeafNode, ModTreeItem

func (*Benchmark) GetWidth 

func (b *Benchmark) GetWidth() int

GetWidth implements DashboardLeafNode

func (*Benchmark) OnDecoded 

func (b *Benchmark) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*Benchmark) SetChildren added in v0.19.0 

func (b *Benchmark) SetChildren(children []ModTreeItem)

func (*Benchmark) String 

func (b *Benchmark) String() string

func (*Benchmark) WalkResources added in v0.16.0 

func (b *Benchmark) WalkResources(resourceFunc func(resource ModTreeItem) (bool, error)) error

type ConfigMap added in v0.17.0 

type ConfigMap map[string]interface{}

func (ConfigMap) PopulateConfigMapForOptions added in v0.17.0 

func (m ConfigMap) PopulateConfigMapForOptions(o options.Options)

PopulateConfigMapForOptions populates the config map for a given options object NOTE: this mutates configMap

func (ConfigMap) SetBoolItem added in v0.20.0 

func (m ConfigMap) SetBoolItem(argValue *bool, argName string)

SetBoolItem checks is bool pointer is non-nil and if so, add to map with given key

func (ConfigMap) SetIntItem added in v0.17.0 

func (m ConfigMap) SetIntItem(argValue *int, argName string)

SetIntItem checks is int pointer is non-nil and if so, add to map with given key

func (ConfigMap) SetStringItem added in v0.17.0 

func (m ConfigMap) SetStringItem(argValue *string, argName string)

SetStringItem checks is string pointer is non-nil and if so, add to map with given key

func (ConfigMap) SetStringSliceItem added in v0.20.0 

func (m ConfigMap) SetStringSliceItem(argValue []string, argName string)

SetStringSliceItem checks is string slice pointer is non-nil and if so, add to map with given key

type Connection 

type Connection struct {
	// connection name
	Name string `json:"name"`
	// name of plugin as mentioned in config - this may be an alias to a plugin image ref
	// OR the label of a plugin config
	PluginAlias string `json:"plugin_short_name"`
	// image ref plugin.
	// we resolve this after loading all plugin configs
	Plugin string `json:"plugin"`
	// the label of the plugin config we are using
	PluginInstance *string `json:"plugin_instance"`
	// Path to the installed plugin (if it exists)
	PluginPath *string
	// connection type - supported values: "aggregator"
	Type string `json:"type,omitempty"`
	// should a schema be created for this connection - supported values: "enabled", "disabled"
	ImportSchema string `json:"import_schema"`
	// list of names or wildcards which are resolved to connections
	// (only valid for "aggregator" type)
	ConnectionNames []string `json:"connections,omitempty"`
	// a map of the resolved child connections
	// (only valid for "aggregator" type)
	Connections map[string]*Connection `json:"-"`
	// a list of the names resolved child connections
	// (only valid for "aggregator" type)
	ResolvedConnectionNames []string `json:"resolved_connections,omitempty"`
	// unparsed HCL of plugin specific connection config
	Config string `json:"config,omitempty"`

	Error error

	// options
	Options   *options.Connection `json:"options,omitempty"`
	DeclRange Range               `json:"decl_range"`
}

Connection is a struct representing the partially parsed connection

(Partial as the connection config, which is plugin specific, is stored as raw HCL. This will be parsed by the plugin) json tags needed as this is stored in the connection state file

func NewConnection 

func NewConnection(block *hcl.Block) *Connection

func (*Connection) Equals 

func (c *Connection) Equals(other *Connection) bool

func (*Connection) GetEmptyAggregatorError added in v0.20.0 

func (c *Connection) GetEmptyAggregatorError() string

func (*Connection) GetResolveConnectionNames added in v0.16.0 

func (c *Connection) GetResolveConnectionNames() []string

GetResolveConnectionNames return the names of all child connections (will only be non-empty for aggregator connections)

func (*Connection) ImportDisabled added in v0.20.6 

func (c *Connection) ImportDisabled() bool

func (*Connection) PopulateChildren 

func (c *Connection) PopulateChildren(connectionMap map[string]*Connection) []string

func (*Connection) SetOptions 

func (c *Connection) SetOptions(opts options.Options, block *hcl.Block) hcl.Diagnostics

SetOptions sets the options on the connection verify the options object is a valid options type (only options.Connection currently supported)

func (*Connection) String 

func (c *Connection) String() string

func (*Connection) Validate 

func (c *Connection) Validate(map[string]*Connection) (warnings []string, errors []string)

Validate verifies the Type property is valid, if this is an aggregator connection, there must be at least one child, and no duplicates if this is NOT an aggregator, there must be no children

func (*Connection) ValidateAggregatorConnection 

func (c *Connection) ValidateAggregatorConnection() (warnings, errors []string)

type Control 

type Control struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Severity *string `cty:"severity" hcl:"severity"  column:"severity,text" json:"severity,omitempty"`

	// dashboard specific properties
	Base    *Control `hcl:"base" json:"-"`
	Width   *int     `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string  `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string  `cty:"display" hcl:"display" json:"-"`
	// contains filtered or unexported fields
}

Control is a struct representing the Control resource

func (*Control) CtyValue 

func (c *Control) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Control) Diff 

func (c *Control) Diff(other *Control) *DashboardTreeItemDiffs

func (*Control) Equals 

func (c *Control) Equals(other *Control) bool

func (*Control) GetDisplay 

func (c *Control) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*Control) GetParentNames 

func (c *Control) GetParentNames() []string

func (*Control) GetType 

func (c *Control) GetType() string

GetType implements DashboardLeafNode

func (*Control) GetWidth 

func (c *Control) GetWidth() int

GetWidth implements DashboardLeafNode

func (*Control) OnDecoded 

func (c *Control) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*Control) String 

func (c *Control) String() string

type CtyValueProvider added in v0.19.0 

type CtyValueProvider interface {
	CtyValue() (cty.Value, error)
}

type Dashboard 

type Dashboard struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl
	WithProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Width   *int              `cty:"width" hcl:"width"  column:"width,text"`
	Display *string           `cty:"display" hcl:"display" column:"display,text"`
	Inputs  []*DashboardInput `cty:"inputs" column:"inputs,jsonb"`
	UrlPath string            `cty:"url_path"  column:"url_path,jsonb"`
	Base    *Dashboard        `hcl:"base"`
	// store children in a way which can be serialised via cty
	ChildNames []string `cty:"children" column:"children,jsonb"`
	// contains filtered or unexported fields
}

Dashboard is a struct representing the Dashboard resource

func NewQueryDashboard added in v0.17.0 

func NewQueryDashboard(qp QueryProvider) (*Dashboard, error)

NewQueryDashboard creates a dashboard to wrap a query/control this is used for snapshot generation

func (*Dashboard) AddChild 

func (d *Dashboard) AddChild(child ModTreeItem)

func (*Dashboard) CtyValue 

func (d *Dashboard) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Dashboard) Diff 

func (d *Dashboard) Diff(other *Dashboard) *DashboardTreeItemDiffs

func (*Dashboard) Equals 

func (d *Dashboard) Equals(other *Dashboard) bool

func (*Dashboard) GetDisplay added in v0.19.0 

func (d *Dashboard) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*Dashboard) GetInput 

func (d *Dashboard) GetInput(name string) (*DashboardInput, bool)

func (*Dashboard) GetInputs added in v0.19.0 

func (d *Dashboard) GetInputs() map[string]*DashboardInput

func (*Dashboard) GetType added in v0.19.0 

func (d *Dashboard) GetType() string

GetType implements DashboardLeafNode

func (*Dashboard) GetWidth added in v0.19.0 

func (d *Dashboard) GetWidth() int

GetWidth implements DashboardLeafNode

func (*Dashboard) InitInputs added in v0.19.0 

func (d *Dashboard) InitInputs() hcl.Diagnostics

func (*Dashboard) OnDecoded 

func (d *Dashboard) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*Dashboard) SetChildren 

func (d *Dashboard) SetChildren(children []ModTreeItem)

func (*Dashboard) ValidateRuntimeDependencies added in v0.19.0 

func (d *Dashboard) ValidateRuntimeDependencies(workspace ResourceMapsProvider) error

func (*Dashboard) WalkResources 

func (d *Dashboard) WalkResources(resourceFunc func(resource HclResource) (bool, error)) error

type DashboardCard 

type DashboardCard struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Label *string `cty:"label" hcl:"label" column:"label,text" json:"label,omitempty"`
	Value *string `cty:"value" hcl:"value" column:"value,text" json:"value,omitempty"`
	Icon  *string `cty:"icon" hcl:"icon" column:"icon,text" json:"icon,omitempty"`
	HREF  *string `cty:"href" hcl:"href" json:"href,omitempty"`

	Width   *int           `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string        `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string        `cty:"display" hcl:"display" json:"-"`
	Base    *DashboardCard `hcl:"base" json:"-"`
	// contains filtered or unexported fields
}

DashboardCard is a struct representing a leaf dashboard node

func (*DashboardCard) CtyValue 

func (c *DashboardCard) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardCard) Diff 

func (c *DashboardCard) Diff(other *DashboardCard) *DashboardTreeItemDiffs

func (*DashboardCard) Equals 

func (c *DashboardCard) Equals(other *DashboardCard) bool

func (*DashboardCard) GetDisplay 

func (c *DashboardCard) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardCard) GetDocumentation 

func (c *DashboardCard) GetDocumentation() string

GetDocumentation implements DashboardLeafNode, ModTreeItem

func (*DashboardCard) GetType 

func (c *DashboardCard) GetType() string

GetType implements DashboardLeafNode

func (*DashboardCard) GetWidth 

func (c *DashboardCard) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardCard) OnDecoded 

func (c *DashboardCard) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardCard) ValidateQuery added in v0.19.0 

func (c *DashboardCard) ValidateQuery() hcl.Diagnostics

ValidateQuery implements QueryProvider

type DashboardCategory added in v0.17.0 

type DashboardCategory struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	// TACTICAL: include a title property (with a different name to the property in HclResourceImpl  for clarity)
	// This is purely to ensure the title is included in the panel properties of snapshots
	// Note: this will be parsed from HCL, but we must set this explicitly in setBaseProperties if there is a base
	CategoryTitle *string                               `cty:"title" hcl:"title" json:"title,omitempty"`
	Color         *string                               `cty:"color" hcl:"color" json:"color,omitempty"`
	Depth         *int                                  `cty:"depth" hcl:"depth" json:"depth,omitempty"`
	Icon          *string                               `cty:"icon" hcl:"icon" json:"icon,omitempty"`
	HREF          *string                               `cty:"href" hcl:"href" json:"href,omitempty"`
	Fold          *DashboardCategoryFold                `cty:"fold" hcl:"fold,block" json:"fold,omitempty"`
	PropertyList  DashboardCategoryPropertyList         `cty:"property_list" hcl:"property,block" column:"properties,jsonb" json:"-"`
	Properties    map[string]*DashboardCategoryProperty `cty:"properties" json:"properties,omitempty"`
	PropertyOrder []string                              `cty:"property_order" hcl:"property_order,optional" json:"property_order,omitempty"`
	Base          *DashboardCategory                    `hcl:"base" json:"-"`
}

func (*DashboardCategory) CtyValue added in v0.17.0 

func (c *DashboardCategory) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardCategory) Diff added in v0.17.0 

func (c *DashboardCategory) Diff(other *DashboardCategory) *DashboardTreeItemDiffs

func (*DashboardCategory) Equals added in v0.17.0 

func (c *DashboardCategory) Equals(other *DashboardCategory) bool

func (*DashboardCategory) OnDecoded added in v0.17.0 

func (c *DashboardCategory) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

type DashboardCategoryFold added in v0.17.0 

type DashboardCategoryFold struct {
	Title     *string `cty:"title" hcl:"title" json:"title,omitempty"`
	Threshold *int    `cty:"threshold" hcl:"threshold" json:"threshold,omitempty"`
	Icon      *string `cty:"icon" hcl:"icon" json:"icon,omitempty"`
}

func (DashboardCategoryFold) Equals added in v0.17.0 

func (f DashboardCategoryFold) Equals(other *DashboardCategoryFold) bool

type DashboardCategoryList added in v0.17.0 

type DashboardCategoryList []*DashboardCategory

func (*DashboardCategoryList) Merge added in v0.17.0 

func (c *DashboardCategoryList) Merge(other DashboardCategoryList)

type DashboardCategoryProperty added in v0.19.0 

type DashboardCategoryProperty struct {
	ShortName string  `hcl:"name,label" json:"name"`
	Display   *string `cty:"display" hcl:"display" json:"display,omitempty"`
	Wrap      *string `cty:"wrap" hcl:"wrap" json:"wrap,omitempty"`
	HREF      *string `cty:"href" hcl:"href" json:"href,omitempty"`
}

func (DashboardCategoryProperty) Equals added in v0.19.0 

func (c DashboardCategoryProperty) Equals(other *DashboardCategoryProperty) bool

type DashboardCategoryPropertyList added in v0.19.0 

type DashboardCategoryPropertyList []*DashboardCategoryProperty

func (*DashboardCategoryPropertyList) Merge added in v0.19.0 

func (c *DashboardCategoryPropertyList) Merge(other DashboardCategoryPropertyList)

type DashboardChart 

type DashboardChart struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Width      *int                             `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type       *string                          `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display    *string                          `cty:"display" hcl:"display" json:"-"`
	Legend     *DashboardChartLegend            `cty:"legend" hcl:"legend,block" column:"legend,jsonb" json:"legend,omitempty"`
	SeriesList DashboardChartSeriesList         `cty:"series_list" hcl:"series,block" column:"series,jsonb" json:"-"`
	Axes       *DashboardChartAxes              `cty:"axes" hcl:"axes,block" column:"axes,jsonb" json:"axes,omitempty"`
	Grouping   *string                          `cty:"grouping" hcl:"grouping" json:"grouping,omitempty"`
	Transform  *string                          `cty:"transform" hcl:"transform" json:"transform,omitempty"`
	Series     map[string]*DashboardChartSeries `cty:"series" json:"series,omitempty"`
	Base       *DashboardChart                  `hcl:"base" json:"-"`
}

DashboardChart is a struct representing a leaf dashboard node

func (*DashboardChart) CtyValue 

func (c *DashboardChart) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardChart) Diff 

func (c *DashboardChart) Diff(other *DashboardChart) *DashboardTreeItemDiffs

func (*DashboardChart) Equals 

func (c *DashboardChart) Equals(other *DashboardChart) bool

func (*DashboardChart) GetDisplay 

func (c *DashboardChart) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardChart) GetType 

func (c *DashboardChart) GetType() string

GetType implements DashboardLeafNode

func (*DashboardChart) GetWidth 

func (c *DashboardChart) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardChart) OnDecoded 

func (c *DashboardChart) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

type DashboardChartAxes 

type DashboardChartAxes struct {
	X *DashboardChartAxesX `cty:"x" hcl:"x,block" json:"x,omitempty"`
	Y *DashboardChartAxesY `cty:"y" hcl:"y,block" json:"y,omitempty"`
}

func (*DashboardChartAxes) Equals 

func (a *DashboardChartAxes) Equals(other *DashboardChartAxes) bool

func (*DashboardChartAxes) Merge 

func (a *DashboardChartAxes) Merge(other *DashboardChartAxes)

type DashboardChartAxesX 

type DashboardChartAxesX struct {
	Title  *DashboardChartAxisTitle `cty:"title" hcl:"title,block" json:"title,omitempty"`
	Labels *DashboardChartLabels    `cty:"labels" hcl:"labels,block" json:"labels,omitempty"`
	Min    *int                     `cty:"min" hcl:"min" json:"min,omitempty"`
	Max    *int                     `cty:"max" hcl:"max" json:"max,omitempty"`
}

func (*DashboardChartAxesX) Equals 

func (x *DashboardChartAxesX) Equals(other *DashboardChartAxesX) bool

func (*DashboardChartAxesX) Merge 

func (x *DashboardChartAxesX) Merge(other *DashboardChartAxesX)

type DashboardChartAxesY 

type DashboardChartAxesY struct {
	Title  *DashboardChartAxisTitle `cty:"title" hcl:"title,block" json:"title,omitempty"`
	Labels *DashboardChartLabels    `cty:"labels" hcl:"labels,block" json:"labels,omitempty"`
	Min    *int                     `cty:"min" hcl:"min" json:"min,omitempty"`
	Max    *int                     `cty:"max" hcl:"max" json:"max,omitempty"`
}

func (*DashboardChartAxesY) Equals 

func (y *DashboardChartAxesY) Equals(other *DashboardChartAxesY) bool

func (*DashboardChartAxesY) Merge 

func (y *DashboardChartAxesY) Merge(other *DashboardChartAxesY)

type DashboardChartAxisTitle 

type DashboardChartAxisTitle struct {
	Display *string `cty:"display" hcl:"display" json:"display,omitempty"`
	Align   *string `cty:"align" hcl:"align" json:"align,omitempty"`
	Value   *string `cty:"value" hcl:"value" json:"value,omitempty"`
}

func (*DashboardChartAxisTitle) Equals 

func (t *DashboardChartAxisTitle) Equals(other *DashboardChartAxisTitle) bool

func (*DashboardChartAxisTitle) Merge 

func (t *DashboardChartAxisTitle) Merge(other *DashboardChartAxisTitle)

type DashboardChartLabels 

type DashboardChartLabels struct {
	Display *string `cty:"display" hcl:"display" json:"display,omitempty"`
	Format  *string `cty:"format" hcl:"format" json:"format,omitempty"`
}

func (*DashboardChartLabels) Equals 

func (l *DashboardChartLabels) Equals(other *DashboardChartLabels) bool

func (*DashboardChartLabels) Merge 

func (l *DashboardChartLabels) Merge(other *DashboardChartLabels)

type DashboardChartLegend 

type DashboardChartLegend struct {
	Display  *string `cty:"display" hcl:"display" json:"display,omitempty"`
	Position *string `cty:"position" hcl:"position" json:"position,omitempty"`
}

func (*DashboardChartLegend) Equals 

func (l *DashboardChartLegend) Equals(other *DashboardChartLegend) bool

func (*DashboardChartLegend) Merge 

func (l *DashboardChartLegend) Merge(other *DashboardChartLegend)

type DashboardChartSeries 

type DashboardChartSeries struct {
	Name       string                                `hcl:"name,label" json:"name"`
	Title      *string                               `cty:"title" hcl:"title" json:"title,omitempty"`
	Color      *string                               `cty:"color" hcl:"color" json:"color,omitempty"`
	Points     map[string]*DashboardChartSeriesPoint `cty:"points" json:"points,omitempty"`
	PointsList []*DashboardChartSeriesPoint          `hcl:"point,block" json:"-"`
}

func (*DashboardChartSeries) Equals 

func (s *DashboardChartSeries) Equals(other *DashboardChartSeries) bool

func (*DashboardChartSeries) OnDecoded 

func (s *DashboardChartSeries) OnDecoded()

type DashboardChartSeriesList 

type DashboardChartSeriesList []*DashboardChartSeries

func (*DashboardChartSeriesList) Merge 

func (s *DashboardChartSeriesList) Merge(other DashboardChartSeriesList)

type DashboardChartSeriesPoint 

type DashboardChartSeriesPoint struct {
	Name  string  `hcl:"name,label" json:"-"`
	Color *string `cty:"color" hcl:"color" json:"color,omitempty"`
}

func (DashboardChartSeriesPoint) Equals 

func (s DashboardChartSeriesPoint) Equals(other *DashboardChartSeriesPoint) bool

type DashboardContainer 

type DashboardContainer struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Width   *int              `cty:"width" hcl:"width"  column:"width,text"`
	Display *string           `cty:"display" hcl:"display"`
	Inputs  []*DashboardInput `cty:"inputs" column:"inputs,jsonb"`
	// store children in a way which can be serialised via cty
	ChildNames []string `cty:"children" column:"children,jsonb"`
	// contains filtered or unexported fields
}

DashboardContainer is a struct representing the Dashboard and Container resource

func (*DashboardContainer) AddChild 

func (c *DashboardContainer) AddChild(child ModTreeItem)

func (*DashboardContainer) CtyValue 

func (c *DashboardContainer) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardContainer) Diff 

func (c *DashboardContainer) Diff(other *DashboardContainer) *DashboardTreeItemDiffs

func (*DashboardContainer) Equals 

func (c *DashboardContainer) Equals(other *DashboardContainer) bool

func (*DashboardContainer) GetDisplay added in v0.19.0 

func (c *DashboardContainer) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardContainer) GetType added in v0.19.0 

func (c *DashboardContainer) GetType() string

GetType implements DashboardLeafNode

func (*DashboardContainer) GetWidth added in v0.19.0 

func (c *DashboardContainer) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardContainer) OnDecoded 

func (c *DashboardContainer) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardContainer) SetChildren 

func (c *DashboardContainer) SetChildren(children []ModTreeItem)

func (*DashboardContainer) WalkResources 

func (c *DashboardContainer) WalkResources(resourceFunc func(resource HclResource) (bool, error)) error

type DashboardEdge added in v0.17.0 

type DashboardEdge struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Category *DashboardCategory `cty:"category" hcl:"category" column:"category,jsonb" json:"category,omitempty"`
	Base     *DashboardEdge     `hcl:"base" json:"-"`
}

DashboardEdge is a struct representing a leaf dashboard node

func (*DashboardEdge) CtyValue added in v0.17.0 

func (e *DashboardEdge) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardEdge) Diff added in v0.17.0 

func (e *DashboardEdge) Diff(other *DashboardEdge) *DashboardTreeItemDiffs

func (*DashboardEdge) Equals added in v0.17.0 

func (e *DashboardEdge) Equals(other *DashboardEdge) bool

func (*DashboardEdge) GetDisplay added in v0.17.0 

func (e *DashboardEdge) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardEdge) GetDocumentation added in v0.17.0 

func (e *DashboardEdge) GetDocumentation() string

GetDocumentation implements DashboardLeafNode

func (*DashboardEdge) GetType added in v0.17.0 

func (e *DashboardEdge) GetType() string

GetType implements DashboardLeafNode

func (*DashboardEdge) GetWidth added in v0.17.0 

func (e *DashboardEdge) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardEdge) OnDecoded added in v0.17.0 

func (e *DashboardEdge) OnDecoded(_ *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

type DashboardEdgeList added in v0.17.0 

type DashboardEdgeList []*DashboardEdge

func (*DashboardEdgeList) Contains added in v0.19.0 

func (l *DashboardEdgeList) Contains(other *DashboardEdge) bool

func (*DashboardEdgeList) Get added in v0.19.0 

func (l *DashboardEdgeList) Get(name string) *DashboardEdge

func (*DashboardEdgeList) Merge added in v0.17.0 

func (l *DashboardEdgeList) Merge(other DashboardEdgeList)

func (*DashboardEdgeList) Names added in v0.17.0 

func (l *DashboardEdgeList) Names() []string

type DashboardFlow 

type DashboardFlow struct {
	ResourceWithMetadataImpl
	QueryProviderImpl
	WithProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Nodes     DashboardNodeList `cty:"node_list"  column:"nodes,jsonb" json:"-"`
	Edges     DashboardEdgeList `cty:"edge_list" column:"edges,jsonb" json:"-"`
	NodeNames []string          `json:"nodes"`
	EdgeNames []string          `json:"edges"`

	Categories map[string]*DashboardCategory `cty:"categories" json:"categories"`

	Width   *int    `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string `cty:"display" hcl:"display" json:"-"`

	Base *DashboardFlow `hcl:"base" json:"-"`
}

DashboardFlow is a struct representing a leaf dashboard node

func (*DashboardFlow) AddCategory added in v0.17.0 

func (f *DashboardFlow) AddCategory(category *DashboardCategory) hcl.Diagnostics

AddCategory implements NodeAndEdgeProvider

func (*DashboardFlow) AddChild added in v0.19.0 

func (f *DashboardFlow) AddChild(child HclResource) hcl.Diagnostics

AddChild implements NodeAndEdgeProvider

func (*DashboardFlow) CtyValue 

func (f *DashboardFlow) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardFlow) Diff 

func (f *DashboardFlow) Diff(other *DashboardFlow) *DashboardTreeItemDiffs

func (*DashboardFlow) Equals 

func (f *DashboardFlow) Equals(other *DashboardFlow) bool

func (*DashboardFlow) GetChildren 

func (f *DashboardFlow) GetChildren() []ModTreeItem

TODO [node_reuse] Add DashboardLeafNodeImpl and move this there https://github.com/turbot/steampipe/issues/2926 GetChildren implements ModTreeItem

func (*DashboardFlow) GetDisplay 

func (f *DashboardFlow) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardFlow) GetEdges added in v0.17.0 

func (f *DashboardFlow) GetEdges() DashboardEdgeList

GetEdges implements NodeAndEdgeProvider

func (*DashboardFlow) GetNodes added in v0.17.0 

func (f *DashboardFlow) GetNodes() DashboardNodeList

GetNodes implements NodeAndEdgeProvider

func (*DashboardFlow) GetType 

func (f *DashboardFlow) GetType() string

GetType implements DashboardLeafNode

func (*DashboardFlow) GetWidth 

func (f *DashboardFlow) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardFlow) OnDecoded 

func (f *DashboardFlow) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardFlow) SetEdges added in v0.17.0 

func (f *DashboardFlow) SetEdges(edges DashboardEdgeList)

SetEdges implements NodeAndEdgeProvider

func (*DashboardFlow) SetNodes added in v0.17.0 

func (f *DashboardFlow) SetNodes(nodes DashboardNodeList)

SetNodes implements NodeAndEdgeProvider

func (*DashboardFlow) ValidateQuery added in v0.19.0 

func (*DashboardFlow) ValidateQuery() hcl.Diagnostics

ValidateQuery implements QueryProvider

type DashboardGraph added in v0.17.0 

type DashboardGraph struct {
	ResourceWithMetadataImpl
	QueryProviderImpl
	WithProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Nodes     DashboardNodeList `cty:"node_list" column:"nodes,jsonb" json:"-"`
	Edges     DashboardEdgeList `cty:"edge_list" column:"edges,jsonb" json:"-"`
	NodeNames []string          `json:"nodes"`
	EdgeNames []string          `json:"edges"`

	Categories map[string]*DashboardCategory `cty:"categories" json:"categories"`
	Direction  *string                       `cty:"direction" hcl:"direction" column:"direction,text" json:"direction"`

	// these properties are JSON serialised by the parent LeafRun
	Width   *int    `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string `cty:"display" hcl:"display" json:"-"`

	Base *DashboardGraph `hcl:"base" json:"-"`
}

DashboardGraph is a struct representing a leaf dashboard node

func (*DashboardGraph) AddCategory added in v0.17.0 

func (g *DashboardGraph) AddCategory(category *DashboardCategory) hcl.Diagnostics

AddCategory implements NodeAndEdgeProvider

func (*DashboardGraph) AddChild added in v0.19.0 

func (g *DashboardGraph) AddChild(child HclResource) hcl.Diagnostics

AddChild implements NodeAndEdgeProvider

func (*DashboardGraph) CtyValue added in v0.17.0 

func (g *DashboardGraph) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardGraph) Diff added in v0.17.0 

func (g *DashboardGraph) Diff(other *DashboardGraph) *DashboardTreeItemDiffs

func (*DashboardGraph) Equals added in v0.17.0 

func (g *DashboardGraph) Equals(other *DashboardGraph) bool

func (*DashboardGraph) GetChildren added in v0.17.0 

func (g *DashboardGraph) GetChildren() []ModTreeItem

GetChildren implements ModTreeItem

func (*DashboardGraph) GetDisplay added in v0.17.0 

func (g *DashboardGraph) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardGraph) GetEdges added in v0.17.0 

func (g *DashboardGraph) GetEdges() DashboardEdgeList

GetEdges implements NodeAndEdgeProvider

func (*DashboardGraph) GetNodes added in v0.17.0 

func (g *DashboardGraph) GetNodes() DashboardNodeList

GetNodes implements NodeAndEdgeProvider

func (*DashboardGraph) GetType added in v0.17.0 

func (g *DashboardGraph) GetType() string

GetType implements DashboardLeafNode

func (*DashboardGraph) GetWidth added in v0.17.0 

func (g *DashboardGraph) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardGraph) OnDecoded added in v0.17.0 

func (g *DashboardGraph) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardGraph) SetEdges added in v0.17.0 

func (g *DashboardGraph) SetEdges(edges DashboardEdgeList)

SetEdges implements NodeAndEdgeProvider

func (*DashboardGraph) SetNodes added in v0.17.0 

func (g *DashboardGraph) SetNodes(nodes DashboardNodeList)

SetNodes implements NodeAndEdgeProvider

type DashboardHierarchy 

type DashboardHierarchy struct {
	ResourceWithMetadataImpl
	QueryProviderImpl
	WithProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Nodes     DashboardNodeList `cty:"node_list" column:"nodes,jsonb" json:"-"`
	Edges     DashboardEdgeList `cty:"edge_list" column:"edges,jsonb" json:"-"`
	NodeNames []string          `json:"nodes"`
	EdgeNames []string          `json:"edges"`

	Categories map[string]*DashboardCategory `cty:"categories" json:"categories"`
	Width      *int                          `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type       *string                       `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display    *string                       `cty:"display" hcl:"display" json:"-"`

	Base *DashboardHierarchy `hcl:"base" json:"-"`
	// contains filtered or unexported fields
}

DashboardHierarchy is a struct representing a leaf dashboard node

func (*DashboardHierarchy) AddCategory added in v0.17.0 

func (h *DashboardHierarchy) AddCategory(category *DashboardCategory) hcl.Diagnostics

AddCategory implements NodeAndEdgeProvider

func (*DashboardHierarchy) AddChild added in v0.19.0 

func (h *DashboardHierarchy) AddChild(child HclResource) hcl.Diagnostics

AddChild implements NodeAndEdgeProvider

func (*DashboardHierarchy) CtyValue 

func (h *DashboardHierarchy) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardHierarchy) Diff 

func (h *DashboardHierarchy) Diff(other *DashboardHierarchy) *DashboardTreeItemDiffs

func (*DashboardHierarchy) Equals 

func (h *DashboardHierarchy) Equals(other *DashboardHierarchy) bool

func (*DashboardHierarchy) GetChildren 

func (h *DashboardHierarchy) GetChildren() []ModTreeItem

GetChildren implements ModTreeItem

func (*DashboardHierarchy) GetDisplay 

func (h *DashboardHierarchy) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardHierarchy) GetDocumentation 

func (h *DashboardHierarchy) GetDocumentation() string

GetDocumentation implements DashboardLeafNode, ModTreeItem

func (*DashboardHierarchy) GetEdges added in v0.17.0 

func (h *DashboardHierarchy) GetEdges() DashboardEdgeList

GetEdges implements NodeAndEdgeProvider

func (*DashboardHierarchy) GetNodes added in v0.17.0 

func (h *DashboardHierarchy) GetNodes() DashboardNodeList

GetNodes implements NodeAndEdgeProvider

func (*DashboardHierarchy) GetType 

func (h *DashboardHierarchy) GetType() string

GetType implements DashboardLeafNode

func (*DashboardHierarchy) GetWidth 

func (h *DashboardHierarchy) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardHierarchy) OnDecoded 

func (h *DashboardHierarchy) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardHierarchy) SetEdges added in v0.17.0 

func (h *DashboardHierarchy) SetEdges(edges DashboardEdgeList)

SetEdges implements NodeAndEdgeProvider

func (*DashboardHierarchy) SetNodes added in v0.17.0 

func (h *DashboardHierarchy) SetNodes(nodes DashboardNodeList)

SetNodes implements NodeAndEdgeProvider

type DashboardImage 

type DashboardImage struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Src *string `cty:"src" hcl:"src" column:"src,text" json:"src,omitempty"`
	Alt *string `cty:"alt" hcl:"alt" column:"alt,text" json:"alt,omitempty"`

	// these properties are JSON serialised by the parent LeafRun
	Width   *int    `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Display *string `cty:"display" hcl:"display" json:"-"`

	Base *DashboardImage `hcl:"base" json:"-"`
}

DashboardImage is a struct representing a leaf dashboard node

func (*DashboardImage) CtyValue 

func (i *DashboardImage) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardImage) Diff 

func (i *DashboardImage) Diff(other *DashboardImage) *DashboardTreeItemDiffs

func (*DashboardImage) Equals 

func (i *DashboardImage) Equals(other *DashboardImage) bool

func (*DashboardImage) GetDisplay 

func (i *DashboardImage) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardImage) GetDocumentation 

func (*DashboardImage) GetDocumentation() string

GetDocumentation implements DashboardLeafNode, ModTreeItem

func (*DashboardImage) GetType 

func (*DashboardImage) GetType() string

GetType implements DashboardLeafNode

func (*DashboardImage) GetWidth 

func (i *DashboardImage) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardImage) OnDecoded 

func (i *DashboardImage) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardImage) ValidateQuery added in v0.19.0 

func (i *DashboardImage) ValidateQuery() hcl.Diagnostics

ValidateQuery implements QueryProvider

type DashboardInput 

type DashboardInput struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	DashboardName string                  `column:"dashboard,text" json:"-"`
	Label         *string                 `cty:"label" hcl:"label" column:"label,text" json:"label,omitempty"`
	Placeholder   *string                 `cty:"placeholder" hcl:"placeholder" column:"placeholder,text" json:"placeholder,omitempty"`
	Options       []*DashboardInputOption `cty:"options" hcl:"option,block" json:"options,omitempty"`
	// tactical - exists purely so we can put "unqualified_name" in the snbapshot panel for the input
	// TODO remove when input names are refactored https://github.com/turbot/steampipe/issues/2863
	InputName string `cty:"input_name" json:"unqualified_name"`

	// these properties are JSON serialised by the parent LeafRun
	Width   *int            `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string         `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string         `cty:"display" hcl:"display" json:"-"`
	Base    *DashboardInput `hcl:"base" json:"-"`
	// contains filtered or unexported fields
}

DashboardInput is a struct representing a leaf dashboard node

func GetDashboardInput 

func GetDashboardInput(provider ResourceMapsProvider, inputName, dashboardName string) (*DashboardInput, bool)

GetDashboardInput looks for an input with a given parent dashboard this is required as GetResource does not support Inputs

func (*DashboardInput) Clone 

func (i *DashboardInput) Clone() *DashboardInput

TODO remove https://github.com/turbot/steampipe/issues/2864

func (*DashboardInput) CtyValue 

func (i *DashboardInput) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardInput) DependsOnInput 

func (i *DashboardInput) DependsOnInput(changedInputName string) bool

DependsOnInput returns whether this input has a runtime dependency on the given input¬

func (*DashboardInput) Diff 

func (i *DashboardInput) Diff(other *DashboardInput) *DashboardTreeItemDiffs

func (*DashboardInput) Equals 

func (i *DashboardInput) Equals(other *DashboardInput) bool

func (*DashboardInput) GetDisplay 

func (i *DashboardInput) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardInput) GetType 

func (i *DashboardInput) GetType() string

GetType implements DashboardLeafNode

func (*DashboardInput) GetWidth 

func (i *DashboardInput) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardInput) OnDecoded 

func (i *DashboardInput) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*DashboardInput) SetDashboard 

func (i *DashboardInput) SetDashboard(dashboard *Dashboard)

SetDashboard sets the parent dashboard container

func (*DashboardInput) ValidateQuery added in v0.19.0 

func (i *DashboardInput) ValidateQuery() hcl.Diagnostics

ValidateQuery implements QueryProvider

type DashboardInputOption 

type DashboardInputOption struct {
	Name  string  `hcl:"name,label" json:"name"`
	Label *string `cty:"label" hcl:"label" json:"label,omitempty"`
}

DashboardInputOption is a struct representing dashboard input option

func (DashboardInputOption) Equals 

func (o DashboardInputOption) Equals(other *DashboardInputOption) bool

type DashboardLeafNode 

type DashboardLeafNode interface {
	ModTreeItem
	ResourceWithMetadata
	GetDisplay() string
	GetType() string
	GetWidth() int
}

DashboardLeafNode must be implemented by resources may be a leaf node in the dashboard execution tree

type DashboardNode added in v0.17.0 

type DashboardNode struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Category *DashboardCategory `cty:"category" hcl:"category" column:"category,jsonb" json:"category,omitempty"`
	Base     *DashboardNode     `hcl:"base" json:"-"`
}

DashboardNode is a struct representing a leaf dashboard node

func (*DashboardNode) CtyValue added in v0.17.0 

func (n *DashboardNode) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardNode) Diff added in v0.17.0 

func (n *DashboardNode) Diff(other *DashboardNode) *DashboardTreeItemDiffs

func (*DashboardNode) Equals added in v0.17.0 

func (n *DashboardNode) Equals(other *DashboardNode) bool

func (*DashboardNode) GetDisplay added in v0.17.0 

func (n *DashboardNode) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardNode) GetType added in v0.17.0 

func (n *DashboardNode) GetType() string

GetType implements DashboardLeafNode

func (*DashboardNode) GetWidth added in v0.17.0 

func (n *DashboardNode) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardNode) OnDecoded added in v0.17.0 

func (n *DashboardNode) OnDecoded(_ *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource—

type DashboardNodeList added in v0.17.0 

type DashboardNodeList []*DashboardNode

func (*DashboardNodeList) Contains added in v0.19.0 

func (l *DashboardNodeList) Contains(other *DashboardNode) bool

func (*DashboardNodeList) Get added in v0.19.0 

func (l *DashboardNodeList) Get(name string) *DashboardNode

func (*DashboardNodeList) Merge added in v0.17.0 

func (l *DashboardNodeList) Merge(other DashboardNodeList)

func (*DashboardNodeList) Names added in v0.17.0 

func (l *DashboardNodeList) Names() []string

type DashboardTable 

type DashboardTable struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	// TODO remove - check introspection tables
	Width      *int                             `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type       *string                          `cty:"type" hcl:"type" column:"type,text" json:"-"`
	ColumnList DashboardTableColumnList         `cty:"column_list" hcl:"column,block" column:"columns,jsonb" json:"-"`
	Columns    map[string]*DashboardTableColumn `cty:"columns" json:"columns,omitempty"`
	Display    *string                          `cty:"display" hcl:"display" json:"display,omitempty"`
	Base       *DashboardTable                  `hcl:"base" json:"-"`
}

DashboardTable is a struct representing a leaf dashboard node

func NewQueryDashboardTable added in v0.17.0 

func NewQueryDashboardTable(qp QueryProvider) (*DashboardTable, error)

NewQueryDashboardTable creates a Table to wrap a query. This is used in order to execute queries as dashboards

func (*DashboardTable) CtyValue 

func (t *DashboardTable) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardTable) Diff 

func (t *DashboardTable) Diff(other *DashboardTable) *DashboardTreeItemDiffs

func (*DashboardTable) Equals 

func (t *DashboardTable) Equals(other *DashboardTable) bool

func (*DashboardTable) GetDisplay 

func (t *DashboardTable) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardTable) GetDocumentation 

func (*DashboardTable) GetDocumentation() string

GetDocumentation implements DashboardLeafNode, ModTreeItem

func (*DashboardTable) GetType 

func (t *DashboardTable) GetType() string

GetType implements DashboardLeafNode

func (*DashboardTable) GetWidth 

func (t *DashboardTable) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardTable) OnDecoded 

func (t *DashboardTable) OnDecoded(block *hcl.Block, resourceMapProvider ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

type DashboardTableColumn 

type DashboardTableColumn struct {
	Name    string  `hcl:"name,label" json:"name"`
	Display *string `cty:"display" hcl:"display" json:"display,omitempty"`
	Wrap    *string `cty:"wrap" hcl:"wrap" json:"wrap,omitempty"`
	HREF    *string `cty:"href" hcl:"href" json:"href,omitempty"`
}

func (DashboardTableColumn) Equals 

func (c DashboardTableColumn) Equals(other *DashboardTableColumn) bool

type DashboardTableColumnList 

type DashboardTableColumnList []*DashboardTableColumn

func (*DashboardTableColumnList) Merge 

func (c *DashboardTableColumnList) Merge(other DashboardTableColumnList)

type DashboardText 

type DashboardText struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Value   *string `cty:"value" hcl:"value" column:"value,text" json:"value,omitempty"`
	Width   *int    `cty:"width" hcl:"width" column:"width,text" json:"-"`
	Type    *string `cty:"type" hcl:"type" column:"type,text" json:"-"`
	Display *string `cty:"display" hcl:"display" json:"-"`

	Base *DashboardText `hcl:"base" json:"-"`
	Mod  *Mod           `cty:"mod" json:"-"`
}

DashboardText is a struct representing a leaf dashboard node

func (*DashboardText) CtyValue 

func (t *DashboardText) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardText) Diff 

func (t *DashboardText) Diff(other *DashboardText) *DashboardTreeItemDiffs

func (*DashboardText) Equals 

func (t *DashboardText) Equals(other *DashboardText) bool

func (*DashboardText) GetDisplay 

func (t *DashboardText) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardText) GetDocumentation 

func (*DashboardText) GetDocumentation() string

GetDocumentation implements DashboardLeafNode, ModTreeItem

func (*DashboardText) GetType 

func (t *DashboardText) GetType() string

GetType implements DashboardLeafNode

func (*DashboardText) GetWidth 

func (t *DashboardText) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardText) OnDecoded 

func (t *DashboardText) OnDecoded(*hcl.Block, ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

type DashboardTreeItemDiffs 

type DashboardTreeItemDiffs struct {
	Name              string
	Item              ModTreeItem
	ChangedProperties []string
	AddedItems        []string
	RemovedItems      []string
}

DashboardTreeItemDiffs is a struct representing the differences between 2 DashboardTreeItems (of same type)

func (*DashboardTreeItemDiffs) AddAddedItem 

func (d *DashboardTreeItemDiffs) AddAddedItem(name string)

func (*DashboardTreeItemDiffs) AddPropertyDiff 

func (d *DashboardTreeItemDiffs) AddPropertyDiff(propertyName string)

func (*DashboardTreeItemDiffs) AddRemovedItem 

func (d *DashboardTreeItemDiffs) AddRemovedItem(name string)

func (*DashboardTreeItemDiffs) HasChanges 

func (d *DashboardTreeItemDiffs) HasChanges() bool

type DashboardWith added in v0.19.0 

type DashboardWith struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`
}

DashboardWith is a struct representing a leaf dashboard node

func (*DashboardWith) CtyValue added in v0.19.0 

func (w *DashboardWith) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*DashboardWith) Diff added in v0.19.0 

func (w *DashboardWith) Diff(other *DashboardWith) *DashboardTreeItemDiffs

func (*DashboardWith) Equals added in v0.19.0 

func (w *DashboardWith) Equals(other *DashboardWith) bool

func (*DashboardWith) GetDisplay added in v0.19.0 

func (*DashboardWith) GetDisplay() string

GetDisplay implements DashboardLeafNode

func (*DashboardWith) GetType added in v0.19.0 

func (*DashboardWith) GetType() string

GetType implements DashboardLeafNode

func (*DashboardWith) GetWidth added in v0.19.0 

func (*DashboardWith) GetWidth() int

GetWidth implements DashboardLeafNode

func (*DashboardWith) OnDecoded added in v0.19.0 

func (w *DashboardWith) OnDecoded(_ *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

type HclResource 

type HclResource interface {
	// TODO  [node_reuse] rename to GetName/GetFullName
	Name() string
	GetTitle() string
	GetUnqualifiedName() string
	OnDecoded(*hcl.Block, ResourceMapsProvider) hcl.Diagnostics
	GetDeclRange() *hcl.Range
	BlockType() string
	GetDescription() string
	GetDocumentation() string
	GetTags() map[string]string
	SetTopLevel(bool)
	IsTopLevel() bool
	GetBase() HclResource
	GetHclResourceImpl() *HclResourceImpl
}

HclResource must be implemented by resources defined in HCL

func NewBenchmark 

func NewBenchmark(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewControl 

func NewControl(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboard 

func NewDashboard(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardCard 

func NewDashboardCard(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardCategory added in v0.17.0 

func NewDashboardCategory(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardChart 

func NewDashboardChart(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardContainer 

func NewDashboardContainer(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardEdge added in v0.17.0 

func NewDashboardEdge(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardFlow 

func NewDashboardFlow(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardGraph added in v0.17.0 

func NewDashboardGraph(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardHierarchy 

func NewDashboardHierarchy(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardImage 

func NewDashboardImage(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardInput 

func NewDashboardInput(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardNode added in v0.17.0 

func NewDashboardNode(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardTable 

func NewDashboardTable(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardText 

func NewDashboardText(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewDashboardWith added in v0.19.0 

func NewDashboardWith(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewQuery 

func NewQuery(block *hcl.Block, mod *Mod, shortName string) HclResource

func NewRootBenchmarkWithChildren added in v0.21.0 

func NewRootBenchmarkWithChildren(mod *Mod, children []ModTreeItem) HclResource

type HclResourceImpl added in v0.19.0 

type HclResourceImpl struct {
	// required to allow partial decoding
	HclResourceRemain hcl.Body `hcl:",remain" json:"-"`

	FullName        string            `cty:"name" column:"qualified_name,text" json:"-"`
	Title           *string           `cty:"title" hcl:"title" column:"title,text" json:"-"`
	ShortName       string            `cty:"short_name" hcl:"name,label" json:"name"`
	UnqualifiedName string            `cty:"unqualified_name" json:"-"`
	Description     *string           `cty:"description" hcl:"description" column:"description,text" json:"-"`
	Documentation   *string           `cty:"documentation" hcl:"documentation" column:"documentation,text" json:"-"`
	DeclRange       hcl.Range         `json:"-"`
	Tags            map[string]string `cty:"tags" hcl:"tags,optional" column:"tags,jsonb" json:"-"`
	// contains filtered or unexported fields
}

func (*HclResourceImpl) BlockType added in v0.19.0 

func (b *HclResourceImpl) BlockType() string

BlockType implements HclResource

func (*HclResourceImpl) CtyValue added in v0.19.0 

func (b *HclResourceImpl) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*HclResourceImpl) GetBase added in v0.19.0 

func (b *HclResourceImpl) GetBase() HclResource

GetBase implements HclResource

func (*HclResourceImpl) GetDeclRange added in v0.19.0 

func (b *HclResourceImpl) GetDeclRange() *hcl.Range

GetDeclRange implements HclResource

func (*HclResourceImpl) GetDescription added in v0.19.0 

func (b *HclResourceImpl) GetDescription() string

GetDescription implements HclResource

func (*HclResourceImpl) GetDocumentation added in v0.19.0 

func (b *HclResourceImpl) GetDocumentation() string

GetDocumentation implements HclResource

func (*HclResourceImpl) GetHclResourceImpl added in v0.19.0 

func (b *HclResourceImpl) GetHclResourceImpl() *HclResourceImpl

GetHclResourceImpl implements HclResource

func (*HclResourceImpl) GetTags added in v0.19.0 

func (b *HclResourceImpl) GetTags() map[string]string

GetTags implements HclResource

func (*HclResourceImpl) GetTitle added in v0.19.0 

func (b *HclResourceImpl) GetTitle() string

GetTitle implements HclResource

func (*HclResourceImpl) GetUnqualifiedName added in v0.19.0 

func (b *HclResourceImpl) GetUnqualifiedName() string

GetUnqualifiedName implements DashboardLeafNode, ModTreeItem

func (*HclResourceImpl) IsTopLevel added in v0.19.0 

func (b *HclResourceImpl) IsTopLevel() bool

IsTopLevel implements HclResource

func (*HclResourceImpl) Name added in v0.19.0 

func (b *HclResourceImpl) Name() string

Name implements HclResource return name in format: '<blocktype>.<shortName>'

func (*HclResourceImpl) OnDecoded added in v0.19.0 

func (b *HclResourceImpl) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*HclResourceImpl) SetTopLevel added in v0.19.0 

func (b *HclResourceImpl) SetTopLevel(isTopLevel bool)

SetTopLevel implements HclResource

type Local 

type Local struct {
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Value cty.Value
	// contains filtered or unexported fields
}

Local is a struct representing a Local resource

func NewLocal 

func NewLocal(name string, val cty.Value, declRange hcl.Range, mod *Mod) *Local

func (*Local) CtyValue 

func (l *Local) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Local) Diff 

func (l *Local) Diff(other *Local) *DashboardTreeItemDiffs

type MappableResource 

type MappableResource interface {
	HclResource
	ResourceWithMetadata
	// InitialiseFromFile creates a mappable resource from a file path
	// It returns the resource, and the raw file data
	InitialiseFromFile(modPath, filePath string) (MappableResource, []byte, error)
}

MappableResource must be implemented by resources which can be created directly from a content file (e.g. sql)

func QueryFromFile 

func QueryFromFile(modPath, filePath string, mod *Mod) (MappableResource, []byte, error)

type MissingVariableError 

type MissingVariableError struct {
	MissingVariables []*Variable
}

func (MissingVariableError) Error 

func (m MissingVariableError) Error() string

type Mod 

type Mod struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	// attributes
	Categories []string `cty:"categories" hcl:"categories,optional" column:"categories,jsonb"`
	Color      *string  `cty:"color" hcl:"color" column:"color,text"`
	Icon       *string  `cty:"icon" hcl:"icon" column:"icon,text"`

	// blocks
	Require       *Require   `hcl:"require,block"`
	LegacyRequire *Require   `hcl:"requires,block"`
	OpenGraph     *OpenGraph `hcl:"opengraph,block" column:"open_graph,jsonb"`

	// the mod version
	Version *semver.Version
	// DependencyPath is the fully qualified mod name including version,
	// which will by the map key in the workspace lock file
	// NOTE: this is the relative path to th emod location from the depdemncy install dir (.steampipe/mods)
	// e.g. github.com/turbot/steampipe-mod-azure-thrifty@v1.0.0
	// (NOTE: pointer so it is nil in introspection tables if unpopulated)
	DependencyPath *string `column:"dependency_path,text"`
	// DependencyName return the name of the mod as a dependency, i.e. the mod dependency path, _without_ the version
	// e.g. github.com/turbot/steampipe-mod-azure-thrifty
	DependencyName string

	// ModPath is the installation location of the mod
	ModPath string

	// convenient aggregation of all resources
	ResourceMaps *ResourceMaps
	// contains filtered or unexported fields
}

Mod is a struct representing a Mod resource

func CreateDefaultMod 

func CreateDefaultMod(modPath string) *Mod

CreateDefaultMod creates a default mod created for a workspace with no mod definition

func NewMod 

func NewMod(shortName, modPath string, defRange hcl.Range) *Mod

func (*Mod) AddModDependencies 

func (m *Mod) AddModDependencies(modVersions map[string]*ModVersionConstraint)

func (*Mod) AddReference 

func (m *Mod) AddReference(ref *ResourceReference)

AddReference implements ResourceWithMetadata (overridden from ResourceWithMetadataImpl)

func (*Mod) AddResource 

func (m *Mod) AddResource(item HclResource) hcl.Diagnostics

func (*Mod) BuildResourceTree 

func (m *Mod) BuildResourceTree(loadedDependencyMods ModMap) (err error)

BuildResourceTree builds the control tree structure by setting the parent property for each control and benchmark NOTE: this also builds the sorted benchmark list

func (*Mod) CtyValue 

func (m *Mod) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Mod) Equals 

func (m *Mod) Equals(other *Mod) bool

func (*Mod) FilePath added in v0.21.5 

func (m *Mod) FilePath() string

func (*Mod) GetInstallCacheKey added in v0.20.0 

func (m *Mod) GetInstallCacheKey() string

GetInstallCacheKey returns the key used to find this mod in a workspace lock InstallCache

func (*Mod) GetModDependency 

func (m *Mod) GetModDependency(modName string) *ModVersionConstraint

func (*Mod) GetPaths 

func (m *Mod) GetPaths() []NodePath

GetPaths implements ModTreeItem (override base functionality)

func (*Mod) GetReferences 

func (m *Mod) GetReferences() []*ResourceReference

GetReferences implements ResourceWithMetadata (overridden from ResourceWithMetadataImpl)

func (*Mod) GetResource added in v0.19.0 

func (m *Mod) GetResource(parsedName *ParsedResourceName) (resource HclResource, found bool)

func (*Mod) GetResourceMaps 

func (m *Mod) GetResourceMaps() *ResourceMaps

GetResourceMaps implements ResourceMapsProvider

func (*Mod) HasDependentMods 

func (m *Mod) HasDependentMods() bool

func (*Mod) IsDefaultMod 

func (m *Mod) IsDefaultMod() bool

IsDefaultMod returns whether this mod is a default mod created for a workspace with no mod definition

func (*Mod) OnDecoded 

func (m *Mod) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*Mod) RemoveAllModDependencies 

func (m *Mod) RemoveAllModDependencies()

func (*Mod) RemoveModDependencies 

func (m *Mod) RemoveModDependencies(modVersions map[string]*ModVersionConstraint)

func (*Mod) RequireHasUnresolvedArgs added in v0.20.0 

func (m *Mod) RequireHasUnresolvedArgs() bool

RequireHasUnresolvedArgs returns whether the mod has any mod requirements which have unresolved args (this could be because the arg refers to a variable, meanin gwe need an additional parse phase to resolve the arg values)

func (*Mod) Save 

func (m *Mod) Save() error

func (*Mod) SetDependencyConfig added in v0.20.0 

func (m *Mod) SetDependencyConfig(dependencyPath string) error

SetDependencyConfig sets DependencyPath, DependencyName and Version

func (*Mod) SetFilePath 

func (m *Mod) SetFilePath(modFilePath string)

func (*Mod) SetPaths 

func (m *Mod) SetPaths()

SetPaths implements ModTreeItem (override base functionality)

func (*Mod) ValidateRequirements added in v0.20.0 

func (m *Mod) ValidateRequirements(pluginVersionMap map[string]*PluginVersionString) []error

ValidateRequirements validates that the current steampipe CLI and the installed plugins is compatible with the mod

func (*Mod) WalkResources 

func (m *Mod) WalkResources(resourceFunc func(item HclResource) (bool, error)) error

type ModMap 

type ModMap map[string]*Mod

ModMap is a map of mod name to mod

type ModTreeItem 

type ModTreeItem interface {
	HclResource
	AddParent(ModTreeItem) error
	GetParents() []ModTreeItem
	GetChildren() []ModTreeItem
	// GetPaths returns an array resource paths
	GetPaths() []NodePath
	SetPaths()
	GetMod() *Mod
	GetModTreeItemImpl() *ModTreeItemImpl
}

ModTreeItem must be implemented by elements of the mod resource hierarchy i.e. Control, Benchmark, Dashboard

type ModTreeItemImpl added in v0.19.0 

type ModTreeItemImpl struct {
	HclResourceImpl
	// required to allow partial decoding
	ModTreeItemRemain hcl.Body `hcl:",remain" json:"-"`

	Mod   *Mod       `cty:"mod" json:"-"`
	Paths []NodePath `column:"path,jsonb" json:"-"`
	// contains filtered or unexported fields
}

func (*ModTreeItemImpl) AddParent added in v0.19.0 

func (b *ModTreeItemImpl) AddParent(parent ModTreeItem) error

AddParent implements ModTreeItem

func (*ModTreeItemImpl) CtyValue added in v0.19.0 

func (b *ModTreeItemImpl) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*ModTreeItemImpl) GetChildren added in v0.19.0 

func (b *ModTreeItemImpl) GetChildren() []ModTreeItem

GetChildren implements ModTreeItem

func (*ModTreeItemImpl) GetMod added in v0.19.0 

func (b *ModTreeItemImpl) GetMod() *Mod

func (*ModTreeItemImpl) GetModTreeItemImpl added in v0.19.0 

func (b *ModTreeItemImpl) GetModTreeItemImpl() *ModTreeItemImpl

GetModTreeItemImpl implements ModTreeItem

func (*ModTreeItemImpl) GetParents added in v0.19.0 

func (b *ModTreeItemImpl) GetParents() []ModTreeItem

GetParents implements ModTreeItem

func (*ModTreeItemImpl) GetPaths added in v0.19.0 

func (b *ModTreeItemImpl) GetPaths() []NodePath

func (*ModTreeItemImpl) SetPaths added in v0.19.0 

func (b *ModTreeItemImpl) SetPaths()

SetPaths implements ModTreeItem

type ModVariableMap 

type ModVariableMap struct {
	// which mod have these variables been loaded for?
	Mod *Mod
	// top level variables, keyed by short name
	RootVariables map[string]*Variable
	// map of dependency variable maps, keyed by dependency NAME
	DependencyVariables map[string]*ModVariableMap

	// a list of the pointers to the variables whose values can be changed
	// NOTE: this refers to the SAME variable objects as exist in the RootVariables and DependencyVariables maps,
	// so when we set the value of public variables, we mutate the underlying variable
	PublicVariables map[string]*Variable
}

ModVariableMap is a struct containins maps of variable definitions

func NewModVariableMap 

func NewModVariableMap(mod *Mod) *ModVariableMap

NewModVariableMap builds a ModVariableMap using the variables from a mod and its dependencies

func (*ModVariableMap) GetPublicVariableValues added in v0.20.6 

func (m *ModVariableMap) GetPublicVariableValues() (map[string]string, error)

GetPublicVariableValues converts public variables into a map of string variable values

func (*ModVariableMap) PopulatePublicVariables added in v0.20.6 

func (m *ModVariableMap) PopulatePublicVariables()

PopulatePublicVariables builds a map of top level and dependency variables (dependency variables are keyed by full (qualified) name

func (*ModVariableMap) String added in v0.21.7 

func (m *ModVariableMap) String() string

func (*ModVariableMap) ToArray 

func (m *ModVariableMap) ToArray() []*Variable

type ModVersionConstraint 

type ModVersionConstraint struct {
	// the fully qualified mod name, e.g. github.com/turbot/mod1
	Name          string `cty:"name" hcl:"name,label"`
	VersionString string `cty:"version" hcl:"version"`
	// variable values to be set on the dependency mod
	Args map[string]cty.Value `cty:"args"  hcl:"args,optional"`
	// only one of Constraint, Branch and FilePath will be set
	Constraint *versionhelpers.Constraints
	// the local file location to use
	FilePath string
	// contains the range of the definition of the mod block
	DefRange hcl.Range
	// contains the range of the body of the mod block
	BodyRange hcl.Range
	// contains the range of the total version field
	VersionRange hcl.Range
}

func NewModVersionConstraint 

func NewModVersionConstraint(modFullName string) (*ModVersionConstraint, error)

NewModVersionConstraint creates a new ModVersionConstraint - this is called when installing a mod

func (*ModVersionConstraint) DependencyPath added in v0.20.0 

func (m *ModVersionConstraint) DependencyPath() string

func (*ModVersionConstraint) Equals 

func (m *ModVersionConstraint) Equals(other *ModVersionConstraint) bool

func (*ModVersionConstraint) HasVersion 

func (m *ModVersionConstraint) HasVersion() bool

HasVersion returns whether the mod has a version specified, or is the latest if no version is specified, or the version is "latest", this is the latest version

func (*ModVersionConstraint) Initialise 

func (m *ModVersionConstraint) Initialise(block *hcl.Block) hcl.Diagnostics

Initialise parses the version and name properties

func (*ModVersionConstraint) String 

func (m *ModVersionConstraint) String() string

type ModVersionConstraintCollection 

type ModVersionConstraintCollection []*ModVersionConstraint

ModVersionConstraintCollection is a collection of ModVersionConstraint instances and implements the sort interface. See the sort package for more details. https://golang.org/pkg/sort/

func (ModVersionConstraintCollection) Len 

func (c ModVersionConstraintCollection) Len() int

Len returns the length of a collection. The number of Version instances on the slice.

func (ModVersionConstraintCollection) Less 

func (c ModVersionConstraintCollection) Less(i, j int) bool

Less is needed for the sort interface to compare two Version objects on the slice. If checks if one is less than the other.

func (ModVersionConstraintCollection) Swap 

func (c ModVersionConstraintCollection) Swap(i, j int)

Swap is needed for the sort interface to replace the Version objects at two different positions in the slice.

type NamedItem 

type NamedItem struct {
	Name string `cty:"name"`
}

NamedItem is a struct used by benchmark, container and dashboard to specify children of different types

func (NamedItem) String 

func (c NamedItem) String() string

type NamedItemList 

type NamedItemList []NamedItem

func (NamedItemList) StringList 

func (l NamedItemList) StringList() []string

type NodeAndEdgeProvider added in v0.19.0 

type NodeAndEdgeProvider interface {
	QueryProvider
	WithProvider
	GetEdges() DashboardEdgeList
	SetEdges(DashboardEdgeList)
	GetNodes() DashboardNodeList
	SetNodes(DashboardNodeList)
	AddCategory(category *DashboardCategory) hcl.Diagnostics
	AddChild(child HclResource) hcl.Diagnostics
}

NodeAndEdgeProvider must be implemented by any dashboard leaf node which supports edges and nodes (DashboardGraph, DashboardFlow, DashboardHierarchy) TODO [node_reuse] add NodeAndEdgeProviderImpl https://github.com/turbot/steampipe/issues/2918

type NodePath 

type NodePath []string

NodePath is a string array representing the parentage of a ModTreeItem

type OpenGraph 

type OpenGraph struct {
	// The opengraph description (og:description) of the mod, for use in social media applications
	Description *string `cty:"description" hcl:"description" json:"description"`
	// The opengraph display title (og:title) of the mod, for use in social media applications.
	Title     *string   `cty:"title" hcl:"title" json:"title"`
	Image     *string   `cty:"image" hcl:"image" json:"image"`
	DeclRange hcl.Range `json:"-"`
}

OpenGraph is a struct representing the OpenGraph group mod resource

type ParamDef 

type ParamDef struct {
	ShortName       string  `cty:"name" json:"name"`
	UnqualifiedName string  `cty:"full_name" json:"-"`
	Description     *string `cty:"description" json:"description"`
	Default         *string `cty:"default" json:"default"`
	// tactical - is the raw value a string
	IsString bool `cty:"is_string" json:"-"`

	// list of all blocks referenced by the resource
	References []*ResourceReference `json:"-"`
	DeclRange  hcl.Range            `json:"-"`
}

func NewParamDef 

func NewParamDef(block *hcl.Block) *ParamDef

func (*ParamDef) Equals 

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

func (*ParamDef) GetDefault added in v0.19.0 

func (p *ParamDef) GetDefault() (any, error)

GetDefault returns the default as an interface{}, unmarshalling json is the underlying value was NOT a string

func (*ParamDef) SetDefault added in v0.19.0 

func (p *ParamDef) SetDefault(value interface{}) error

SetDefault sets the default as a atring points, marshalling to json is the underlying value is NOT a string

func (*ParamDef) String 

func (p *ParamDef) String() string

type ParsedPropertyPath 

type ParsedPropertyPath struct {
	Mod          string
	ItemType     string
	Name         string
	PropertyPath []string
	// optional scope of this property path ("self")
	Scope    string
	Original string
}

func ParseResourcePropertyPath 

func ParseResourcePropertyPath(propertyPath string) (*ParsedPropertyPath, error)

func (*ParsedPropertyPath) PropertyPathString 

func (p *ParsedPropertyPath) PropertyPathString() string

func (*ParsedPropertyPath) String 

func (p *ParsedPropertyPath) String() string

func (*ParsedPropertyPath) ToParsedResourceName 

func (p *ParsedPropertyPath) ToParsedResourceName() *ParsedResourceName

func (*ParsedPropertyPath) ToResourceName 

func (p *ParsedPropertyPath) ToResourceName() string

type ParsedResourceName 

type ParsedResourceName struct {
	Mod      string
	ItemType string
	Name     string
}

func ParseResourceName 

func ParseResourceName(fullName string) (res *ParsedResourceName, err error)

func (*ParsedResourceName) ToFullName added in v0.17.0 

func (p *ParsedResourceName) ToFullName() (string, error)

func (*ParsedResourceName) ToFullNameWithMod added in v0.17.0 

func (p *ParsedResourceName) ToFullNameWithMod(mod string) (string, error)

func (*ParsedResourceName) ToResourceName 

func (p *ParsedResourceName) ToResourceName() string

type Plugin added in v0.21.0 

type Plugin struct {
	Instance        string         `hcl:"name,label" db:"plugin_instance"`
	Alias           string         `hcl:"source,optional"`
	MemoryMaxMb     *int           `hcl:"memory_max_mb,optional" db:"memory_max_mb"`
	Limiters        []*RateLimiter `hcl:"limiter,block" db:"limiters"`
	FileName        *string        `db:"file_name"`
	StartLineNumber *int           `db:"start_line_number"`
	EndLineNumber   *int           `db:"end_line_number"`
	// the image ref as a string
	Plugin string `db:"plugin"`
	// the actual plugin version, as a string
	Version string `db:"version"`
}

func NewImplicitPlugin added in v0.21.0 

func NewImplicitPlugin(connection *Connection, imageRef string) *Plugin

NewImplicitPlugin creates a default plugin config struct for a connection this is called when there is no explicit plugin config defined for a plugin which is used by a connection

func (*Plugin) Equals added in v0.21.0 

func (l *Plugin) Equals(other *Plugin) bool

func (*Plugin) FriendlyName added in v0.21.0 

func (l *Plugin) FriendlyName() string

func (*Plugin) GetLimiterMap added in v0.21.0 

func (l *Plugin) GetLimiterMap() map[string]*RateLimiter

func (*Plugin) GetMaxMemoryBytes added in v0.21.0 

func (l *Plugin) GetMaxMemoryBytes() int64

func (*Plugin) IsDefault added in v0.21.0 

func (l *Plugin) IsDefault() bool

IsDefault returns whether this config was created as a default i.e. a connection reference this plugin but there was no plugin config in this case the Instance will be the imageRef

func (*Plugin) OnDecoded added in v0.21.0 

func (l *Plugin) OnDecoded(block *hcl.Block)

type PluginVersion 

type PluginVersion struct {
	// the plugin name, as specified in the mod requires block. , e.g. turbot/mod1, aws
	RawName string `cty:"name" hcl:"name,label"`
	// the minumum version which satisfies the requirement
	MinVersionString string `cty:"min_version" hcl:"min_version,optional"`
	Constraint       *semver.Constraints
	// the org and name which are parsed from the raw name
	Org       string
	Name      string
	DeclRange hcl.Range
}

func (*PluginVersion) FullName 

func (p *PluginVersion) FullName() string

func (*PluginVersion) Initialise 

func (p *PluginVersion) Initialise(block *hcl.Block) hcl.Diagnostics

Initialise parses the version and name properties

func (*PluginVersion) ShortName 

func (p *PluginVersion) ShortName() string

func (*PluginVersion) String 

func (p *PluginVersion) String() string

type PluginVersionString added in v0.21.0 

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

func LocalPluginVersionString added in v0.21.0 

func LocalPluginVersionString() *PluginVersionString

func NewPluginVersionString added in v0.21.0 

func NewPluginVersionString(version string) (*PluginVersionString, error)

func (*PluginVersionString) IsLocal added in v0.21.0 

func (p *PluginVersionString) IsLocal() bool

func (*PluginVersionString) IsSemver added in v0.21.0 

func (p *PluginVersionString) IsSemver() bool

func (*PluginVersionString) Semver added in v0.21.0 

func (p *PluginVersionString) Semver() *semver.Version

func (*PluginVersionString) String added in v0.21.0 

func (p *PluginVersionString) String() string

type Pos 

type Pos struct {
	Line   int `json:"line"`
	Column int `json:"column"`
	Byte   int `json:"byte"`
}

Pos represents a single position in a source file This is a direct re-implementation of hcl.Pos, allowing us to control JSON serialization

func NewPos 

func NewPos(sourcePos hcl.Pos) Pos

func (Pos) GetLegacy 

func (r Pos) GetLegacy() hcl.Pos

type Query 

type Query struct {
	ResourceWithMetadataImpl
	QueryProviderImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	// only here as otherwise gocty.ImpliedType panics
	Unused string `cty:"unused" json:"-"`
}

Query is a struct representing the Query resource

func (*Query) CtyValue 

func (q *Query) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Query) Diff 

func (q *Query) Diff(other *Query) *DashboardTreeItemDiffs

func (*Query) Equals 

func (q *Query) Equals(other *Query) bool

func (*Query) InitialiseFromFile 

func (q *Query) InitialiseFromFile(modPath, filePath string) (MappableResource, []byte, error)

InitialiseFromFile implements MappableResource

func (*Query) OnDecoded 

func (q *Query) OnDecoded(*hcl.Block, ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*Query) String 

func (q *Query) String() string

type QueryArgs 

type QueryArgs struct {
	ArgMap map[string]string `cty:"args" json:"args,omitempty"`
	// args list may be sparsely populated (in case of runtime dependencies)
	// so use *string
	ArgList    []*string            `cty:"args_list" json:"args_list"`
	References []*ResourceReference `cty:"refs" json:"refs"`
	// contains filtered or unexported fields
}

QueryArgs is a struct which contains the arguments used to invoke a query these may either be passed by name, in a map, or as a list of positional args NOTE: if both are present the named parameters are used

func MergeArgs 

func MergeArgs(queryProvider QueryProvider, runtimeArgs *QueryArgs) (*QueryArgs, error)

MergeArgs ensures base and runtime args are non nil and merges them into single args

func NewQueryArgs 

func NewQueryArgs() *QueryArgs

func (*QueryArgs) ArgsStringList 

func (q *QueryArgs) ArgsStringList() []string

ArgsStringList convert ArgLists into list of strings

func (*QueryArgs) ConvertArgsList added in v0.19.0 

func (q *QueryArgs) ConvertArgsList() ([]any, error)

ConvertArgsList convert argList into list of interface{} by unmarshalling

func (*QueryArgs) Empty 

func (q *QueryArgs) Empty() bool

func (*QueryArgs) Equals 

func (q *QueryArgs) Equals(other *QueryArgs) bool

func (*QueryArgs) GetNamedArg added in v0.19.0 

func (q *QueryArgs) GetNamedArg(name string) (interface{}, bool, error)

func (*QueryArgs) GetPositionalArg added in v0.19.0 

func (q *QueryArgs) GetPositionalArg(idx int) (interface{}, bool, error)

func (*QueryArgs) Merge 

func (q *QueryArgs) Merge(other *QueryArgs, source QueryProvider) (*QueryArgs, error)

Merge merges the other args with ourselves, creating and returning a new QueryArgs with the result NOTE: other has precedence

func (*QueryArgs) SetArgList added in v0.19.0 

func (q *QueryArgs) SetArgList(argList []any) error

func (*QueryArgs) SetArgMap added in v0.19.0 

func (q *QueryArgs) SetArgMap(argMap map[string]any) error

func (*QueryArgs) SetNamedArgVal added in v0.19.0 

func (q *QueryArgs) SetNamedArgVal(value any, name string) (err error)

func (*QueryArgs) SetPositionalArgVal added in v0.19.0 

func (q *QueryArgs) SetPositionalArgVal(value any, idx int) (err error)

func (*QueryArgs) String 

func (q *QueryArgs) String() string

func (*QueryArgs) ToString added in v0.19.0 

func (q *QueryArgs) ToString(value any) (string, error)

func (*QueryArgs) Validate 

func (q *QueryArgs) Validate() error

type QueryProvider 

type QueryProvider interface {
	RuntimeDependencyProvider
	GetArgs() *QueryArgs
	GetParams() []*ParamDef
	GetSQL() *string
	GetQuery() *Query
	SetArgs(*QueryArgs)
	SetParams([]*ParamDef)
	GetResolvedQuery(*QueryArgs) (*ResolvedQuery, error)
	RequiresExecution(QueryProvider) bool
	ValidateQuery() hcl.Diagnostics
	MergeParentArgs(QueryProvider, QueryProvider) hcl.Diagnostics
	GetQueryProviderImpl() *QueryProviderImpl
	ParamsInheritedFromBase() bool
	ArgsInheritedFromBase() bool
}

QueryProvider must be implemented by resources which have query/sql

type QueryProviderImpl added in v0.19.0 

type QueryProviderImpl struct {
	RuntimeDependencyProviderImpl
	QueryProviderRemain hcl.Body `hcl:",remain" json:"-"`

	SQL       *string     `cty:"sql" hcl:"sql" column:"sql,text" json:"-"`
	Query     *Query      `cty:"query" hcl:"query" json:"-"`
	Args      *QueryArgs  `cty:"args" column:"args,jsonb" json:"-"`
	Params    []*ParamDef `cty:"params" column:"params,jsonb" json:"-"`
	QueryName *string     `column:"query,text" json:"-"`
	// contains filtered or unexported fields
}

func (*QueryProviderImpl) ArgsInheritedFromBase added in v0.19.0 

func (q *QueryProviderImpl) ArgsInheritedFromBase() bool

ArgsInheritedFromBase implements QueryProvider determine whether our args were inherited from base resource

func (*QueryProviderImpl) CtyValue added in v0.19.0 

func (q *QueryProviderImpl) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*QueryProviderImpl) GetArgs added in v0.19.0 

func (q *QueryProviderImpl) GetArgs() *QueryArgs

GetArgs implements QueryProvider

func (*QueryProviderImpl) GetParams added in v0.19.0 

func (q *QueryProviderImpl) GetParams() []*ParamDef

GetParams implements QueryProvider

func (*QueryProviderImpl) GetQuery added in v0.19.0 

func (q *QueryProviderImpl) GetQuery() *Query

GetQuery implements QueryProvider

func (*QueryProviderImpl) GetQueryProviderImpl added in v0.19.0 

func (q *QueryProviderImpl) GetQueryProviderImpl() *QueryProviderImpl

GetQueryProviderImpl implements QueryProvider

func (*QueryProviderImpl) GetResolvedQuery added in v0.19.0 

func (q *QueryProviderImpl) GetResolvedQuery(runtimeArgs *QueryArgs) (*ResolvedQuery, error)

GetResolvedQuery return the SQL and args to run the query

func (*QueryProviderImpl) GetSQL added in v0.19.0 

func (q *QueryProviderImpl) GetSQL() *string

GetSQL implements QueryProvider

func (*QueryProviderImpl) MergeParentArgs added in v0.19.0 

func (q *QueryProviderImpl) MergeParentArgs(queryProvider QueryProvider, parent QueryProvider) (diags hcl.Diagnostics)

MergeParentArgs merges our args with our parent args (ours take precedence)

func (*QueryProviderImpl) OnDecoded added in v0.20.0 

func (q *QueryProviderImpl) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

func (*QueryProviderImpl) ParamsInheritedFromBase added in v0.19.0 

func (q *QueryProviderImpl) ParamsInheritedFromBase() bool

ParamsInheritedFromBase implements QueryProvider determine whether our params were inherited from base resource

func (*QueryProviderImpl) RequiresExecution added in v0.19.0 

func (q *QueryProviderImpl) RequiresExecution(queryProvider QueryProvider) bool

RequiresExecution implements QueryProvider

func (*QueryProviderImpl) SetArgs added in v0.19.0 

func (q *QueryProviderImpl) SetArgs(args *QueryArgs)

SetArgs implements QueryProvider

func (*QueryProviderImpl) SetParams added in v0.19.0 

func (q *QueryProviderImpl) SetParams(params []*ParamDef)

SetParams implements QueryProvider

func (*QueryProviderImpl) ValidateQuery added in v0.19.0 

func (q *QueryProviderImpl) ValidateQuery() hcl.Diagnostics

ValidateQuery implements QueryProvider returns an error if neither sql or query are set it is overidden by resource types for which sql is optional

type Range 

type Range struct {
	// Filename is the name of the file into which this range's positions point.
	Filename string `json:"filename,omitempty"`

	// Start and End represent the bounds of this range. Start is inclusive and End is exclusive.
	Start Pos `json:"start,omitempty"`
	End   Pos `json:"end,omitempty"`
}

Range represents a span of characters between two positions in a source file. This is a direct re-implementation of hcl.Range, allowing us to control JSON serialization

func NewRange 

func NewRange(sourceRange hcl.Range) Range

func (Range) GetLegacy 

func (r Range) GetLegacy() hcl.Range

type RateLimiter added in v0.21.0 

type RateLimiter struct {
	Name            string                          `hcl:"name,label" db:"name"`
	BucketSize      *int64                          `hcl:"bucket_size,optional" db:"bucket_size"`
	FillRate        *float32                        `hcl:"fill_rate,optional" db:"fill_rate"`
	MaxConcurrency  *int64                          `hcl:"max_concurrency,optional" db:"max_concurrency"`
	Scope           []string                        `hcl:"scope,optional" db:"scope"`
	Where           *string                         `hcl:"where,optional" db:"where"`
	Plugin          string                          `db:"plugin"`
	PluginInstance  string                          `db:"plugin_instance"`
	FileName        *string                         `db:"file_name" json:"-"`
	StartLineNumber *int                            `db:"start_line_number"  json:"-"`
	EndLineNumber   *int                            `db:"end_line_number"  json:"-"`
	Status          string                          `db:"status"`
	Source          string                          `db:"source_type"`
	ImageRef        *ociinstaller.SteampipeImageRef `db:"-" json:"-"`
}

func RateLimiterFromProto added in v0.21.0 

func RateLimiterFromProto(p *proto.RateLimiterDefinition, pluginImageRef, pluginInstance string) (*RateLimiter, error)

RateLimiterFromProto converts the proto format RateLimiterDefinition into a Defintion

func (*RateLimiter) AsProto added in v0.21.0 

func (l *RateLimiter) AsProto() *proto.RateLimiterDefinition

func (*RateLimiter) Equals added in v0.21.0 

func (l *RateLimiter) Equals(other *RateLimiter) bool

func (*RateLimiter) OnDecoded added in v0.21.0 

func (l *RateLimiter) OnDecoded(block *hcl.Block)

func (*RateLimiter) SetPlugin added in v0.21.0 

func (l *RateLimiter) SetPlugin(plugin *Plugin)

type Require 

type Require struct {
	Plugins                          []*PluginVersion        `hcl:"plugin,block"`
	DeprecatedSteampipeVersionString string                  `hcl:"steampipe,optional"`
	Steampipe                        *SteampipeRequire       `hcl:"steampipe,block"`
	Mods                             []*ModVersionConstraint `hcl:"mod,block"`

	// range of the definition of the require block
	DeclRange hcl.Range
	// range of the require block type
	TypeRange hcl.Range
	// contains filtered or unexported fields
}

Require is a struct representing mod dependencies

func NewRequire 

func NewRequire() *Require

func (*Require) AddModDependencies 

func (r *Require) AddModDependencies(newModVersions map[string]*ModVersionConstraint)

AddModDependencies adds all the mod in newModVersions to our list of mods, using the following logic - if a mod with same name, [alias] and constraint exists, it is not added - if a mod with same name [and alias] and different constraint exist, it is replaced

func (*Require) Clone added in v0.20.0 

func (r *Require) Clone() *Require

func (*Require) ContainsMod 

func (r *Require) ContainsMod(requiredModVersion *ModVersionConstraint) bool

func (*Require) Empty 

func (r *Require) Empty() bool

func (*Require) GetModDependency 

func (r *Require) GetModDependency(name string) *ModVersionConstraint

func (*Require) RemoveAllModDependencies 

func (r *Require) RemoveAllModDependencies()

func (*Require) RemoveModDependencies 

func (r *Require) RemoveModDependencies(versions map[string]*ModVersionConstraint)

func (*Require) SteampipeVersionConstraint added in v0.20.0 

func (r *Require) SteampipeVersionConstraint() *semver.Constraints

type ResolvedQuery 

type ResolvedQuery struct {
	Name        string
	ExecuteSQL  string
	RawSQL      string
	Args        []any
	IsMetaQuery bool
}

ResolvedQuery contains the execute SQL, raw SQL and args string used to execute a query

func (ResolvedQuery) QueryArgs added in v0.19.0 

func (r ResolvedQuery) QueryArgs() *QueryArgs

QueryArgs converts the ResolvedQuery into QueryArgs

type ResourceDependency 

type ResourceDependency struct {
	Range      hcl.Range
	Traversals []hcl.Traversal
}

func (*ResourceDependency) IsRuntimeDependency 

func (d *ResourceDependency) IsRuntimeDependency() bool

func (*ResourceDependency) String 

func (d *ResourceDependency) String() string

type ResourceMaps added in v0.17.0 

type ResourceMaps struct {
	// the parent mod
	Mod *Mod

	// all mods (including deps)
	Benchmarks            map[string]*Benchmark
	Controls              map[string]*Control
	Dashboards            map[string]*Dashboard
	DashboardCategories   map[string]*DashboardCategory
	DashboardCards        map[string]*DashboardCard
	DashboardCharts       map[string]*DashboardChart
	DashboardContainers   map[string]*DashboardContainer
	DashboardEdges        map[string]*DashboardEdge
	DashboardFlows        map[string]*DashboardFlow
	DashboardGraphs       map[string]*DashboardGraph
	DashboardHierarchies  map[string]*DashboardHierarchy
	DashboardImages       map[string]*DashboardImage
	DashboardInputs       map[string]map[string]*DashboardInput
	DashboardTables       map[string]*DashboardTable
	DashboardTexts        map[string]*DashboardText
	DashboardNodes        map[string]*DashboardNode
	GlobalDashboardInputs map[string]*DashboardInput
	Locals                map[string]*Local
	Mods                  map[string]*Mod
	Queries               map[string]*Query
	References            map[string]*ResourceReference
	// map of snapshot paths, keyed by snapshot name
	Snapshots map[string]string
	Variables map[string]*Variable
}

ResourceMaps is a struct containing maps of all mod resource types This is provided to avoid db needing to reference workspace package

func NewModResources added in v0.17.0 

func NewModResources(mod *Mod) *ResourceMaps

func NewSourceSnapshotModResources added in v0.17.0 

func NewSourceSnapshotModResources(snapshotPaths []string) *ResourceMaps

func (*ResourceMaps) AddResource added in v0.17.0 

func (m *ResourceMaps) AddResource(item HclResource) hcl.Diagnostics

func (*ResourceMaps) AddSnapshots added in v0.17.0 

func (m *ResourceMaps) AddSnapshots(snapshotPaths []string)

func (*ResourceMaps) Empty added in v0.17.0 

func (m *ResourceMaps) Empty() bool

func (*ResourceMaps) Equals added in v0.17.0 

func (m *ResourceMaps) Equals(other *ResourceMaps) bool

func (*ResourceMaps) GetResource added in v0.19.0 

func (m *ResourceMaps) GetResource(parsedName *ParsedResourceName) (resource HclResource, found bool)

GetResource tries to find a resource with the given name in the ResourceMaps NOTE: this does NOT support inputs, which are NOT uniquely named in a mod

func (*ResourceMaps) Merge added in v0.17.0 

func (m *ResourceMaps) Merge(others []*ResourceMaps) *ResourceMaps

func (*ResourceMaps) PopulateReferences added in v0.17.0 

func (m *ResourceMaps) PopulateReferences()

func (*ResourceMaps) QueryProviders added in v0.17.0 

func (m *ResourceMaps) QueryProviders() []QueryProvider

QueryProviders returns a slice of all QueryProviders

func (*ResourceMaps) TopLevelResources added in v0.20.0 

func (m *ResourceMaps) TopLevelResources() *ResourceMaps

TopLevelResources returns a new ResourceMaps containing only top level resources (i.e. no dependencies)

func (*ResourceMaps) WalkResources added in v0.17.0 

func (m *ResourceMaps) WalkResources(resourceFunc func(item HclResource) (bool, error)) error

WalkResources calls resourceFunc for every resource in the mod if any resourceFunc returns false or an error, return immediately

type ResourceMapsProvider added in v0.17.0 

type ResourceMapsProvider interface {
	GetResourceMaps() *ResourceMaps
	GetResource(parsedName *ParsedResourceName) (resource HclResource, found bool)
}

type ResourceMetadata 

type ResourceMetadata struct {
	ResourceName string `column:"resource_name,text"`
	// mod short name
	ModName          string `column:"mod_name,text"`
	FileName         string `column:"file_name,text"`
	StartLineNumber  int    `column:"start_line_number,integer"`
	EndLineNumber    int    `column:"end_line_number,integer"`
	IsAutoGenerated  bool   `column:"auto_generated,bool"`
	SourceDefinition string `column:"source_definition,text"`
	ModFullName      string
	Anonymous        bool `column:"is_anonymous,bool"`
}

ResourceMetadata ius a struct containing additional data about each resource, used to populate the introspection tables

func (*ResourceMetadata) Clone added in v0.19.0 

func (m *ResourceMetadata) Clone() *ResourceMetadata

func (*ResourceMetadata) SetMod 

func (m *ResourceMetadata) SetMod(mod *Mod)

SetMod sets the mod name and mod short name

type ResourceReference 

type ResourceReference struct {
	ResourceWithMetadataImpl

	To        string `cty:"reference_to" column:"reference_to,text"`
	From      string `cty:"reference_from" column:"reference_from,text"`
	BlockType string `cty:"from_block_type" column:"from_block_type,text"`
	BlockName string `cty:"from_block_name" column:"from_block_name,text"`
	Attribute string `cty:"from_attribute" column:"from_attribute,text"`
	// contains filtered or unexported fields
}

func NewResourceReference added in v0.19.0 

func NewResourceReference(resource HclResource, block *hcl.Block, referenceString string, blockName string, attr *hclsyntax.Attribute) *ResourceReference

func (*ResourceReference) CloneWithNewFrom added in v0.19.0 

func (r *ResourceReference) CloneWithNewFrom(from string) *ResourceReference

func (*ResourceReference) Equals 

func (r *ResourceReference) Equals(other *ResourceReference) bool

func (*ResourceReference) Name 

func (r *ResourceReference) Name() string

Name implements ResourceWithMetadata the name must start with the 'resource type' as we parse it and use just the 'name' segment

func (*ResourceReference) String 

func (r *ResourceReference) String() string

type ResourceReferenceMap 

type ResourceReferenceMap map[string][]*ResourceReference

ResourceReferenceMap is a map of references keyed by 'ref' This is to handle the same reference being made more than once by a resource for example the reference var.v1 might be referenced several times

func (ResourceReferenceMap) Add 

func (m ResourceReferenceMap) Add(reference *ResourceReference)

type ResourceWithMetadata 

type ResourceWithMetadata interface {
	Name() string
	GetMetadata() *ResourceMetadata
	SetMetadata(metadata *ResourceMetadata)
	SetAnonymous(block *hcl.Block)
	IsAnonymous() bool
	AddReference(ref *ResourceReference)
	GetReferences() []*ResourceReference
}

ResourceWithMetadata must be implemented by resources which supports reflection metadata

type ResourceWithMetadataImpl added in v0.19.0 

type ResourceWithMetadataImpl struct {
	// required to allow partial decoding
	ResourceWithMetadataBaseRemain hcl.Body             `hcl:",remain" json:"-"`
	References                     []*ResourceReference `json:"-"`
	// contains filtered or unexported fields
}

func (*ResourceWithMetadataImpl) AddReference added in v0.19.0 

func (b *ResourceWithMetadataImpl) AddReference(ref *ResourceReference)

AddReference implements ResourceWithMetadata

func (*ResourceWithMetadataImpl) GetMetadata added in v0.19.0 

func (b *ResourceWithMetadataImpl) GetMetadata() *ResourceMetadata

GetMetadata implements ResourceWithMetadata

func (*ResourceWithMetadataImpl) GetReferences added in v0.19.0 

func (b *ResourceWithMetadataImpl) GetReferences() []*ResourceReference

GetReferences implements ResourceWithMetadata

func (*ResourceWithMetadataImpl) IsAnonymous added in v0.19.0 

func (b *ResourceWithMetadataImpl) IsAnonymous() bool

IsAnonymous implements ResourceWithMetadata

func (*ResourceWithMetadataImpl) SetAnonymous added in v0.19.0 

func (b *ResourceWithMetadataImpl) SetAnonymous(block *hcl.Block)

SetAnonymous implements ResourceWithMetadata

func (*ResourceWithMetadataImpl) SetMetadata added in v0.19.0 

func (b *ResourceWithMetadataImpl) SetMetadata(metadata *ResourceMetadata)

SetMetadata implements ResourceWithMetadata

type RuntimeDependency 

type RuntimeDependency struct {
	PropertyPath       *ParsedPropertyPath
	TargetPropertyName *string
	// TACTICAL the name of the parent property - either "args" or "param.<name>"
	ParentPropertyName  string
	TargetPropertyIndex *int

	// TACTICAL - if set, wrap the dependency value in an array
	// this provides support for args which convert a runtime dependency to an array, like:
	// arns = [input.arn]
	IsArray bool

	// resource which provides has the dependency
	Provider HclResource
}

func (*RuntimeDependency) Equals 

func (d *RuntimeDependency) Equals(other *RuntimeDependency) bool

func (*RuntimeDependency) SourceResourceName added in v0.19.0 

func (d *RuntimeDependency) SourceResourceName() string

func (*RuntimeDependency) String 

func (d *RuntimeDependency) String() string

func (*RuntimeDependency) ValidateSource added in v0.19.0 

func (d *RuntimeDependency) ValidateSource(dashboard *Dashboard, workspace ResourceMapsProvider) error

type RuntimeDependencyProvider added in v0.19.0 

type RuntimeDependencyProvider interface {
	ModTreeItem
	AddRuntimeDependencies([]*RuntimeDependency)
	GetRuntimeDependencies() map[string]*RuntimeDependency
}

RuntimeDependencyProvider is implemented by all QueryProviders and Dashboard

type RuntimeDependencyProviderImpl added in v0.19.0 

type RuntimeDependencyProviderImpl struct {
	ModTreeItemImpl
	// required to allow partial decoding
	RuntimeDependencyProviderRemain hcl.Body `hcl:",remain" json:"-"`
	// contains filtered or unexported fields
}

func (*RuntimeDependencyProviderImpl) AddRuntimeDependencies added in v0.19.0 

func (b *RuntimeDependencyProviderImpl) AddRuntimeDependencies(dependencies []*RuntimeDependency)

func (*RuntimeDependencyProviderImpl) GetRuntimeDependencies added in v0.19.0 

func (b *RuntimeDependencyProviderImpl) GetRuntimeDependencies() map[string]*RuntimeDependency

type SteampipeRequire added in v0.20.0 

type SteampipeRequire struct {
	MinVersionString string `hcl:"min_version,optional"`
	Constraint       *semver.Constraints
	DeclRange        hcl.Range
}

type Variable 

type Variable struct {
	ResourceWithMetadataImpl
	ModTreeItemImpl

	// required to allow partial decoding
	Remain hcl.Body `hcl:",remain" json:"-"`

	Default cty.Value `column:"default_value,jsonb" json:"-"`
	Type    cty.Type  `column:"var_type,text" json:"-"`

	TypeString string `json:"type"`
	DefaultGo  any    `json:"value_default"`
	ValueGo    any    `json:"value"`
	ModName    string `json:"mod_name"`

	// set after value resolution `column:"value,jsonb"`
	Value                      cty.Value                      `column:"value,jsonb" json:"-"`
	ValueSourceType            string                         `column:"value_source,text" json:"-"`
	ValueSourceFileName        string                         `column:"value_source_file_name,text" json:"-"`
	ValueSourceStartLineNumber int                            `column:"value_source_start_line_number,integer" json:"-"`
	ValueSourceEndLineNumber   int                            `column:"value_source_end_line_number,integer" json:"-"`
	ParsingMode                var_config.VariableParsingMode `json:"-"`
	// contains filtered or unexported fields
}

Variable is a struct representing a Variable resource

func NewVariable 

func NewVariable(v *var_config.Variable, mod *Mod) *Variable

func (*Variable) CtyValue 

func (v *Variable) CtyValue() (cty.Value, error)

CtyValue implements CtyValueProvider

func (*Variable) Diff 

func (v *Variable) Diff(other *Variable) *DashboardTreeItemDiffs

func (*Variable) Equals 

func (v *Variable) Equals(other *Variable) bool

func (*Variable) OnDecoded 

func (v *Variable) OnDecoded(block *hcl.Block, _ ResourceMapsProvider) hcl.Diagnostics

OnDecoded implements HclResource

func (*Variable) Required 

func (v *Variable) Required() bool

Required returns true if this variable is required to be set by the caller, or false if there is a default value that will be used when it isn't set.

func (*Variable) SetInputValue 

func (v *Variable) SetInputValue(value cty.Value, sourceType string, sourceRange tfdiags.SourceRange) error

type VariableValidationFailedError 

type VariableValidationFailedError struct {
}

func (VariableValidationFailedError) Error 

func (m VariableValidationFailedError) Error() string

type VersionConstrainCollection 

type VersionConstrainCollection []*ModVersionConstraint

type WithProvider added in v0.19.0 

type WithProvider interface {
	AddWith(with *DashboardWith) hcl.Diagnostics
	GetWiths() []*DashboardWith
	GetWith(string) (*DashboardWith, bool)
}

type WithProviderImpl added in v0.19.0 

type WithProviderImpl struct {
	// required to allow partial decoding
	WithProviderRemain hcl.Body `hcl:",remain" json:"-"`
	// contains filtered or unexported fields
}

func (*WithProviderImpl) AddWith added in v0.19.0 

func (b *WithProviderImpl) AddWith(with *DashboardWith) hcl.Diagnostics

func (*WithProviderImpl) GetWith added in v0.19.0 

func (b *WithProviderImpl) GetWith(name string) (*DashboardWith, bool)

func (*WithProviderImpl) GetWiths added in v0.19.0 

func (b *WithProviderImpl) GetWiths() []*DashboardWith

type WorkspaceProfile added in v0.17.0 

type WorkspaceProfile struct {
	ProfileName string `hcl:"name,label" cty:"name"`
	// deprecated
	CloudHost *string `hcl:"cloud_host,optional" cty:"cloud_host"`
	PipesHost *string `hcl:"pipes_host,optional" cty:"pipes_host"`
	// deprecated
	CloudToken        *string           `hcl:"cloud_token,optional" cty:"cloud_token"`
	PipesToken        *string           `hcl:"pipes_token,optional" cty:"pipes_token"`
	InstallDir        *string           `hcl:"install_dir,optional" cty:"install_dir"`
	ModLocation       *string           `hcl:"mod_location,optional" cty:"mod_location"`
	QueryTimeout      *int              `hcl:"query_timeout,optional" cty:"query_timeout"`
	SnapshotLocation  *string           `hcl:"snapshot_location,optional" cty:"snapshot_location"`
	WorkspaceDatabase *string           `hcl:"workspace_database,optional" cty:"workspace_database"`
	SearchPath        *string           `hcl:"search_path" cty:"search_path"`
	SearchPathPrefix  *string           `hcl:"search_path_prefix" cty:"search_path_prefix"`
	Watch             *bool             `hcl:"watch" cty:"watch"`
	MaxParallel       *int              `hcl:"max_parallel" cty:"max-parallel"`
	Introspection     *string           `hcl:"introspection" cty:"introspection"`
	Input             *bool             `hcl:"input" cty:"input"`
	Progress          *bool             `hcl:"progress" cty:"progress"`
	Theme             *string           `hcl:"theme" cty:"theme"`
	Cache             *bool             `hcl:"cache" cty:"cache"`
	CacheTTL          *int              `hcl:"cache_ttl" cty:"cache_ttl"`
	Base              *WorkspaceProfile `hcl:"base"`

	// options
	QueryOptions     *options.Query                     `cty:"query-options"`
	CheckOptions     *options.Check                     `cty:"check-options"`
	DashboardOptions *options.WorkspaceProfileDashboard `cty:"dashboard-options"`
	DeclRange        hcl.Range
	// contains filtered or unexported fields
}

func NewWorkspaceProfile added in v0.17.0 

func NewWorkspaceProfile(block *hcl.Block) *WorkspaceProfile

func (*WorkspaceProfile) ConfigMap added in v0.17.0 

func (p *WorkspaceProfile) ConfigMap(cmd *cobra.Command) map[string]interface{}

ConfigMap creates a config map containing all options to pass to viper

func (*WorkspaceProfile) CtyValue added in v0.17.0 

func (p *WorkspaceProfile) CtyValue() (cty.Value, error)

func (*WorkspaceProfile) Name added in v0.17.0 

func (p *WorkspaceProfile) Name() string

func (*WorkspaceProfile) OnDecoded added in v0.17.0 

func (p *WorkspaceProfile) OnDecoded() hcl.Diagnostics

func (*WorkspaceProfile) SetOptions added in v0.17.0 

func (p *WorkspaceProfile) SetOptions(opts options.Options, block *hcl.Block) hcl.Diagnostics

SetOptions sets the options on the connection verify the options object is a valid options type (only options.Connection currently supported)

type WorkspaceResources 

type WorkspaceResources struct {
	Query     map[string]bool
	Control   map[string]bool
	Benchmark map[string]bool
}

WorkspaceResources is used exclusively for the query/check command completion TODO to be refactored

func NewWorkspaceResources 

func NewWorkspaceResources() *WorkspaceResources

func (*WorkspaceResources) GetSortedBenchmarksAndControlNames 

func (w *WorkspaceResources) GetSortedBenchmarksAndControlNames() []string

GetSortedBenchmarksAndControlNames gives back a list of the benchmarks and controls in the current workspace. The list is sorted alphabetically - with the benchmarks first

func (*WorkspaceResources) GetSortedNamedQueryNames 

func (w *WorkspaceResources) GetSortedNamedQueryNames() []string

func (*WorkspaceResources) Merge 

func (r *WorkspaceResources) Merge(other *WorkspaceResources) *WorkspaceResources

Source Files

View all Source files

Directories

Path Synopsis

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.