athena

Documentation

Index

• Constants
• type Config
  • func GetConfig() *Config
  • func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet
• type Plugin
  • func NewPlugin(_ context.Context, cfg *Config, awsConfig *aws.Config, ...) (Plugin, error)
  • func (p Plugin) Create(ctx context.Context, tCtx webapi.TaskExecutionContextReader) (resourceMeta webapi.ResourceMeta, resource webapi.Resource, err error)
  • func (p Plugin) Delete(ctx context.Context, tCtx webapi.DeleteContext) error
  • func (p Plugin) Get(ctx context.Context, tCtx webapi.GetContext) (latest webapi.Resource, err error)
  • func (p Plugin) GetConfig() webapi.PluginConfig
  • func (p Plugin) ResourceRequirements(_ context.Context, _ webapi.TaskExecutionContextReader) (namespace core.ResourceNamespace, constraints core.ResourceConstraintsSpec, ...)
  • func (p Plugin) Status(ctx context.Context, tCtx webapi.StatusContext) (phase core.PhaseInfo, err error)
• type QueryInfo
• type ResourceWrapper

Constants

const (
	ErrRemoteSystem errors.ErrorCode = "RemoteSystem"
	ErrUser         errors.ErrorCode = "User"
	ErrSystem       errors.ErrorCode = "System"
)

Types

type Config

type Config struct {
	WebAPI              webapi.PluginConfig          `json:"webApi" pflag:",Defines config for the base WebAPI plugin."`
	ResourceConstraints core.ResourceConstraintsSpec `` /* 141-byte string literal not displayed */
	DefaultWorkGroup    string                       `json:"defaultWorkGroup" pflag:",Defines the default workgroup to use when running on Athena unless overwritten by the task."`
	DefaultCatalog      string                       `json:"defaultCatalog" pflag:",Defines the default catalog to use when running on Athena unless overwritten by the task."`
}

func GetConfig

func GetConfig() *Config

func (Config) GetPFlagSet

func (cfg Config) GetPFlagSet(prefix string) *pflag.FlagSet

GetPFlagSet will return strongly types pflags for all fields in Config and its nested types. The format of the flags is json-name.json-sub-name... etc.

type Plugin

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

func NewPlugin

func NewPlugin(_ context.Context, cfg *Config, awsConfig *aws.Config, metricScope promutils.Scope) (Plugin, error)

func (Plugin) Create

func (p Plugin) Create(ctx context.Context, tCtx webapi.TaskExecutionContextReader) (resourceMeta webapi.ResourceMeta,
	resource webapi.Resource, err error)

func (Plugin) Delete

func (p Plugin) Delete(ctx context.Context, tCtx webapi.DeleteContext) error

func (Plugin) Get

func (p Plugin) Get(ctx context.Context, tCtx webapi.GetContext) (latest webapi.Resource, err error)

func (Plugin) GetConfig

func (p Plugin) GetConfig() webapi.PluginConfig

func (Plugin) ResourceRequirements

func (p Plugin) ResourceRequirements(_ context.Context, _ webapi.TaskExecutionContextReader) (
	namespace core.ResourceNamespace, constraints core.ResourceConstraintsSpec, err error)

func (Plugin) Status

func (p Plugin) Status(ctx context.Context, tCtx webapi.StatusContext) (phase core.PhaseInfo, err error)

type QueryInfo

type QueryInfo struct {
	QueryString string
	Workgroup   string
	Catalog     string
	Database    string
}

type ResourceWrapper

type ResourceWrapper struct {
	Status               *athenaTypes.QueryExecutionStatus
	ResultsConfiguration *athenaTypes.ResultConfiguration
}