Skip to main content

Class: TableFn

Defined in: lang-sql/src/ast/select.ts:207

A set-returning function in the FROM clause, extending ASTFunction.

Extends​

Constructors​

Constructor​

new TableFn(id, args, withOrdinality?): TableFn

Defined in: lang-sql/src/ast/select.ts:208

Parameters​

ParameterTypeDefault valueDescription
idASTIdentifierundefined-
argsASTNode[]undefined-
withOrdinalitybooleanfalsetrue when WITH ORDINALITY was specified, adding an ordinal column.

Returns​

TableFn

Overrides​

ASTFunction.constructor

Properties​

args​

args: ASTNode[]

Defined in: core/dist/ast.d.ts:54

Argument expressions in source order.

Inherited from​

ASTFunction.args


id​

id: ASTIdentifier

Defined in: core/dist/ast.d.ts:52

Identifier that resolves to the function implementation.

Inherited from​

ASTFunction.id


lang​

lang: Lowercase<string>

Defined in: core/dist/ast.d.ts:50

Language this function belongs to.

Inherited from​

ASTFunction.lang


withOrdinality​

withOrdinality: boolean = false

Defined in: lang-sql/src/ast/select.ts:212

true when WITH ORDINALITY was specified, adding an ordinal column.

Methods​

accept()​

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

Defined in: lang-sql/src/ast/select.ts:217

ASTNode.accept

Type Parameters​

Type Parameter
Ret
Arg

Parameters​

ParameterType
visitorSQLVisitor<Ret, Arg>
arg?Arg

Returns​

Ret

Overrides​

ASTFunction.accept