elastic

Documentation

Index

• type Option
  • func WithFieldValidator(fieldValidator func(name string) error) Option
• type QueryGenerator
  • func NewQueryGenerator(options ...Option) *QueryGenerator
  • func (q *QueryGenerator) ConvertAST(root kqlfilter.Node) (types.Query, error)

Types

type Option

type Option func(*QueryGenerator)

Option is a function that configures a query generator.

func WithFieldValidator

func WithFieldValidator(fieldValidator func(name string) error) Option

WithFieldValidator allows checking incoming field names. This can be used to prevent users from querying fields that they are not allowed to query. Example usage:

WithFieldValidator(func(name string) error {
	if !allowedFields[name] {
		return fmt.Errorf("field %s is not allowed", name)
	}
	return nil
})

type QueryGenerator

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

func NewQueryGenerator

func NewQueryGenerator(options ...Option) *QueryGenerator

func (*QueryGenerator) ConvertAST

func (q *QueryGenerator) ConvertAST(root kqlfilter.Node) (types.Query, error)

ConvertAST converts a KQL AST to an Elasticsearch query.