environment

Documentation

Index

• Variables
• type Environment
  • func New(d types.Document, params ...Param) *Environment
  • func (e *Environment) Get(path document.Path) (v types.Value, ok bool)
  • func (e *Environment) GetCatalog() *database.Catalog
  • func (e *Environment) GetDB() *database.Database
  • func (e *Environment) GetDocument() (types.Document, bool)
  • func (e *Environment) GetOuter() *Environment
  • func (e *Environment) GetParamByIndex(pos int) (types.Value, error)
  • func (e *Environment) GetParamByName(name string) (v types.Value, err error)
  • func (e *Environment) GetTx() *database.Transaction
  • func (e *Environment) Set(path document.Path, v types.Value)
  • func (e *Environment) SetDocument(d types.Document)
  • func (e *Environment) SetOuter(env *Environment)
  • func (e *Environment) SetParams(params []Param)
• type Param

Variables

var (
	TableKey = document.Path{document.PathFragment{FieldName: "$table"}}
	DocPKKey = document.Path{document.PathFragment{FieldName: "$pk"}}
)

Types

type Environment

type Environment struct {
	Params  []Param
	Vars    *document.FieldBuffer
	Doc     types.Document
	DB      *database.Database
	Catalog *database.Catalog
	Tx      *database.Transaction

	Outer *Environment
}

Environment contains information about the context in which the expression is evaluated.

func New

func New(d types.Document, params ...Param) *Environment

func (*Environment) Get

func (e *Environment) Get(path document.Path) (v types.Value, ok bool)

func (*Environment) GetCatalog

func (e *Environment) GetCatalog() *database.Catalog

func (*Environment) GetDB

func (e *Environment) GetDB() *database.Database

func (*Environment) GetDocument

func (e *Environment) GetDocument() (types.Document, bool)

func (*Environment) GetOuter

func (e *Environment) GetOuter() *Environment

func (*Environment) GetParamByIndex

func (e *Environment) GetParamByIndex(pos int) (types.Value, error)

func (*Environment) GetParamByName

func (e *Environment) GetParamByName(name string) (v types.Value, err error)

func (*Environment) GetTx

func (e *Environment) GetTx() *database.Transaction

func (*Environment) Set

func (e *Environment) Set(path document.Path, v types.Value)

func (*Environment) SetDocument

func (e *Environment) SetDocument(d types.Document)

func (*Environment) SetOuter

func (e *Environment) SetOuter(env *Environment)

func (*Environment) SetParams

func (e *Environment) SetParams(params []Param)

type Param

type Param struct {
	// Name of the param
	Name string

	// Value is the parameter value.
	Value interface{}
}

A Param represents a parameter passed by the user to the statement.