plugin

Oct 22, 2024

Changes in this version

type Column

+ Sort SortOrder

type QueryContext

+ SortOrder []*SortColumn

+ type SortColumn struct

+ Column string

+ Order SortOrder

+ func SortColumnFromProto(p *proto.SortColumn) *SortColumn

+ func (s *SortColumn) ToProto() *proto.SortColumn

+ type SortOrder int

+ const SortAll

+ const SortAsc

+ const SortDesc

+ const SortNone

+ func (s SortOrder) String() string

Apr 10, 2024

Changes in this version

+ func SqlLike(input, pattern string, caseSensitive bool) bool

+ type ConnectionKeyColumn struct

+ Hydrate HydrateFunc

+ Name string

type Plugin

+ ConnectionKeyColumns []ConnectionKeyColumn

Dec 11, 2023

Changes in this version

+ func Server(opts *ServeOpts) *grpc.PluginServer

+ type SteampipeMetadata struct

+ SdkVersion string

Nov 28, 2023

Changes in this version

type Column

+ func (c Column) ToColumnValue(val any) (*proto.Column, error)

Sep 27, 2023

Changes in this version

+ const DiagnosticsAll

+ const DiagnosticsNone

+ const EnvDiagnosticsLevel

+ const EnvLegacyDiagnosticsLevel

+ const PluginStartupFailureMessage

+ const UnrecognizedRemotePluginMessage

+ const UnrecognizedRemotePluginMessageSuffix

+ var ValidDiagnosticsLevels = map[string]struct

+ func ValidateDiagnosticsEnvVar() error

type GetConfig

+ Tags map[string]string

type HydrateConfig

+ Tags map[string]string

type ListConfig

+ ParentTags map[string]string

+ Tags map[string]string

type Plugin

+ HydrateConfig []HydrateConfig

+ RateLimiters []*rate_limiter.Definition

type QueryData

+ func (d *QueryData) WaitForListRateLimit(ctx context.Context)

type Table

+ Tags map[string]string

May 5, 2023

Changes in this version

+ func NewConnectionUpdateData() *connectionUpdateData

Mar 16, 2023

Changes in this version

type TableMapData

+ func (d *TableMapData) GetSourceFiles(source string) ([]string, error)

Mar 2, 2023

Changes in this version

+ func GetValidOperators() []string

+ func IsReservedColumnName(columnName string) bool

+ func ValidateSchemaMode(m string) error

type ConnectionData

+ AggregatedTablesByConnection map[string]map[string]*Table

+ func NewConnectionData(c *Connection, p *Plugin, config *proto.ConnectionConfig) *ConnectionData

type HydrateFunc

+ func (hydrate HydrateFunc) Memoize(opts ...MemoizeOption) HydrateFunc

+ type MemoizeConfiguration struct

+ GetCacheKeyFunc HydrateFunc

+ Ttl time.Duration

+ type MemoizeOption = func(config *MemoizeConfiguration)

type TableMapData

+ ConnectionCache *connection.ConnectionCache

Jan 11, 2023

Changes in this version

+ func DiagsToWarnings(diags hcl.Diagnostics) []string

Nov 16, 2022

Changes in this version

+ const AnyOf

+ const ContextColumnName

+ const Optional

+ const Required

+ const SchemaModeDynamic

+ const SchemaModeStatic

+ func DiagsToError(prefix string, diags hcl.Diagnostics) error

+ func GetFreeMemInterval() int64

+ func GetMatrixItem(ctx context.Context) map[string]interface

+ func GetMaxMemoryBytes() int64

+ func IsCancelled(ctx context.Context) bool

+ func Logger(ctx context.Context) hclog.Logger

+ func RetryHydrate(ctx context.Context, d *QueryData, hydrateData *HydrateData, ...) (hydrateResult interface{}, err error)

+ func Serve(opts *ServeOpts)

+ type Column struct

+ Default interface{}

+ Description string

+ Hydrate HydrateFunc

+ Name string

+ Transform *transform.ColumnTransforms

+ Type proto.ColumnType

+ type Connection struct

+ Config interface{}

+ Name string

+ type ConnectionConfigInstanceFunc func() interface

+ type ConnectionConfigSchema struct

+ NewInstance ConnectionConfigInstanceFunc

+ Schema map[string]*schema.Attribute

+ func (c *ConnectionConfigSchema) Validate() []string

+ type ConnectionData struct

+ Connection *Connection

+ Plugin *Plugin

+ Schema map[string]*proto.TableSchema

+ SchemaChangingWatchPaths []string

+ TableMap map[string]*Table

+ Watcher *filewatcher.FileWatcher

+ func (d *ConnectionData) GetConnectionTempDir(pluginTempDir string) string

+ type CreatePlugin func(context.Context, string) (*Plugin, error)

+ type DefaultConcurrencyConfig struct

+ DefaultMaxConcurrency int

+ TotalMaxConcurrency int

+ type ErrorPredicate func(error) bool

+ type ErrorPredicateWithContext func(context.Context, *QueryData, *HydrateData, error) bool

+ type ForceImport string

+ type GetConfig struct

+ Hydrate HydrateFunc

+ IgnoreConfig *IgnoreConfig

+ KeyColumns KeyColumnSlice

+ MaxConcurrency int

+ RetryConfig *RetryConfig

+ ShouldIgnoreError ErrorPredicate

+ func (c *GetConfig) Validate(table *Table) []string

+ type HydrateConfig struct

+ Depends []HydrateFunc

+ Func HydrateFunc

+ IgnoreConfig *IgnoreConfig

+ MaxConcurrency int

+ RetryConfig *RetryConfig

+ ShouldIgnoreError ErrorPredicate

+ func (c *HydrateConfig) String() interface{}

+ func (c *HydrateConfig) Validate(table *Table) []string

+ type HydrateData struct

+ HydrateResults map[string]interface{}

+ Item interface{}

+ ParentItem interface{}

+ type HydrateDependencies struct

+ Depends []HydrateFunc

+ Func HydrateFunc

+ type HydrateFunc func(context.Context, *QueryData, *HydrateData) (interface{}, error)

+ func (hydrate HydrateFunc) WithCache(args ...HydrateFunc) HydrateFunc

+ func WrapHydrate(hydrateFunc HydrateFunc, ignoreConfig *IgnoreConfig) HydrateFunc

+ type IgnoreConfig struct

+ ShouldIgnoreError ErrorPredicate

+ ShouldIgnoreErrorFunc ErrorPredicateWithContext

+ func (c *IgnoreConfig) DefaultTo(other *IgnoreConfig)

+ func (c *IgnoreConfig) String() interface{}

+ type KeyColumn struct

+ CacheMatch string

+ Name string

+ Operators []string

+ Require string

+ func (k *KeyColumn) InitialiseOperators()

+ func (k *KeyColumn) SingleEqualsQual() bool

+ func (k *KeyColumn) ToProtobuf() *proto.KeyColumn

+ func (k *KeyColumn) Validate() []string

+ func (k KeyColumn) String() string

+ type KeyColumnEqualsQualMap map[string]*proto.QualValue

+ func (m KeyColumnEqualsQualMap) GetListQualValues() map[string]*proto.QualValueList

+ func (m KeyColumnEqualsQualMap) String() string

+ type KeyColumnQualMap map[string]*KeyColumnQuals

+ func NewKeyColumnQualValueMap(qualMap map[string]*proto.Quals, keyColumns KeyColumnSlice) KeyColumnQualMap

+ func (m KeyColumnQualMap) GetListQualValues() quals.QualSlice

+ func (m KeyColumnQualMap) GetUnsatisfiedKeyColumns(columns KeyColumnSlice) KeyColumnSlice

+ func (m KeyColumnQualMap) String() string

+ func (m KeyColumnQualMap) ToEqualsQualValueMap() map[string]*proto.QualValue

+ func (m KeyColumnQualMap) ToProtoQualMap() map[string]*proto.Quals

+ func (m KeyColumnQualMap) ToQualMap() map[string]quals.QualSlice

+ type KeyColumnQuals struct

+ Name string

+ Quals quals.QualSlice

+ func (k KeyColumnQuals) SatisfiesKeyColumn(keyColumn *KeyColumn) bool

+ func (k KeyColumnQuals) SingleEqualsQual() bool

+ type KeyColumnSlice []*KeyColumn

+ func AllColumns(columns []string) KeyColumnSlice

+ func AnyColumn(columns []string) KeyColumnSlice

+ func NewEqualsKeyColumnSlice(columns []string, require string) KeyColumnSlice

+ func OptionalColumns(columns []string) KeyColumnSlice

+ func SingleColumn(column string) KeyColumnSlice

+ func (k *KeyColumnSlice) Find(name string) *KeyColumn

+ func (k KeyColumnSlice) AllEquals() bool

+ func (k KeyColumnSlice) IsAnyOf() bool

+ func (k KeyColumnSlice) String() string

+ func (k KeyColumnSlice) StringSlice() []string

+ func (k KeyColumnSlice) ToProtobuf() []*proto.KeyColumn

+ func (k KeyColumnSlice) Validate() []string

+ type ListConfig struct

+ Hydrate HydrateFunc

+ IgnoreConfig *IgnoreConfig

+ KeyColumns KeyColumnSlice

+ ParentHydrate HydrateFunc

+ RetryConfig *RetryConfig

+ ShouldIgnoreError ErrorPredicate

+ func (c *ListConfig) Validate(table *Table) []string

+ type MatrixItemFunc func(context.Context, *Connection) []map[string]interface

+ type MatrixItemMapFunc func(context.Context, *QueryData) []map[string]interface

+ type NewPluginOptions struct

+ ConnectionConfig string

+ ConnectionName string

+ type Plugin struct

+ ConnectionConfigChangedFunc func(ctx context.Context, p *Plugin, old, new *Connection) error

+ ConnectionConfigSchema *ConnectionConfigSchema

+ ConnectionMap map[string]*ConnectionData

+ DefaultConcurrency *DefaultConcurrencyConfig

+ DefaultGetConfig *GetConfig

+ DefaultIgnoreConfig *IgnoreConfig

+ DefaultRetryConfig *RetryConfig

+ DefaultShouldIgnoreError ErrorPredicate

+ DefaultTransform *transform.ColumnTransforms

+ Logger hclog.Logger

+ Name string

+ RequiredColumns []*Column

+ SchemaMode string

+ TableMap map[string]*Table

+ TableMapFunc TableMapFunc

+ WatchedFileChangedFunc func(ctx context.Context, p *Plugin, connection *Connection, ...)

+ func (p *Plugin) ClearConnectionCache(ctx context.Context, connectionName string)

+ func (p *Plugin) ClearQueryCache(ctx context.Context, connectionName string)

+ func (p *Plugin) ConnectionSchemaChanged(connectionName string) error

+ func (p *Plugin) EstablishMessageStream(stream proto.WrapperPlugin_EstablishMessageStreamServer) error

+ func (p *Plugin) Execute(req *proto.ExecuteRequest, stream proto.WrapperPlugin_ExecuteServer) (err error)

+ func (p *Plugin) GetSchema(connectionName string) (*grpc.PluginSchema, error)

+ func (p *Plugin) SetAllConnectionConfigs(configs []*proto.ConnectionConfig, maxCacheSizeMb int) (err error)

+ func (p *Plugin) SetConnectionConfig(connectionName, connectionConfigString string) (err error)

+ func (p *Plugin) UpdateConnectionConfigs(added []*proto.ConnectionConfig, deleted []*proto.ConnectionConfig, ...) error

+ type PluginFunc func(context.Context) *Plugin

+ type QueryColumn struct

+ func NewQueryColumn(column *Column, hydrateName string) *QueryColumn

+ type QueryContext struct

+ CacheEnabled bool

+ CacheTTL int64

+ Columns []string

+ Limit *int64

+ UnsafeQuals map[string]*proto.Quals

+ func NewQueryContext(p *proto.QueryContext, limit *proto.NullableInt, cacheEnabled bool, ...) *QueryContext

+ func (q *QueryContext) GetLimit() int64

+ type QueryData struct

+ Connection *Connection

+ ConnectionCache *connection_manager.ConnectionCache

+ ConnectionManager *connection_manager.Manager

+ EqualsQuals KeyColumnEqualsQualMap

+ FetchType fetchType

+ Matrix []map[string]interface{}

+ Quals KeyColumnQualMap

+ QueryContext *QueryContext

+ StreamLeafListItem func(context.Context, ...interface{})

+ StreamListItem func(context.Context, ...interface{})

+ Table *Table

+ func (d *QueryData) EqualsQualString(key string) string

+ func (d *QueryData) GetSourceFiles(source string) ([]string, error)

+ func (d *QueryData) RowsRemaining(ctx context.Context) int64

+ func (d *QueryData) ShallowCopy() *QueryData

+ type RetryConfig struct

+ BackoffAlgorithm string

+ CappedDuration int64

+ MaxAttempts int64

+ MaxDuration int64

+ RetryInterval int64

+ ShouldRetryError ErrorPredicate

+ ShouldRetryErrorFunc ErrorPredicateWithContext

+ func (c *RetryConfig) DefaultTo(other *RetryConfig)

+ func (c *RetryConfig) GetListRetryConfig() *RetryConfig

+ func (c *RetryConfig) String() interface{}

+ type ServeOpts struct

+ PluginFunc PluginFunc

+ PluginName string

+ type Table struct

+ Cache *TableCacheOptions

+ Columns []*Column

+ DefaultIgnoreConfig *IgnoreConfig

+ DefaultRetryConfig *RetryConfig

+ DefaultShouldIgnoreError ErrorPredicate

+ DefaultTransform *transform.ColumnTransforms

+ Description string

+ Get *GetConfig

+ GetMatrixItem MatrixItemFunc

+ GetMatrixItemFunc MatrixItemMapFunc

+ HydrateConfig []HydrateConfig

+ HydrateDependencies []HydrateDependencies

+ List *ListConfig

+ Name string

+ Plugin *Plugin

+ func (t *Table) ValidateColumnsExist(keyColumns KeyColumnSlice) []string

+ func (t Table) GetSchema() (*proto.TableSchema, error)

+ type TableCacheOptions struct

+ Enabled bool

+ type TableMapData struct

+ ConectionCache *connection.ConnectionCache

+ Connection *Connection

+ type TableMapFunc func(ctx context.Context, d *TableMapData) (map[string]*Table, error)