Package org.partiql.lang.planner

Types

Identifies the action to take. TODO This should be represented in the IR grammar - https://github.com/partiql/partiql-lang-kotlin/issues/756

EvaluatorOptions

data class EvaluatorOptions

Specifies options that effect the behavior of the PartiQL physical plan evaluator.

GlobalResolutionResult

sealed class GlobalResolutionResult

Indicates the result of an attempt to resolve a global variable to its supplied unique identifier supplied by the application embedding PartiQL.

GlobalVariableResolver

fun interface GlobalVariableResolver

Resolves global variables (usually tables) of the current database.

PartiQLPhysicalPass

fun interface PartiQLPhysicalPass : PartiQLPlannerPass<PartiqlPhysical.Plan>

PartiQLPlanner

interface PartiQLPlanner

PartiQLPlanner is responsible for transforming a PartiqlAst.Statement representation of a query into an equivalent PartiqlPhysical.Plan representation of the query.

PartiQLPlannerBuilder

class PartiQLPlannerBuilder

Builder class to instantiate a PartiQLPlanner.

PartiQLPlannerPass

fun interface PartiQLPlannerPass<T : DomainNode>

PartiQLPlannerPass is a transformation of the plan representation of a PartiQL query.

PlannerEvent

data class PlannerEvent(eventName: String, input: Any, output: Any, duration: Duration)

Information about a planner event.

PlannerEventCallback

typealias PlannerEventCallback = (PlannerEvent) -> Unit

Called by PartiQLPlanner after a phase of query planning has completed.

PlanningProblemDetails

sealed class PlanningProblemDetails : ProblemDetails

Contains detailed information about errors that may occur during query planning.

QueryPlan

fun interface QueryPlan

A query plan that has been compiled and is ready to be evaluated.

QueryResult

sealed class QueryResult

StaticTypeResolver

fun interface StaticTypeResolver

Identifies a global variable's type, given its uniqueId.

Functions

handleUnimplementedFeature

fun ProblemHandler.handleUnimplementedFeature(blame: DomainNode, featureName: String)

Convenience function that logs PlanningProblemDetails.UnimplementedFeature to the receiver ProblemHandler handler, putting blame on the specified DomainNode (this is the superclass of all PIG-generated types). "Blame" in this case, means that the line & column number in the metas of blame become the problem's.