dependencies

Documentation

Overview

Package dependencies provides functions for determining the set of ast.Refs that AST elements depend on.

Deprecated: This package is intended for older projects transitioning from OPA v0.x and will remain for the lifetime of OPA v1.x, but its use is not recommended. For newer features and behaviours, such as defaulting to the Rego v1 syntax, use the corresponding components in the github.com/open-policy-agent/opa/v1 package instead. See https://www.openpolicyagent.org/docs/latest/v0-compatibility/ for more information.

Index

• func All(x interface{}) (resolved []ast.Ref, err error)
• func Base(compiler *ast.Compiler, x interface{}) ([]ast.Ref, error)
• func Minimal(x interface{}) (resolved []ast.Ref, err error)
• func Virtual(compiler *ast.Compiler, x interface{}) ([]ast.Ref, error)

Functions

func All

func All(x interface{}) (resolved []ast.Ref, err error)

All returns the list of data ast.Refs that the given AST element depends on.

func Base

func Base(compiler *ast.Compiler, x interface{}) ([]ast.Ref, error)

Base returns the list of base data documents that the given AST element depends on.

The returned refs are always constant and are truncated at any point where they become dynamic. That is, a ref like data.a.b[x] will be truncated to data.a.b.

func Minimal

func Minimal(x interface{}) (resolved []ast.Ref, err error)

Minimal returns the list of data ast.Refs that the given AST element depends on. If an AST element depends on a ast.Ref that is a prefix of another dependency, the ast.Ref that is the prefix of the other will be the only one in the returned list.

As an example, if an element depends on data.x and data.x.y, only data.x will be in the returned list.

func Virtual

func Virtual(compiler *ast.Compiler, x interface{}) ([]ast.Ref, error)

Virtual returns the list of virtual data documents that the given AST element depends on.

The returned refs are always constant and are truncated at any point where they become dynamic. That is, a ref like data.a.b[x] will be truncated to data.a.b.