pkg

Documentation

Index

• Constants
• func NewESClientFromParsedLayers(parsedLayers *layers.ParsedLayers) (*elasticsearch.Client, error)
• func NewESHelpersParameterLayer(options ...layers.ParameterLayerOptions) (*layers.ParameterLayerImpl, error)
• type ESClientFactory
• type ESHelperSettings
• type ElasticSearchCommand
  • func NewElasticSearchCommand(description *cmds.CommandDescription, clientFactory ESClientFactory, ...) (*ElasticSearchCommand, error)
  • func (esc *ElasticSearchCommand) RenderQuery(parameters map[string]interface{}) (string, error)
  • func (esc *ElasticSearchCommand) RenderQueryToJSON(parameters map[string]interface{}) (string, error)
  • func (esc *ElasticSearchCommand) RunIntoGlazeProcessor(ctx context.Context, parsedLayers *layers.ParsedLayers, ...) error
  • func (esc *ElasticSearchCommand) RunQueryIntoGlaze(ctx context.Context, es *elasticsearch.Client, ...) error
• type ElasticSearchCommandLoader
  • func NewElasticSearchCommandLoader(clientFactory ESClientFactory) *ElasticSearchCommandLoader
  • func (escl *ElasticSearchCommandLoader) IsFileSupported(f fs.FS, fileName string) bool
  • func (escl *ElasticSearchCommandLoader) LoadCommands(f fs.FS, entryName string, options []cmds.CommandDescriptionOption, ...) ([]cmds.Command, error)
• type EsClientSettings
  • func NewESClientSettingsFromParsedLayers(parsedLayers *layers.ParsedLayers) (*EsClientSettings, error)
• type EsParameterLayer
  • func NewESParameterLayer(options ...layers.ParameterLayerOptions) (*EsParameterLayer, error)
• type EscuseMeCommandDescription

Constants

const ESHelpersSlug = "es-helpers"

const EsConnectionSlug = "es-connection"

Functions

func NewESClientFromParsedLayers

func NewESClientFromParsedLayers(
	parsedLayers *layers.ParsedLayers,
) (*elasticsearch.Client, error)

func NewESHelpersParameterLayer

func NewESHelpersParameterLayer(
	options ...layers.ParameterLayerOptions,
) (*layers.ParameterLayerImpl, error)

Types

type ESClientFactory

type ESClientFactory func(*layers.ParsedLayers) (*elasticsearch.Client, error)

type ESHelperSettings

type ESHelperSettings struct {
	PrintQuery bool   `glazed.parameter:"print-query"`
	Explain    bool   `glazed.parameter:"explain"`
	Index      string `glazed.parameter:"index"`
}

type ElasticSearchCommand

type ElasticSearchCommand struct {
	*cmds.CommandDescription
	Query string
	// contains filtered or unexported fields
}

func NewElasticSearchCommand

func NewElasticSearchCommand(
	description *cmds.CommandDescription,
	clientFactory ESClientFactory,
	query string,
) (*ElasticSearchCommand, error)

func (*ElasticSearchCommand) RenderQuery

func (esc *ElasticSearchCommand) RenderQuery(parameters map[string]interface{}) (string, error)

func (*ElasticSearchCommand) RenderQueryToJSON

func (esc *ElasticSearchCommand) RenderQueryToJSON(parameters map[string]interface{}) (string, error)

func (*ElasticSearchCommand) RunIntoGlazeProcessor

func (esc *ElasticSearchCommand) RunIntoGlazeProcessor(
	ctx context.Context,
	parsedLayers *layers.ParsedLayers,
	gp middlewares.Processor,
) error

func (*ElasticSearchCommand) RunQueryIntoGlaze

func (esc *ElasticSearchCommand) RunQueryIntoGlaze(
	ctx context.Context,
	es *elasticsearch.Client,
	parsedLayers *layers.ParsedLayers,
	gp middlewares.Processor,
) error

type ElasticSearchCommandLoader

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

ElasticSearchCommandLoader walks through a directory and finds all directories that end with .escuse-me and loads the commands from there. The layout of an .escuse-me directory is as follows: - main.yaml (mandatory) contains the command description

• contains flags, arguments, name, short
• reference the query template file

- the alias folder, which contains alias definitions in single yaml files - the data folder, which contains additional data in json / csv / yaml format

• this data is passed to the template at evaluation file, and can be used to store things like tags and constant strings, boost values and the like

func NewElasticSearchCommandLoader

func NewElasticSearchCommandLoader(
	clientFactory ESClientFactory,
) *ElasticSearchCommandLoader

func (*ElasticSearchCommandLoader) IsFileSupported

func (escl *ElasticSearchCommandLoader) IsFileSupported(f fs.FS, fileName string) bool

func (*ElasticSearchCommandLoader) LoadCommands

func (escl *ElasticSearchCommandLoader) LoadCommands(
	f fs.FS,
	entryName string,
	options []cmds.CommandDescriptionOption,
	aliasOptions []alias.Option,
) ([]cmds.Command, error)

type EsClientSettings

type EsClientSettings struct {
	Addresses               []string `glazed.parameter:"addresses"`
	Username                string   `glazed.parameter:"username"`
	Password                string   `glazed.parameter:"password"`
	CloudId                 string   `glazed.parameter:"cloud-id"`
	ApiKey                  string   `glazed.parameter:"api-key"`
	ServiceToken            string   `glazed.parameter:"service-token"`
	CertificateFingerprint  string   `glazed.parameter:"certificate-fingerprint"`
	RetryOnStatus           []int    `glazed.parameter:"retry-on-status"`
	DisableRetry            bool     `glazed.parameter:"disable-retry"`
	MaxRetries              int      `glazed.parameter:"max-retries"`
	EnableMetrics           bool     `glazed.parameter:"enable-metrics"`
	EnableDebugLogger       bool     `glazed.parameter:"enable-debug-logger"`
	EnableCompatibilityMode bool     `glazed.parameter:"enable-compatibility-mode"`
}

func NewESClientSettingsFromParsedLayers

func NewESClientSettingsFromParsedLayers(parsedLayers *layers.ParsedLayers) (*EsClientSettings, error)

type EsParameterLayer

type EsParameterLayer struct {
	*layers.ParameterLayerImpl `yaml:",inline"`
}

func NewESParameterLayer

func NewESParameterLayer(options ...layers.ParameterLayerOptions) (*EsParameterLayer, error)

type EscuseMeCommandDescription

type EscuseMeCommandDescription struct {
	Name      string                            `yaml:"name"`
	Short     string                            `yaml:"short"`
	Long      string                            `yaml:"long,omitempty"`
	Layout    []*layout.Section                 `yaml:"layout,omitempty"`
	Flags     []*parameters.ParameterDefinition `yaml:"flags,omitempty"`
	Arguments []*parameters.ParameterDefinition `yaml:"arguments,omitempty"`

	QueryTemplate string `yaml:"queryTemplate,omitempty"`
}