metaquery

Documentation

Index

• func Complete(input *CompleterInput) []prompt.Suggest
• func Handle(ctx context.Context, input *HandlerInput) error
• func IsMetaQuery(query string) bool
• func PromptSuggestions() []prompt.Suggest
• type CompleterInput
• type ConnectionStateGetter
• type HandlerInput
• type ValidationResult
  • func Validate(query string) ValidationResult

Functions

func Complete

func Complete(input *CompleterInput) []prompt.Suggest

Complete returns completions for metaqueries.

func Handle

func Handle(ctx context.Context, input *HandlerInput) error

Handle handles a metaquery execution from the interactive client

func IsMetaQuery

func IsMetaQuery(query string) bool

IsMetaQuery returns whether the query is a metaquery

func PromptSuggestions

func PromptSuggestions() []prompt.Suggest

PromptSuggestions returns a list of the metaquery suggestions for go-prompt

Types

type CompleterInput

type CompleterInput struct {
	Query            string
	TableSuggestions []prompt.Suggest
}

CompleterInput is a struct defining input data for the metaquery completer

type ConnectionStateGetter

type ConnectionStateGetter func(context.Context) (steampipeconfig.ConnectionStateMap, error)

type HandlerInput

type HandlerInput struct {
	Client db_common.Client
	Schema *db_common.SchemaMetadata

	Prompt                *prompt.Prompt
	ClosePrompt           func()
	Query                 string
	GetConnectionStateMap ConnectionStateGetter
	SearchPath            []string
}

HandlerInput defines input data for the metaquery handler

type ValidationResult

type ValidationResult struct {
	Err       error
	Message   string
	ShouldRun bool
}

ValidationResult :: response for Validate

func Validate

func Validate(query string) ValidationResult

Validate :: validate a full metaquery along with arguments - we can return err & validationResult