steampipeconfig

Documentation

Index

• Constants
• Variables
• func IsPipesWorkspaceIdentifier(name string) bool
• func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error
• type ActorMetadata
• type DependencyPathKey
  • func NewDependencyPathKey(dependencyPath ...string) DependencyPathKey
  • func (k DependencyPathKey) GetParent() DependencyPathKey
  • func (k DependencyPathKey) PathLength() int
• type ErrorsAndWarningsNotification
  • func NewErrorsAndWarningsNotification(errorAndWarnings error_helpers.ErrorAndWarnings) *ErrorsAndWarningsNotification
• type IdentityMetadata
• type MissingVariableError
  • func NewMissingVarsError(workspaceMod *modconfig.Mod) MissingVariableError
  • func (m MissingVariableError) Error() string
• type PipesMetadata
• type PostgresNotification
  • func NewSchemaUpdateNotification() *PostgresNotification
• type PostgresNotificationType
• type SnapshotPanel
• type SnapshotTreeNode
• type SteampipeSnapshot
  • func (s *SteampipeSnapshot) AsCloudSnapshot() (*steampipecloud.WorkspaceSnapshotData, error)
  • func (s *SteampipeSnapshot) AsStrippedJson(indent bool) ([]byte, error)
  • func (*SteampipeSnapshot) IsExportSourceData()
• type ValidationFailure
  • func (v ValidationFailure) String() string
• type VariableValidationFailedError
  • func NewVariableValidationFailedError(diags tfdiags.Diagnostics) VariableValidationFailedError
  • func (m VariableValidationFailedError) Error() string
• type WorkspaceMetadata

Constants

const PostgresNotificationStructVersion = 20230306

Variables

var SteampipeSnapshotSchemaVersion int64 = 20240607

Functions

func IsPipesWorkspaceIdentifier

func IsPipesWorkspaceIdentifier(name string) bool

IsPipesWorkspaceIdentifier returns whether name is a cloud workspace identifier of the form: {identity_handle}/{workspace_handle},

func StripSnapshot

func StripSnapshot(snapshot *steampipecloud.WorkspaceSnapshotData) error

Types

type ActorMetadata

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

type DependencyPathKey

type DependencyPathKey string

DependencyPathKey is a string representation of a dependency path

• a set of mod dependencyPath values separated by '->'

e.g. local -> github.com/kaidaguerre/steampipe-mod-m1@v3.1.1 -> github.com/kaidaguerre/steampipe-mod-m2@v5.1.1

func NewDependencyPathKey

func NewDependencyPathKey(dependencyPath ...string) DependencyPathKey

func (DependencyPathKey) GetParent

func (k DependencyPathKey) GetParent() DependencyPathKey

func (DependencyPathKey) PathLength

func (k DependencyPathKey) PathLength() int

how long is the depdency path

type ErrorsAndWarningsNotification

type ErrorsAndWarningsNotification struct {
	PostgresNotification
	Errors   []string
	Warnings []string
}

func NewErrorsAndWarningsNotification

func NewErrorsAndWarningsNotification(errorAndWarnings error_helpers.ErrorAndWarnings) *ErrorsAndWarningsNotification

type IdentityMetadata

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

type MissingVariableError

type MissingVariableError struct {
	MissingVariables           []*modconfig.Variable
	MissingTransitiveVariables map[DependencyPathKey][]*modconfig.Variable
	// contains filtered or unexported fields
}

func NewMissingVarsError

func NewMissingVarsError(workspaceMod *modconfig.Mod) MissingVariableError

func (MissingVariableError) Error

func (m MissingVariableError) Error() string

type PipesMetadata

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

type PostgresNotification

type PostgresNotification struct {
	StructVersion int
	Type          PostgresNotificationType
}

func NewSchemaUpdateNotification

func NewSchemaUpdateNotification() *PostgresNotification

type PostgresNotificationType

type PostgresNotificationType int

const (
	PgNotificationSchemaUpdate PostgresNotificationType = iota + 1
	PgNotificationConnectionError
)

type SnapshotPanel

type SnapshotPanel interface {
	IsSnapshotPanel()
}

SnapshotPanel is an interface implemented by all nodes which are to be included in the Snapshot Panels map this consists of all 'Run' types - LeafRun, DashboardRun, etc.

type SnapshotTreeNode

type SnapshotTreeNode struct {
	Name     string              `json:"name"`
	Children []*SnapshotTreeNode `json:"children,omitempty"`
	NodeType string              `json:"panel_type"`
}

SnapshotTreeNode is a struct used to store the dashboard structure in the snapshot

type SteampipeSnapshot

type SteampipeSnapshot struct {
	SchemaVersion string                   `json:"schema_version"`
	Panels        map[string]SnapshotPanel `json:"panels"`
	Inputs        map[string]interface{}   `json:"inputs"`
	Variables     map[string]string        `json:"variables"`
	SearchPath    []string                 `json:"search_path"`
	StartTime     time.Time                `json:"start_time"`
	EndTime       time.Time                `json:"end_time"`
	Layout        *SnapshotTreeNode        `json:"layout"`
	FileNameRoot  string                   `json:"-"`
	Title         string                   `json:"-"`
}

func (*SteampipeSnapshot) AsCloudSnapshot

func (s *SteampipeSnapshot) AsCloudSnapshot() (*steampipecloud.WorkspaceSnapshotData, error)

func (*SteampipeSnapshot) AsStrippedJson

func (s *SteampipeSnapshot) AsStrippedJson(indent bool) ([]byte, error)

func (*SteampipeSnapshot) IsExportSourceData

func (*SteampipeSnapshot) IsExportSourceData()

IsExportSourceData implements ExportSourceData

type ValidationFailure

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

func (ValidationFailure) String

func (v ValidationFailure) String() string

type VariableValidationFailedError

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

func NewVariableValidationFailedError

func NewVariableValidationFailedError(diags tfdiags.Diagnostics) VariableValidationFailedError

func (VariableValidationFailedError) Error

func (m VariableValidationFailedError) Error() string

type WorkspaceMetadata

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