-
- All Known Subinterfaces:
TableOptionalOnStep<R>
,TablePartitionByStep<R>
public interface TableOnStep<R extends Record>
An intermediate type for the construction of aJOIN
clause, where there must be a join criteria added using anON
clause (with aCondition
), or using aUSING
clause (with a list ofField
).Referencing
XYZ*Step
types directly from client codeIt is usually not recommended to reference any
XYZ*Step
types directly from client code, or assign them to local variables. When writing dynamic SQL, creating a statement's components dynamically, and passing them to the DSL API statically is usually a better choice. See the manual's section about dynamic SQL for details: https://www.jooq.org/doc/latest/manual/sql-building/dynamic-sql.Drawbacks of referencing the
XYZ*Step
types directly:- They're operating on mutable implementations (as of jOOQ 3.x)
- They're less composable and not easy to get right when dynamic SQL gets complex
- They're less readable
- They might have binary incompatible changes between minor releases
- Author:
- Lukas Eder
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description @NotNull TableOnConditionStep<R>
on(Boolean condition)
Deprecated.- 3.8.0 - [#4763] - Useon(Condition)
(typically withDSL.trueCondition()
,DSL.falseCondition()
, orDSL.noCondition()
as the parameter) oron(Field)
instead.@NotNull TableOnConditionStep<R>
on(String sql)
Add anON
clause to theJOIN
.@NotNull TableOnConditionStep<R>
on(String sql, Object... bindings)
Add anON
clause to theJOIN
.@NotNull TableOnConditionStep<R>
on(String sql, QueryPart... parts)
Add anON
clause to theJOIN
.@NotNull TableOnConditionStep<R>
on(Condition condition)
@NotNull TableOnConditionStep<R>
on(Condition... conditions)
@NotNull TableOnConditionStep<R>
on(Field<Boolean> condition)
Add anON
clause to theJOIN
.@NotNull TableOnConditionStep<R>
on(SQL sql)
Add anON
clause to theJOIN
.@NotNull TableOnConditionStep<R>
onKey()
Join the table on a non-ambiguous foreign key relationship between the two joined tables.@NotNull TableOnConditionStep<R>
onKey(ForeignKey<?,?> key)
Join the table on a non-ambiguous foreign key relationship between the two joined tables.@NotNull TableOnConditionStep<R>
onKey(TableField<?,?>... keyFields)
Join the table on a non-ambiguous foreign key relationship between the two joined tables.@NotNull Table<Record>
using(Collection<? extends Field<?>> fields)
Join a table with theUSING(column [, column...])
syntax.@NotNull Table<Record>
using(Field<?>... fields)
Join a table with theUSING(column [, column...])
syntax.
-
-
-
Method Detail
-
on
@NotNull @Support @NotNull TableOnConditionStep<R> on(Condition condition)
-
on
@NotNull @Support @NotNull TableOnConditionStep<R> on(Condition... conditions)
-
on
@NotNull @Support @NotNull TableOnConditionStep<R> on(Field<Boolean> condition)
Add anON
clause to theJOIN
.
-
on
@Deprecated @NotNull @Support @NotNull TableOnConditionStep<R> on(Boolean condition)
Deprecated.- 3.8.0 - [#4763] - Useon(Condition)
(typically withDSL.trueCondition()
,DSL.falseCondition()
, orDSL.noCondition()
as the parameter) oron(Field)
instead. Due to ambiguity between calling this method usingField.equals(Object)
argument, vs. calling the other method via aField.equal(Object)
argument, this method will be removed in the future.Add anON
clause to theJOIN
.
-
on
@NotNull @Support @PlainSQL @NotNull TableOnConditionStep<R> on(SQL sql)
Add anON
clause to theJOIN
.NOTE: When inserting plain SQL into jOOQ objects, you must guarantee syntax integrity. You may also create the possibility of malicious SQL injection. Be sure to properly use bind variables and/or escape literals when concatenated into SQL clauses!
- See Also:
DSL.condition(SQL)
,SQL
-
on
@NotNull @Support @PlainSQL @NotNull TableOnConditionStep<R> on(String sql)
Add anON
clause to theJOIN
.NOTE: When inserting plain SQL into jOOQ objects, you must guarantee syntax integrity. You may also create the possibility of malicious SQL injection. Be sure to properly use bind variables and/or escape literals when concatenated into SQL clauses!
- See Also:
DSL.condition(String)
,SQL
-
on
@NotNull @Support @PlainSQL @NotNull TableOnConditionStep<R> on(String sql, Object... bindings)
Add anON
clause to theJOIN
.NOTE: When inserting plain SQL into jOOQ objects, you must guarantee syntax integrity. You may also create the possibility of malicious SQL injection. Be sure to properly use bind variables and/or escape literals when concatenated into SQL clauses!
-
on
@NotNull @Support @PlainSQL @NotNull TableOnConditionStep<R> on(String sql, QueryPart... parts)
Add anON
clause to theJOIN
.NOTE: When inserting plain SQL into jOOQ objects, you must guarantee syntax integrity. You may also create the possibility of malicious SQL injection. Be sure to properly use bind variables and/or escape literals when concatenated into SQL clauses!
-
using
@NotNull @Support @NotNull Table<Record> using(Field<?>... fields)
Join a table with theUSING(column [, column...])
syntax.If this is not supported by your RDBMS, then jOOQ will try to emulate this behaviour using the information provided in this query.
-
using
@NotNull @Support @NotNull Table<Record> using(Collection<? extends Field<?>> fields)
Join a table with theUSING(column [, column...])
syntax.If this is not supported by your RDBMS, then jOOQ will try to emulate this behaviour using the information provided in this query.
-
onKey
@NotNull @Support @NotNull TableOnConditionStep<R> onKey() throws DataAccessException
Join the table on a non-ambiguous foreign key relationship between the two joined tables.See
onKey(ForeignKey)
for examples.- Throws:
DataAccessException
- If there is no non-ambiguous key definition known to jOOQ- See Also:
onKey(ForeignKey)
-
onKey
@NotNull @Support @NotNull TableOnConditionStep<R> onKey(TableField<?,?>... keyFields) throws DataAccessException
Join the table on a non-ambiguous foreign key relationship between the two joined tables.See
onKey(ForeignKey)
for examples.- Throws:
DataAccessException
- If there is no non-ambiguous key definition known to jOOQ- See Also:
onKey(ForeignKey)
-
onKey
@NotNull @Support @NotNull TableOnConditionStep<R> onKey(ForeignKey<?,?> key)
Join the table on a non-ambiguous foreign key relationship between the two joined tables.An example:
// There is a single foreign key relationship between A and B and it can // be obtained by A.getReferencesTo(B) or vice versa. The order of A and // B is not important A.join(B).onKey(); // There are several foreign key relationships between A and B. In order // to disambiguate, you can provide a formal org.jooq.Key reference from // the generated Keys class A.join(B).onKey(key); // There are several foreign key relationships between A and B. In order // to disambiguate, you can provide any non-ambiguous foreign key column A.join(B).onKey(B.A_ID);
-
-