functions

Documentation

Index

• func GetBuiltinFunctions() []types.FunctionInterface
• func Materialize(ctx context.Context, scope types.Scope, stored_query types.StoredQuery) []types.Row
• type Aggregator
  • func NewAggregator() Aggregator
  • func (self Aggregator) GetContext(scope types.Scope) (res types.Any, res_pres bool)
  • func (self Aggregator) SetContext(scope types.Scope, value types.Any)
• type FormatArgs
• type FormatFunction
  • func (self FormatFunction) Call(ctx context.Context, scope types.Scope, args *ordereddict.Dict) types.Any
  • func (self FormatFunction) Info(scope types.Scope, type_map *types.TypeMap) *types.FunctionInfo
• type GenericFunction
  • func (self GenericFunction) Call(ctx context.Context, scope types.Scope, args *ordereddict.Dict) types.Any
  • func (self GenericFunction) Copy() types.FunctionInterface
  • func (self GenericFunction) Info(scope types.Scope, type_map *types.TypeMap) *types.FunctionInfo
• type GenericFunctionInterface
• type LenFunction
  • func (self LenFunction) Call(ctx context.Context, scope types.Scope, args *ordereddict.Dict) types.Any
  • func (self LenFunction) Info(scope types.Scope, type_map *types.TypeMap) *types.FunctionInfo
• type LenFunctionArgs

Functions

func GetBuiltinFunctions

func GetBuiltinFunctions() []types.FunctionInterface

func Materialize

func Materialize(ctx context.Context,
	scope types.Scope, stored_query types.StoredQuery) []types.Row

Types

type Aggregator

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

All aggregate functions need to embed the Aggregator. Aggregators store their state in the scope context so they can retrieve it next time they are evaluated.

func NewAggregator

func NewAggregator() Aggregator

Sets a new aggregator if possible

func (Aggregator) GetContext

func (self Aggregator) GetContext(scope types.Scope) (res types.Any, res_pres bool)

func (Aggregator) SetContext

func (self Aggregator) SetContext(scope types.Scope, value types.Any)

type FormatArgs

type FormatArgs struct {
	Format string    `vfilter:"required,field=format,doc=Format string to use"`
	Args   types.Any `vfilter:"optional,field=args,doc=An array of elements to apply into the format string."`
}

type FormatFunction

type FormatFunction struct{}

func (FormatFunction) Call

func (self FormatFunction) Call(ctx context.Context,
	scope types.Scope,
	args *ordereddict.Dict) types.Any

func (FormatFunction) Info

func (self FormatFunction) Info(scope types.Scope, type_map *types.TypeMap) *types.FunctionInfo

type GenericFunction

type GenericFunction struct {
	FunctionName string
	Doc          string
	Function     GenericFunctionInterface
	Metadata     *ordereddict.Dict
	ArgType      types.Any
}

scope.AppendPlugins(GenericListPlugin{
  PluginName: "my_plugin",
  Function: func(args types.Row) []types.Row {
       ....
  }
})

func (GenericFunction) Call

func (self GenericFunction) Call(
	ctx context.Context,
	scope types.Scope,
	args *ordereddict.Dict) types.Any

func (GenericFunction) Copy

func (self GenericFunction) Copy() types.FunctionInterface

func (GenericFunction) Info

func (self GenericFunction) Info(scope types.Scope, type_map *types.TypeMap) *types.FunctionInfo

type GenericFunctionInterface

type GenericFunctionInterface func(ctx context.Context, scope types.Scope, args *ordereddict.Dict) types.Any

Generic synchronous plugins just return all their rows at once.

type LenFunction

type LenFunction struct{}

func (LenFunction) Call

func (self LenFunction) Call(ctx context.Context,
	scope types.Scope,
	args *ordereddict.Dict) types.Any

func (LenFunction) Info

func (self LenFunction) Info(scope types.Scope, type_map *types.TypeMap) *types.FunctionInfo

type LenFunctionArgs

type LenFunctionArgs struct {
	List types.Any `vfilter:"required,field=list,doc=A list of items"`
}