Versions in this module Expand all Collapse all v0 v0.3.0 Aug 21, 2026 Changes in this version + const FunctionBoolean + const FunctionDate + const FunctionDecimal + const FunctionInteger + const FunctionNumber + const FunctionString + const FunctionTimestamp + func EvaluatePredicate(predicate Predicate, row map[string]any) (bool, error) + func PredicateText(predicate Predicate) string + type ActionContract struct + AllowedForShape string + AllowedIf *ActionPredicate + AllowedIfShape string + AllowedIfText string + CorrelationFrom string + Creates string + DeniedReason string + Dependencies []string + Description string + Emits []string + File string + Inputs []ActionInput + Invokes []string + Label string + Line int + Name string + Reads []string + RequiresReview *ActionPredicate + RequiresReviewShape string + RequiresReviewText string + Schedules []string + Target string + Writes []string + type ActionEffect = engine.ActionEffect + type ActionInput struct + DefaultValue any + Doc string + Format string + HasDefault bool + IsNullable bool + Label string + Labels []string + Maximum *float64 + Minimum *float64 + Name string + ObjectType string + Reads []string + Type string + type ActionObjectRef = engine.ActionObjectRef + type ActionPredicate struct + Children []ActionPredicate + Column string + Input string + Kind string + Op string + Value any + type ActionVocabulary struct + Connections []string + Events []string type Catalog + Actions []ActionContract + type CompiledFunction struct + func (compiled *CompiledFunction) Contract() FunctionContract + func (compiled *CompiledFunction) Execute(ctx context.Context, options FunctionExecution) (*FunctionRun, *FunctionError) + type FunctionColumnLabel = functionruntime.ColumnLabel + type FunctionColumnType = functionruntime.ColumnType + type FunctionContract struct + Cardinality string + DataFlows []FunctionDataFlow + DefinitionFingerprint string + Doc string + Entrypoint string + MaxRows int + OutputSchema FunctionSchema + PlanFingerprint string + Reads []TerminalRead + ResultKind string + Targets []string + type FunctionDataFlow struct + Columns []string + From string + To string + type FunctionError = functionruntime.Error + type FunctionExecution struct + AllowedFlows map[string]bool + AllowedTargets map[string]bool + MaxRows int + NewID func(prefix string) string + Now func() time.Time + OnStep func(FunctionTerminalCall, FunctionStepRun, *FunctionTable, error) + Terminal FunctionTerminalExecutor + type FunctionIncompleteReason = functionruntime.IncompleteReason + type FunctionOrder = functionruntime.Order + type FunctionProvenance = functionruntime.StepProvenance + type FunctionResultColumn = functionruntime.ResultColumn + type FunctionRun = functionruntime.Run + type FunctionSchema = functionruntime.Schema + type FunctionStepRun = functionruntime.StepRun + type FunctionTable = functionruntime.Table + type FunctionTerminalCall struct + Entrypoint string + MaxRows int + Node string + Params map[string]any + Reads []TerminalRead + Schema FunctionSchema + Security string + Target string + type FunctionTerminalExecutor func(context.Context, FunctionTerminalCall) (*FunctionTerminalResult, error) + type FunctionTerminalResult struct + Evidence map[string]any + Table *FunctionTable type LoadOptions + ActionVocabulary *ActionVocabulary type Model + func (m *Model) ActionAllowed(name string, ref ActionObjectRef, target, input map[string]any) (bool, error) + func (m *Model) ActionAllowedFor(name string, principal Principal) (bool, error) + func (m *Model) ActionContract(name string) (*ActionContract, bool) + func (m *Model) ActionContracts() []ActionContract + func (m *Model) ActionRequiresReview(name string, ref ActionObjectRef, target, input map[string]any) (bool, error) + func (m *Model) CompileFunction(ctx context.Context, call Call) (*CompiledFunction, *Diagnostic) + func (m *Model) MaxRows() int + func (m *Model) RenderAction(name string, ref ActionObjectRef, target, input map[string]any) ([]ActionEffect, error) type ObjectAggregatePlan + SourceAccesses []SourceAccess type ObjectQueryPlan + SourceAccesses []SourceAccess type Plan + SourceAccesses []SourceAccess + type Predicate = functionruntime.Predicate + type PredicateOperand = functionruntime.Operand + type SourceAccess = engine.SourceAccess + type TerminalRead = functionruntime.TerminalRead v0.2.0 Aug 20, 2026 Changes in this version + const APIVersion + const CatalogVersion + const LangVersion + const ObjectAnd + const ObjectNot + const ObjectOr + const ObjectPredicate + const PlanVersion + const StdVersion + func FindAndLoad(start string) (*Model, *Diagnostic) + func Load(root string) (*Model, *Diagnostic) + func LoadModel(ctx context.Context, modelFS fs.FS, manifestPath string, options LoadOptions) (*Model, Diagnostics) + func LoadWithOptions(root string, options LoadOptions) (*Model, *Diagnostic) + type Bind struct + Ordinal int + Type string + Value any + type Call struct + Dialect string + Entrypoint string + Now time.Time + Params map[string]any + Principal Principal + RelationBindings map[string]string + type CanonicalCell struct + Kind CanonicalKind + Value any + type CanonicalKind string + const CanonicalBoolean + const CanonicalDate + const CanonicalDecimal + const CanonicalInteger + const CanonicalJSON + const CanonicalNull + const CanonicalNumber + const CanonicalString + const CanonicalTimestamp + type CanonicalRow []CanonicalCell + type Catalog struct + AllowedFlows []string + CapabilityEdges []CatalogEdge + Connectors []CatalogConnector + DefinitionFingerprint string + Entrypoints []CatalogEntrypoint + Namespaces []CatalogNamespace + Object string + ObjectGraph *Graph + Objects []ObjectType + Project CatalogProject + Relations []CatalogRelation + Targets []CatalogTarget + Version string + type CatalogConnector struct + Dialect string + Driver string + Kind string + Name string + type CatalogEdge struct + From string + FromKind string + Kind string + Step string + Target string + To string + ToKind string + type CatalogEntrypoint struct + Contract map[string]any + ContractFingerprint string + Doc string + File string + Kind string + type CatalogNamespace struct + Doc string + Entrypoints []string + Guarded bool + Name string + Pinned bool + type CatalogProject struct + Dialect string + Language string + Name string + Std string + type CatalogRelation struct + Backing string + File string + Guarded bool + Key []string + Line int + type CatalogTarget struct + Connector string + Driver string + Kind string + Name string + type CompileOptions struct + RelationBindings map[string]string + SourceDecorator SourceDecorator + type ComposedEdge struct + Cardinality string + File string + From string + GuardChain []string + Hops []ViaHop + Line int + Name string + Optional bool + To string + Unresolved string + type DatasetColumn = engine.DatasetColumn + type DatasetListRequest struct + Columns []DatasetColumn + Dataset string + Dialect string + Filter *ObjectFilter + IncludeTotal bool + Key []string + Limit int + Offset int + Relation string + RelationBindings map[string]string + Select []string + Sort []ObjectSort + type DatasetQueryPlan struct + Columns []ObjectColumn + Count *SQLPlan + Dataset string + Dependencies []string + Fingerprint string + Limit int + ModelHash string + Offset int + Rows SQLPlan + Version string + type DecodedObjectRow struct + Ref ObjectRef + Values map[string]any + type DecodedResult struct + HasMore bool + ObjectType string + Rows []DecodedObjectRow + type DerivedRelationPlan struct + Dependencies []string + Fingerprint string + ModelHash string + Query SQLPlan + Relation string + Version string + type DerivedRelationRequest struct + AvailableRelations []string + Dialect string + File string + Query string + Relation string + RelationBindings map[string]string + type Diagnostic = engine.Diagnostic + type Diagnostics []*Diagnostic + type Dimension struct + Doc string + Key string + Label string + Type string + type Filterable struct + Doc string + Key string + Operators []string + Type string + Values []string + type Graph struct + ComposedEdges []ComposedEdge + Edges []GraphEdge + MaxDepth int + Objects []GraphObject + Pairs []GraphPair + Truncated bool + UnboundEdges []UnboundEdge + Unresolved []UnresolvedBinding + type GraphEdge struct + Backing string + BindFile string + BindLine int + Cardinality string + DeclFile string + DeclLine int + Edge string + From string + Guarded bool + Optional bool + Source string + To string + type GraphObject struct + Backing string + File string + Guarded bool + Line int + Name string + type GraphPair struct + Ambiguous bool + From string + Paths []GraphPath + To string + type GraphPath struct + Cardinality string + GuardChain []string + Hops []GraphEdge + Named []string + Optional bool + type Guard struct + Predicate string + Relation string + type HostModule struct + ABIVersion string + Exports starlark.StringDict + Namespace string + type LoadOptions struct + HostModules []HostModule + type Metric struct + Additivity string + AdditivityNote string + Doc string + ExactGrain []string + Key string + ResultType string + type Model struct + func (m *Model) Catalog() *Catalog + func (m *Model) CatalogHash() string + func (m *Model) Compile(ctx context.Context, call Call) (*Plan, *Diagnostic) + func (m *Model) CompileDatasetList(ctx context.Context, request DatasetListRequest) (*DatasetQueryPlan, *Diagnostic) + func (m *Model) CompileDerivedRelation(ctx context.Context, request DerivedRelationRequest) (*DerivedRelationPlan, *Diagnostic) + func (m *Model) CompileObjectAggregate(ctx context.Context, request ObjectAggregateRequest) (*ObjectAggregatePlan, *Diagnostic) + func (m *Model) CompileObjectGet(ctx context.Context, request ObjectGetRequest) (*ObjectQueryPlan, *Diagnostic) + func (m *Model) CompileObjectKeyProbe(ctx context.Context, request ObjectKeyProbeRequest) (*ObjectKeyProbePlan, *Diagnostic) + func (m *Model) CompileObjectList(ctx context.Context, request ObjectListRequest) (*ObjectQueryPlan, *Diagnostic) + func (m *Model) CompileObjectTraversal(ctx context.Context, request ObjectTraversalRequest) (*ObjectQueryPlan, *Diagnostic) + func (m *Model) DeploymentHash() string + func (m *Model) EvaluateOperationalModules(ctx context.Context, paths []string) *Diagnostic + func (m *Model) Graph() *Graph + func (m *Model) Hash() string + func (m *Model) Inspect(entrypoint string) (map[string]any, *Diagnostic) + func (m *Model) Object(name string) (*ObjectType, bool) + func (m *Model) Objects() []ObjectType + func (m *Model) Root() string + func (m *Model) SourceHash() string + type ObjectAggregateMeasure struct + Name string + Op string + Property string + type ObjectAggregatePlan struct + Columns []ObjectColumn + Dependencies []string + DependencyCoverage string + Fingerprint string + ModelHash string + ObjectType string + Rows SQLPlan + Version string + func (p *ObjectAggregatePlan) Decode(rows []CanonicalRow) ([]map[string]any, *Diagnostic) + type ObjectAggregateRequest struct + Dialect string + Filter *ObjectFilter + GroupBy []string + Limit int + Measures []ObjectAggregateMeasure + Now time.Time + ObjectType string + Options CompileOptions + Principal Principal + type ObjectColumn = engine.ObjectColumn + type ObjectDisplay struct + Primary string + Secondary string + type ObjectExprOp = engine.ObjectExprOp + type ObjectFilter = engine.ObjectFilter + type ObjectGetRequest struct + Dialect string + Key string + Now time.Time + ObjectType string + Options CompileOptions + Principal Principal + Select []string + type ObjectKeyProbePlan struct + Dependencies []string + DependencyCoverage string + Fingerprint string + Key []string + ModelHash string + ObjectType string + Rows SQLPlan + Version string + type ObjectKeyProbeRequest struct + Dialect string + Now time.Time + ObjectType string + Options CompileOptions + Principal Principal + type ObjectLink struct + Cardinality string + From string + Hops []ViaHop + IsComposed bool + IsGuarded bool + IsOptional bool + Name string + To string + type ObjectListRequest struct + Dialect string + Filter *ObjectFilter + IncludeTotal bool + Limit int + Now time.Time + ObjectType string + Offset int + Options CompileOptions + Principal Principal + Select []string + Sort []ObjectSort + type ObjectQueryPlan struct + Cardinality ResultCardinality + Columns []ObjectColumn + Count *SQLPlan + Dependencies []string + DependencyCoverage string + Fingerprint string + Limit int + ModelHash string + ObjectType string + Offset int + Rows SQLPlan + SchemaHash string + Version string + func (p *ObjectQueryPlan) Decode(rows []CanonicalRow) (DecodedResult, *Diagnostic) + type ObjectRef struct + Key string + ObjectType string + type ObjectSort = engine.ObjectSort + type ObjectTraversalRequest struct + Dialect string + Edge string + Filter *ObjectFilter + IncludeTotal bool + Limit int + Now time.Time + Offset int + Options CompileOptions + Principal Principal + Select []string + Sort []ObjectSort + SourceKey string + SourceType string + type ObjectType struct + Backing string + Dependencies []string + DependencyCoverage string + Description string + Dimensions []Dimension + Display ObjectDisplay + File string + Filterables []Filterable + Group string + IsDerived bool + Key []string + Label string + Line int + Links []ObjectLink + Metrics []Metric + Name string + Properties []Property + SchemaHash string + func (o ObjectType) Property(name string) (Property, bool) + type ObjectTypeValue = engine.ObjectTypeValue + type Plan struct + Entrypoint string + Fingerprint string + Function json.RawMessage + Guards []Guard + Kind PlanKind + ModelHash string + Relations []string + ResultSchema json.RawMessage + Retrieval json.RawMessage + SQL *SQLPlan + Version string + Warnings []Warning + func (p *Plan) Decode(rows []CanonicalRow) ([]map[string]any, *Diagnostic) + func (p *Plan) ResultColumns() ([]ObjectColumn, *Diagnostic) + type PlanKind string + const PlanFunction + const PlanRetrieval + const PlanSQL + type Principal struct + Attrs map[string]any + Roles []string + Subject string + type Property struct + Doc string + Format string + IsComputed bool + IsKey bool + IsNullable bool + IsWritable bool + Label string + Labels []string + MaskRole string + Name string + Type string + func (p Property) Decode(cell CanonicalCell) (any, *Diagnostic) + type ResultCardinality string + const CardinalityAtMostOneObject + const CardinalityPage + type SQLPlan struct + Args []any + Binds []Bind + Dialect string + Text string + type SourceDecorationRequest struct + Alias string + Authorized SourcePlan + Object ObjectType + type SourceDecorator interface + DecorateObjectSource func(SourceDecorationRequest) (SourceWrapper, *Diagnostic) + type SourcePlan struct + type SourceWrapper struct + After string + Before string + Binds []Bind + Relations []string + type UnboundEdge struct + Cardinality string + Edge string + File string + From string + Line int + Optional bool + type UnresolvedBinding struct + Base string + Edge string + File string + Line int + Object string + Reason string + type ViaHop struct + Alias string + Edge string + type Warning struct + Code string + Message string
Go to main page