Class: SQLLogicalPlanBuilder

Defined in: lang-sql/src/visitors/builder.ts:88

Translates a SQL AST into a logical plan tree by implementing SQLVisitor and LogicalPlanBuilder.

Implements

Constructors

Constructor

new SQLLogicalPlanBuilder(db): SQLLogicalPlanBuilder

Defined in: lang-sql/src/visitors/builder.ts:112

Parameters

Parameter	Type	Description
`db`	`DortDBAsFriend`	Reference to the database instance used to resolve functions, operators, aggregates, and casts.

Returns

SQLLogicalPlanBuilder

Properties

calcBuilders

protected calcBuilders: Record<string, PlanVisitor<CalculationParams>>

Defined in: lang-sql/src/visitors/builder.ts:96

Per-language calculation builders used to convert plan fragments into plan.Calculation nodes.

dataAdapter

protected dataAdapter: SQLDataAdapter<unknown>

Defined in: lang-sql/src/visitors/builder.ts:110

SQL data adapter used to construct row values.

db

protected db: DortDBAsFriend

Defined in: lang-sql/src/visitors/builder.ts:114

Reference to the database instance used to resolve functions, operators, aggregates, and casts.

eqCheckers

protected eqCheckers: Record<string, EqualityChecker>

Defined in: lang-sql/src/visitors/builder.ts:98

Per-language equality checkers for plan-node structural comparison.

inferrerMap

protected inferrerMap: Record<string, SchemaInferrer> = {}

Defined in: lang-sql/src/visitors/builder.ts:94

Per-language SchemaInferrer instances keyed by language name.

langCtx

protected langCtx: Record<string, unknown> & object

Defined in: lang-sql/src/visitors/builder.ts:103

Shared language context passed in via buildPlan; the sql entry holds the outer SQLLangCtx.

Type Declaration

sql

sql: SQLLangCtx

The SQL-specific language context for the current query scope.

localLangCtx

protected localLangCtx: SQLLangCtx

Defined in: lang-sql/src/visitors/builder.ts:108

copied to keep outer lang ctx clean

renamers

protected renamers: Record<string, AttributeRenamer>

Defined in: lang-sql/src/visitors/builder.ts:100

Per-language attribute renamers applied to non-local cross-boundary references.

stringifier

protected stringifier: ASTDeterministicStringifier

Defined in: lang-sql/src/visitors/builder.ts:92

Produces deterministic string keys for subexpressions used as plan identifiers.

Methods

buildLimit()

protected buildLimit(node, op): Limit

Defined in: lang-sql/src/visitors/builder.ts:437

Builds a plan.Limit operator from LIMIT/OFFSET clauses.

Parameters

Parameter	Type
`node`	`SelectStatement`
`op`	`PlanTupleOperator`

Returns

Limit

Throws

If either value is not a numeric constant.

buildPlan()

buildPlan(node, ctx, langCtx): BuildPlanResult

Defined in: lang-sql/src/visitors/builder.ts:147

Builds a logical plan from an AST node.

Parameters

Parameter	Type	Description
`node`	`ASTNode`	The root node of the AST.
`ctx`	`IdSet`	The context to use for the plan.
`langCtx`	`Record`<`string`, `unknown`>	The per-language additional context. For example, SQL may use this to pass in definitions of CTEs created in an outer language switch.

Returns

BuildPlanResult

The plan operator, as well as the inferred context (@see toInfer).

Implementation of

LogicalPlanBuilder.buildPlan

checkRecursionValidity()

protected checkRecursionValidity(node): SelectSet

Defined in: lang-sql/src/visitors/builder.ts:918

Validates that a WITH RECURSIVE query only uses supported features.

Parameters

Parameter	Type
`node`	`WithQuery`

Returns

SelectSet

The top-level AST.SelectSet for further processing.

Throws

If the query is not a UNION, or if unsupported cycle or search features are used.

cloneLangCtx()

protected cloneLangCtx(ctx): SQLLangCtx

Defined in: lang-sql/src/visitors/builder.ts:140

Returns a shallow copy of ctx with the CTE maps cloned so sub-queries can extend them independently.

Parameters

Parameter	Type
`ctx`	`SQLLangCtx`

Returns

SQLLangCtx

getAllTableNames()

protected getAllTableNames(node): ASTIdentifier[]

Defined in: lang-sql/src/visitors/builder.ts:888

Get all table names forming a join (before aliasing)

Parameters

Parameter	Type
`node`	`ASTTableAlias` \| `ASTIdentifier` \| `JoinClause`

Returns

ASTIdentifier[]

getTableName()

protected getTableName(node): [PlanTupleOperator, ASTIdentifier]

Defined in: lang-sql/src/visitors/builder.ts:638

Resolves a FROM-clause item to a tuple operator and optional relation name.

Parameters

Parameter	Type
`node`	`ASTTableAlias` \| `ASTIdentifier` \| `JoinClause`

Returns

[PlanTupleOperator, ASTIdentifier]

handleRecursion()

protected handleRecursion(node): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:943

Builds an plan.IndexedRecursion plan for a WITH RECURSIVE query after validating it via checkRecursionValidity.

Parameters

Parameter	Type
`node`	`WithQuery`

Returns

PlanTupleOperator

idToTupleSource()

protected idToTupleSource(name): [PlanTupleOperator, ASTIdentifier]

Defined in: lang-sql/src/visitors/builder.ts:604

Also handles CTEs and materialized CTEs

Parameters

Parameter	Type	Description
`name`	`ASTIdentifier`	name of the tuple source

Returns

[PlanTupleOperator, ASTIdentifier]

initLangCtx()

protected initLangCtx(): SQLLangCtx

Defined in: lang-sql/src/visitors/builder.ts:133

Creates a fresh, empty SQLLangCtx.

Returns

SQLLangCtx

isRecursive()

protected isRecursive(node): boolean

Defined in: lang-sql/src/visitors/builder.ts:860

Determines if a WITH query is recursive.

Parameters

Parameter	Type
`node`	`WithQuery`

Returns

boolean

materializeCte()

protected materializeCte(node, subq): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:1004

Wraps subq in a GroupBy that collects all rows into an array and registers the CTE name in localLangCtx.materializedCtes.

Parameters

Parameter	Type
`node`	`WithQuery`
`subq`	`PlanTupleOperator`

Returns

PlanTupleOperator

optimizeInOp()

protected optimizeInOp(expr, subq): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:1030

Rewrites an IN subquery by pushing the needle value into the subquery as a selection, enabling the executor to apply an index scan when available.

Parameters

Parameter	Type
`expr`	`ASTIdentifier` \| `PlanOpAsArg`
`subq`	`PlanOperator`

Returns

PlanOperator

opToCalc()

protected opToCalc(op): Calculation

Defined in: lang-sql/src/visitors/builder.ts:200

Converts an already-built plan operator into a plan.Calculation.

Parameters

Parameter	Type
`op`	`PlanOperator`

Returns

Calculation

processAttr()

protected processAttr(attr): Aliased<ASTIdentifier | Calculation>

Defined in: lang-sql/src/visitors/builder.ts:562

Bound to this; converts a SELECT item to an [expression, alias] pair.

Parameters

Parameter	Type
`attr`	`ASTNode`

Returns

Aliased<ASTIdentifier | Calculation>

processFnArg()

protected processFnArg(item): ASTIdentifier | PlanOpAsArg

Defined in: lang-sql/src/visitors/builder.ts:188

Bound to this; wraps non-identifier nodes as { op } for use as function arguments.

Parameters

Parameter	Type
`item`	`ASTNode`

Returns

ASTIdentifier | PlanOpAsArg

processNode()

protected processNode(item): OpOrId

Defined in: lang-sql/src/visitors/builder.ts:184

Bound to this for array map usage; passes identifiers through and visits all other nodes.

Parameters

Parameter	Type
`item`	`ASTNode`

Returns

OpOrId

processOrderItem()

protected processOrderItem(item): Order

Defined in: lang-sql/src/visitors/builder.ts:393

Bound to this; converts an ORDER BY item to a plan.Order descriptor.

Parameters

Parameter	Type
`item`	`OrderByItem`

Returns

Order

renameWithQuery()

protected renameWithQuery(node, subq): Projection

Defined in: lang-sql/src/visitors/builder.ts:817

Rename with query according to the with query name. If column names are provided, use them. Additionally, provide schemaless aliases for all columns.

Parameters

Parameter	Type
`node`	`WithQuery`
`subq`	`PlanTupleOperator`

Returns

Projection

toCalc()

protected toCalc(node): ASTIdentifier | Calculation

Defined in: lang-sql/src/visitors/builder.ts:192

Converts an AST node to a plan.Calculation or identifier; extracts the field name for aggregate calls.

Parameters

Parameter	Type
`node`	`ASTNode`

Returns

ASTIdentifier | Calculation

visitAggregate()

visitAggregate(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:736

Parameters

Parameter	Type
`node`	`ASTAggregate`

Returns

PlanOperator

Implementation of

SQLVisitor.visitAggregate

visitArray()

visitArray(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:210

Parameters

Parameter	Type
`node`	`ASTArray`

Returns

PlanOperator

Implementation of

SQLVisitor.visitArray

visitCase()

visitCase(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:705

Parameters

Parameter	Type
`node`	`ASTCase`

Returns

PlanOperator

Implementation of

SQLVisitor.visitCase

visitCast()

visitCast(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:252

Parameters

Parameter	Type
`node`	`ASTCast`

Returns

PlanOperator

Implementation of

SQLVisitor.visitCast

visitExists()

visitExists(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:283

Parameters

Parameter	Type
`node`	`ASTExists`

Returns

PlanOperator

Implementation of

SQLVisitor.visitExists

visitExpressionAlias()

visitExpressionAlias(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:388

Parameters

Parameter	Type
`node`	`ASTExpressionAlias`

Returns

PlanOperator

Implementation of

SQLVisitor.visitExpressionAlias

visitFunction()

visitFunction(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:1119

Parameters

Parameter	Type
`node`	`ASTFunction`

Returns

PlanOperator

Implementation of

LogicalPlanBuilder.visitFunction

visitGroupByClause()

visitGroupByClause(node, src?, aggregates?): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:583

should be called only by SQLLogicalPlanBuilder#visitSelectSet, which provides the src and aggregates args

Parameters

Parameter	Type	Default value
`node`	`GroupByClause`	`undefined`
`src`	`PlanTupleOperator`	`null`
`aggregates`	`AggregateCall`[]	`[]`

Returns

PlanTupleOperator

Implementation of

SQLVisitor.visitGroupByClause

visitIdentifier()

visitIdentifier(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:336

Parameters

Parameter	Type
`node`	`ASTIdentifier`

Returns

PlanOperator

Implementation of

LogicalPlanBuilder.visitIdentifier

visitJoinClause()

visitJoinClause(node): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:649

Parameters

Parameter	Type
`node`	`JoinClause`

Returns

PlanTupleOperator

Implementation of

SQLVisitor.visitJoinClause

visitLangSwitch()

visitLangSwitch(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:1143

Propagates the current CTE maps back to the shared langCtx before creating a PlanLangSwitch, making locally defined CTEs visible to the embedded language.

Parameters

Parameter	Type
`node`	`LangSwitch`

Returns

PlanOperator

Implementation of

LogicalPlanBuilder.visitLangSwitch

visitLiteral()

visitLiteral<U>(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:1022

Type Parameters

Type Parameter
`U`

Parameters

Parameter	Type
`node`	`ASTLiteral`<`U`>

Returns

PlanOperator

Implementation of

LogicalPlanBuilder.visitLiteral

visitNumberLiteral()

visitNumberLiteral(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:207

Parameters

Parameter	Type
`node`	`ASTNumberLiteral`

Returns

PlanOperator

Implementation of

SQLVisitor.visitNumberLiteral

visitOperator()

visitOperator(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:1072

Parameters

Parameter	Type
`node`	`ASTOperator`

Returns

PlanOperator

Implementation of

LogicalPlanBuilder.visitOperator

visitQuantifier()

visitQuantifier(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:294

Parameters

Parameter	Type
`node`	`ASTQuantifier`

Returns

PlanOperator

Implementation of

SQLVisitor.visitQuantifier

visitRow()

visitRow(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:232

Parameters

Parameter	Type
`node`	`ASTRow`

Returns

PlanOperator

Implementation of

SQLVisitor.visitRow

visitRowsFrom()

visitRowsFrom(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:793

Parameters

Parameter	Type
`node`	`RowsFrom`

Returns

PlanOperator

Implementation of

SQLVisitor.visitRowsFrom

visitSelectSet()

visitSelectSet(node, _?, orderByAggs?): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:486

Builds the plan for a single SELECT body, merging any outer ORDER BY aggregate calls supplied by the caller.

Parameters

Parameter	Type	Description
`node`	`SelectSet`	-
`_?`	`unknown`	only for compliance with PlanVisitor
`orderByAggs?`	`AggregateCall`[]	aggregate calls inferred from an enclosing ORDER BY clause.

Returns

PlanTupleOperator

Throws

UnsupportedError when the SELECT uses window functions.

Implementation of

SQLVisitor.visitSelectSet

visitSelectSetOp()

visitSelectSetOp(node, left?): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:456

should be called only by SQLLogicalPlanBuilder#visitSelectSet, which provides the left arg

Parameters

Parameter	Type	Default value
`node`	`SelectSetOp`	`undefined`
`left`	`PlanTupleOperator`	`null`

Returns

PlanTupleOperator

Implementation of

SQLVisitor.visitSelectSetOp

visitSelectStatement()

visitSelectStatement(node): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:400

Parameters

Parameter	Type
`node`	`SelectStatement`

Returns

PlanTupleOperator

Implementation of

SQLVisitor.visitSelectStatement

visitSQLIdentifier()

visitSQLIdentifier(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:339

Parameters

Parameter	Type
`node`	`SQLIdentifier`

Returns

PlanOperator

Implementation of

SQLVisitor.visitSQLIdentifier

visitStringLiteral()

visitStringLiteral(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:204

Parameters

Parameter	Type
`node`	`ASTStringLiteral`

Returns

PlanOperator

Implementation of

SQLVisitor.visitStringLiteral

visitSubscript()

visitSubscript(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:266

Parameters

Parameter	Type
`node`	`ASTSubscript`

Returns

PlanOperator

Implementation of

SQLVisitor.visitSubscript

visitTableAlias()

visitTableAlias(node): PlanTupleOperator

Defined in: lang-sql/src/visitors/builder.ts:342

Parameters

Parameter	Type
`node`	`ASTTableAlias`

Returns

PlanTupleOperator

Implementation of

SQLVisitor.visitTableAlias

visitTableFn()

visitTableFn(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:776

Parameters

Parameter	Type
`node`	`TableFn`

Returns

PlanOperator

Implementation of

SQLVisitor.visitTableFn

visitTuple()

visitTuple(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:224

Parameters

Parameter	Type
`node`	`ASTTuple`

Returns

PlanOperator

Implementation of

SQLVisitor.visitTuple

visitValues()

visitValues(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:713

Parameters

Parameter	Type
`node`	`ValuesClause`

Returns

PlanOperator

Implementation of

SQLVisitor.visitValues

visitWindowFn()

visitWindowFn(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:773

Parameters

Parameter	Type
`node`	`ASTWindowFn`

Returns

PlanOperator

Implementation of

SQLVisitor.visitWindowFn

visitWindowSpec()

visitWindowSpec(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:770

Parameters

Parameter	Type
`node`	`WindowSpec`

Returns

PlanOperator

Implementation of

SQLVisitor.visitWindowSpec

visitWithQuery()

visitWithQuery(node): PlanOperator

Defined in: lang-sql/src/visitors/builder.ts:796

Parameters

Parameter	Type
`node`	`WithQuery`

Returns

PlanOperator

Implementation of

SQLVisitor.visitWithQuery

Implements​

Constructors​

Constructor​

Parameters​

Returns​

Properties​

calcBuilders​

dataAdapter​

db​

eqCheckers​

inferrerMap​

langCtx​

Type Declaration​

sql​

localLangCtx​

renamers​

stringifier​

Methods​

buildLimit()​

Parameters​

Returns​

Throws​

buildPlan()​

Parameters​

Returns​

Implementation of​

checkRecursionValidity()​

Parameters​

Returns​

Throws​

cloneLangCtx()​

Parameters​

Returns​

getAllTableNames()​

Parameters​

Returns​

getTableName()​

Parameters​

Returns​

handleRecursion()​

Parameters​

Returns​

idToTupleSource()​

Parameters​

Returns​

initLangCtx()​

Returns​

isRecursive()​

Parameters​

Returns​

materializeCte()​

Parameters​

Returns​

optimizeInOp()​

Parameters​

Returns​

opToCalc()​

Parameters​

Returns​

processAttr()​

Parameters​

Returns​

processFnArg()​

Parameters​

Returns​

processNode()​

Parameters​

Returns​

processOrderItem()​

Parameters​

Returns​

renameWithQuery()​

Parameters​

Returns​

toCalc()​

Parameters​

Returns​

visitAggregate()​

Parameters​

Returns​

Implements

Constructors

Constructor

Parameters

Returns

Properties

calcBuilders

dataAdapter

db

eqCheckers

inferrerMap

langCtx

Type Declaration

sql

localLangCtx

renamers

stringifier

Methods

buildLimit()

Parameters

Returns

Throws

buildPlan()

Parameters

Returns

Implementation of

checkRecursionValidity()

Parameters

Returns

Throws

cloneLangCtx()

Parameters

Returns

getAllTableNames()

Parameters

Returns

getTableName()

Parameters

Returns

handleRecursion()

Parameters

Returns

idToTupleSource()

Parameters

Returns

initLangCtx()

Returns

isRecursive()

Parameters

Returns

materializeCte()

Parameters

Returns

optimizeInOp()

Parameters

Returns

opToCalc()

Parameters

Returns

processAttr()

Parameters

Returns

processFnArg()

Parameters

Returns

processNode()

Parameters

Returns

processOrderItem()

Parameters

Returns

renameWithQuery()

Parameters

Returns

toCalc()

Parameters

Returns

visitAggregate()

Parameters

Returns