Join class final

Represents a join of a table to a query.

This allows applying a JoinOperator and optionally also an on condition.

Inheritance

Constructors

Join(JoinOperator operator, ResultSetDsl table, {Expression<bool>? on, bool? includeInResult})
Create a join clause with the given operator and table.
Join.cross(ResultSetDsl table, {Expression<bool>? on, bool? includeInResult})
Create a CROSS JOIN for the table.
Join.fullOuter(ResultSetDsl table, {Expression<bool>? on, bool? includeInResult})
Create an FULL OUTER JOIN for the table.
Join.inner(ResultSetDsl table, {Expression<bool>? on, bool? includeInResult})
Create an INNER JOIN for the table.
Join.leftOuter(ResultSetDsl table, {Expression<bool>? on, bool? includeInResult})
Create an LEFT OUTER JOIN for the table.
Join.rightOuter(ResultSetDsl table, {Expression<bool>? on, bool? includeInResult})
Create an RIGHT OUTER JOIN for the table.

Properties

hashCode → int
The hash code for this object.
no setterinherited
includeInResult → bool?
Whether table should appear in the result set (defaults to true). Default value can be changed by includeJoinedTableColumns in selectOnly statements.
final
on → Expression<bool>?
For joins that aren't JoinOperator.cross, contains an additional predicate that must be matched for the join.
final
operator → JoinOperator
The JoinOperator to use for this join.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
table → FromResultSet
The ResultSet that will be added to the query.
final

Methods

compileWith(StatementCompiler compiler) → void
Compiles this component with the given StatementCompiler by invoking the relevant add method on it.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited