plugin

package

Go to main page

Versions in this module

v2

v2.2.0

Mar 30, 2022

Changes in this version

type HydrateConfig

+ func (c *HydrateConfig) DefaultTo(defaultConfig *HydrateConfig)

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

type KeyColumn

+ CacheMatch string

type Plugin

+ DefaultShouldIgnoreError ErrorPredicate

type RetryConfig

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

type Table

+ DefaultRetryConfig *RetryConfig

+ DefaultShouldIgnoreError ErrorPredicate

v2.1.1

Mar 10, 2022

v2.1.0

Mar 4, 2022

Changes in this version

type KeyColumnQualMap

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

type KeyColumnSlice

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

v2.0.3

Feb 14, 2022

v2.0.2

Feb 14, 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 GetMatrixItem(ctx context.Context) map[string]interface

+ func IsCancelled(ctx context.Context) bool

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

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

+ func Serve(opts *ServeOpts)

+ type Column struct

+ Default interface{}

+ Description string

+ Hydrate HydrateFunc

+ Name string

+ Transform *transform.ColumnTransforms

+ Type proto.ColumnType

+ type ConcurrencyManager struct

+ func (c *ConcurrencyManager) Close()

+ func (c *ConcurrencyManager) DisplayConcurrencyStats()

+ func (c *ConcurrencyManager) Finished(name string)

+ func (c *ConcurrencyManager) StartIfAllowed(name string, maxCallConcurrency int) (res bool)

+ type Connection struct

+ Config interface{}

+ Name string

+ type ConnectionConfigInstanceFunc func() interface

+ type ConnectionConfigSchema struct

+ NewInstance ConnectionConfigInstanceFunc

+ Schema map[string]*schema.Attribute

+ func NewConnectionConfigSchema() *ConnectionConfigSchema

+ func (c *ConnectionConfigSchema) Parse(configString string) (config interface{}, err error)

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

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

+ type DefaultConcurrencyConfig struct

+ DefaultMaxConcurrency int

+ TotalMaxConcurrency int

+ type ErrorPredicate func(error) bool

+ type GetConfig struct

+ Hydrate HydrateFunc

+ KeyColumns KeyColumnSlice

+ RetryConfig *RetryConfig

+ ShouldIgnoreError ErrorPredicate

+ type HydrateCall struct

+ Config *HydrateConfig

+ Depends []string

+ Func HydrateFunc

+ Name string

+ func (h *HydrateCall) Start(ctx context.Context, r *RowData, d *QueryData, ...)

+ func (h HydrateCall) CanStart(rowData *RowData, name string, concurrencyManager *ConcurrencyManager) bool

+ type HydrateConfig struct

+ Depends []HydrateFunc

+ Func HydrateFunc

+ MaxConcurrency int

+ RetryConfig *RetryConfig

+ ShouldIgnoreError ErrorPredicate

+ 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, shouldIgnoreError ErrorPredicate) HydrateFunc

+ type KeyColumn struct

+ 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) GetUnsatisfiedKeyColumns(columns KeyColumnSlice) KeyColumnSlice

+ func (m KeyColumnQualMap) String() string

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

+ 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) AllEquals() bool

+ func (k KeyColumnSlice) IsAnyOf() bool

+ func (k KeyColumnSlice) SingleEqualsQual() *KeyColumn

+ 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

+ KeyColumns KeyColumnSlice

+ ParentHydrate HydrateFunc

+ RetryConfig *RetryConfig

+ ShouldIgnoreError ErrorPredicate

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

+ type NewPluginOptions struct

+ ConnectionConfig string

+ ConnectionName string

+ type Plugin struct

+ Connection *Connection

+ ConnectionConfigChangedFunc func() error

+ ConnectionConfigSchema *ConnectionConfigSchema

+ ConnectionManager *connection_manager.Manager

+ DefaultConcurrency *DefaultConcurrencyConfig

+ DefaultGetConfig *GetConfig

+ DefaultRetryConfig *RetryConfig

+ DefaultTransform *transform.ColumnTransforms

+ Logger hclog.Logger

+ Name string

+ RequiredColumns []*Column

+ Schema map[string]*proto.TableSchema

+ SchemaMode string

+ TableMap map[string]*Table

+ TableMapFunc func(ctx context.Context, p *Plugin) (map[string]*Table, error)

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

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

+ func (p *Plugin) Initialise()

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

+ func (p *Plugin) Validate() string

+ type PluginFunc func(context.Context) *Plugin

+ type QueryColumn struct

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

+ type QueryContext struct

+ Columns []string

+ Limit *int64

+ UnsafeQuals map[string]*proto.Quals

+ func NewQueryContext(p *proto.QueryContext) *QueryContext

+ type QueryData struct

+ Connection *Connection

+ ConnectionManager *connection_manager.Manager

+ FetchType fetchType

+ KeyColumnQuals KeyColumnEqualsQualMap

+ Matrix []map[string]interface{}

+ Quals KeyColumnQualMap

+ QueryContext *QueryContext

+ QueryStatus *QueryStatus

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

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

+ Table *Table

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

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

+ type QueryStatus struct

+ func (s *QueryStatus) RowsRemaining(ctx context.Context) int

+ type RetryConfig struct

+ ShouldRetryError ErrorPredicate

+ type RowData struct

+ Item interface{}

+ ParentItem interface{}

+ func (r *RowData) GetColumnData(column *QueryColumn) (interface{}, error)

+ type ServeOpts struct

+ PluginFunc PluginFunc

+ PluginName string

+ type Table struct

+ Columns []*Column

+ DefaultTransform *transform.ColumnTransforms

+ Description string

+ Get *GetConfig

+ GetMatrixItem MatrixItemFunc

+ HydrateConfig []HydrateConfig

+ HydrateDependencies []HydrateDependencies

+ List *ListConfig

+ Name string

+ Plugin *Plugin

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

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

Other modules containing this package

github.com/turbot/steampipe-plugin-sdk

github.com/turbot/steampipe-plugin-sdk/v3

github.com/turbot/steampipe-plugin-sdk/v4

github.com/turbot/steampipe-plugin-sdk/v5

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL