Skip to main content

Class: WithQuery

Defined in: lang-sql/src/ast/with.ts:16

A single CTE definition inside a WITH clause.

Implements

Constructors

Constructor

new WithQuery(name, colNames, query, materialized?): WithQuery

Defined in: lang-sql/src/ast/with.ts:35

Parameters

ParameterTypeDescription
nameSQLIdentifierThe CTE name.
colNamesSQLIdentifier[]Optional explicit column names; null if not specified.
queryASTNodeThe CTE body query.
materialized?booleantrue to force materialization, false to force inlining, undefined to let the optimizer decide.

Returns

WithQuery

Properties

colNames

colNames: SQLIdentifier[]

Defined in: lang-sql/src/ast/with.ts:39

Optional explicit column names; null if not specified.


cycleCols

cycleCols: SQLIdentifier[]

Defined in: lang-sql/src/ast/with.ts:25

Columns tracked for cycle detection; undefined if no CYCLE clause.


cycleMarkDefault

cycleMarkDefault: ASTNode

Defined in: lang-sql/src/ast/with.ts:33

Value assigned to the cycle mark column for non-cycled rows.


cycleMarkName

cycleMarkName: SQLIdentifier

Defined in: lang-sql/src/ast/with.ts:27

Column name used to mark cycled rows.


cycleMarkVal

cycleMarkVal: ASTNode

Defined in: lang-sql/src/ast/with.ts:31

Value assigned to the cycle mark column when a cycle is detected.


cyclePathName

cyclePathName: SQLIdentifier

Defined in: lang-sql/src/ast/with.ts:29

Column name holding the path of cycle ancestors.


materialized?

optional materialized?: boolean

Defined in: lang-sql/src/ast/with.ts:43

true to force materialization, false to force inlining, undefined to let the optimizer decide.


name

name: SQLIdentifier

Defined in: lang-sql/src/ast/with.ts:37

The CTE name.


query

query: ASTNode

Defined in: lang-sql/src/ast/with.ts:41

The CTE body query.


searchCols

searchCols: SQLIdentifier[]

Defined in: lang-sql/src/ast/with.ts:18

Columns tracked for the SEARCH ordering; undefined if no SEARCH clause.


searchName

searchName: SQLIdentifier

Defined in: lang-sql/src/ast/with.ts:22

Column name that holds the search order sequence.


searchType

searchType: SearchType = SearchType.BFS

Defined in: lang-sql/src/ast/with.ts:20

Traversal order for the SEARCH clause.

Methods

accept()

accept<Ret, Arg>(visitor, arg?): Ret

Defined in: lang-sql/src/ast/with.ts:46

Dispatches this node to the matching method on visitor.

Type Parameters

Type Parameter
Ret
Arg

Parameters

ParameterType
visitorSQLVisitor<Ret, Arg>
arg?Arg

Returns

Ret

Implementation of

ASTNode.accept