Class: JoinClause

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

A join between two table sources.

Implements

• ASTNode

Constructors

Constructor

new JoinClause(tableLeft, tableRight, joinType, joinCond?, lateral?): JoinClause

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

Parameters

Parameter	Type	Default value	Description
tableLeft	ASTTableAlias | ASTIdentifier | JoinClause	undefined	The left-hand table source.
tableRight	ASTTableAlias | ASTIdentifier | JoinClause	undefined	The right-hand table source.
joinType	JoinType	undefined	The join variant.
joinCond?	ASTNode | ASTIdentifier[]	undefined	-
lateral?	boolean	false	true when the right side is a LATERAL expression.

Returns

JoinClause

Properties

condition?

optional condition?: ASTNode

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

ON join predicate; undefined when USING or NATURAL is used.

---

joinType

joinType: JoinType

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

The join variant.

---

lateral

lateral: boolean = false

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

true when the right side is a LATERAL expression.

---

natural

natural: boolean = false

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

true when the NATURAL keyword was present.

---

tableLeft

tableLeft: ASTTableAlias | ASTIdentifier | JoinClause

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

The left-hand table source.

---

tableRight

tableRight: ASTTableAlias | ASTIdentifier | JoinClause

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

The right-hand table source.

---

using?

optional using?: ASTIdentifier[]

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

USING column list; undefined when ON or NATURAL is used.

Methods

accept()

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

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

Dispatches this node to the matching method on visitor.

Type Parameters

Type Parameter
Ret
Arg

Parameters

Parameter	Type
visitor	SQLVisitor<Ret, Arg>
arg?	Arg

Returns

Ret

Implementation of

ASTNode.accept