planner

Documentation

Overview

Package planner contains a query planner for Rego queries.

Index

• type Planner
  • func New() *Planner
  • func (p *Planner) Plan() (*ir.Policy, error)
  • func (p *Planner) WithBuiltinDecls(decls map[string]*ast.Builtin) *Planner
  • func (p *Planner) WithDebug(sink io.Writer) *Planner
  • func (p *Planner) WithModules(modules []*ast.Module) *Planner
  • func (p *Planner) WithQueries(queries []QuerySet) *Planner
• type QuerySet

Types

type Planner

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

Planner implements a query planner for Rego queries.

func New

func New() *Planner

New returns a new Planner object.

func (*Planner) Plan

func (p *Planner) Plan() (*ir.Policy, error)

Plan returns a IR plan for the policy query.

func (*Planner) WithBuiltinDecls

func (p *Planner) WithBuiltinDecls(decls map[string]*ast.Builtin) *Planner

WithBuiltinDecls tells the planner what built-in function may be available inside the execution environment.

func (*Planner) WithDebug

func (p *Planner) WithDebug(sink io.Writer) *Planner

WithDebug sets where debug messages are written to.

func (*Planner) WithModules

func (p *Planner) WithModules(modules []*ast.Module) *Planner

WithModules sets the module set that contains query dependencies.

func (*Planner) WithQueries

func (p *Planner) WithQueries(queries []QuerySet) *Planner

WithQueries sets the query sets to generate a plan for. The rewritten collection provides a mapping of rewritten query vars for each query set. The planner uses rewritten variables but the result set key will be the original variable name.

type QuerySet

type QuerySet struct {
	Name          string
	Queries       []ast.Body
	RewrittenVars map[ast.Var]ast.Var
}

QuerySet represents the input to the planner.