diff --git a/jOOQ/src/main/java/org/jooq/SelectQualifyConditionStep.java b/jOOQ/src/main/java/org/jooq/SelectQualifyConditionStep.java new file mode 100644 index 0000000000..25f0426465 --- /dev/null +++ b/jOOQ/src/main/java/org/jooq/SelectQualifyConditionStep.java @@ -0,0 +1,380 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * Other licenses: + * ----------------------------------------------------------------------------- + * Commercial licenses for this work are available. These replace the above + * ASL 2.0 and offer limited warranties, support, maintenance, and commercial + * database integrations. + * + * For more information, please visit: http://www.jooq.org/licenses + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + */ +package org.jooq; + +import org.jooq.impl.DSL; + + +/** + * This type is used for the {@link Select}'s DSL API when selecting generic + * {@link Record} types. + *

+ * Example:

+ * -- get all authors' first and last names, and the number
+ * -- of books they've written in German, if they have written
+ * -- more than five books in German in the last three years
+ * -- (from 2011), and sort those authors by last names
+ * -- limiting results to the second and third row
+ *
+ *   SELECT T_AUTHOR.FIRST_NAME, T_AUTHOR.LAST_NAME, COUNT(*)
+ *     FROM T_AUTHOR
+ *     JOIN T_BOOK ON T_AUTHOR.ID = T_BOOK.AUTHOR_ID
+ *    WHERE T_BOOK.LANGUAGE = 'DE'
+ *      AND T_BOOK.PUBLISHED > '2008-01-01'
+ * GROUP BY T_AUTHOR.FIRST_NAME, T_AUTHOR.LAST_NAME
+ *   HAVING COUNT(*) > 5
+ * ORDER BY T_AUTHOR.LAST_NAME ASC NULLS FIRST
+ *    LIMIT 2
+ *   OFFSET 1
+ *      FOR UPDATE
+ *       OF FIRST_NAME, LAST_NAME
+ *       NO WAIT
+ * 
Its equivalent in jOOQ
+ * create.select(TAuthor.FIRST_NAME, TAuthor.LAST_NAME, create.count())
+ *       .from(T_AUTHOR)
+ *       .join(T_BOOK).on(TBook.AUTHOR_ID.equal(TAuthor.ID))
+ *       .where(TBook.LANGUAGE.equal("DE"))
+ *       .and(TBook.PUBLISHED.greaterThan(parseDate('2008-01-01')))
+ *       .groupBy(TAuthor.FIRST_NAME, TAuthor.LAST_NAME)
+ *       .having(create.count().greaterThan(5))
+ *       .orderBy(TAuthor.LAST_NAME.asc().nullsFirst())
+ *       .limit(2)
+ *       .offset(1)
+ *       .forUpdate()
+ *       .of(TAuthor.FIRST_NAME, TAuthor.LAST_NAME)
+ *       .noWait();
+ * 
Refer to the manual for more details + *

+ *

Referencing XYZ*Step types directly from client code

+ *

+ * It 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: + *

+ * + * @author Lukas Eder + */ +public interface SelectQualifyConditionStep extends SelectOrderByStep { + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep and(Condition condition); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep and(Field condition); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + * + * @deprecated - 3.8.0 - [#4763] - Use {@link #and(Condition)} or + * {@link #and(Field)} instead. Due to ambiguity between + * calling this method using {@link Field#equals(Object)} + * argument, vs. calling the other method via a + * {@link Field#equal(Object)} argument, this method will be + * removed in the future. + */ + @Deprecated + @Support + SelectQualifyConditionStep and(Boolean condition); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + *

+ * 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 DSL#condition(SQL) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep and(SQL sql); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + *

+ * 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 DSL#condition(String) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep and(String sql); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + *

+ * 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 DSL#condition(String, Object...) + * @see DSL#sql(String, Object...) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep and(String sql, Object... bindings); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#AND} operator and proceed to the next step. + *

+ * 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 DSL#condition(String, QueryPart...) + * @see DSL#sql(String, QueryPart...) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep and(String sql, QueryPart... parts); + + /** + * Combine the currently assembled conditions with a negated other one using + * the {@link Operator#AND} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep andNot(Condition condition); + + /** + * Combine the currently assembled conditions with a negated other one using + * the {@link Operator#AND} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep andNot(Field condition); + + /** + * Combine the currently assembled conditions with a negated other one using + * the {@link Operator#AND} operator and proceed to the next step. + * + * @deprecated - 3.8.0 - [#4763] - Use {@link #andNot(Condition)} or + * {@link #andNot(Field)} instead. Due to ambiguity between + * calling this method using {@link Field#equals(Object)} + * argument, vs. calling the other method via a + * {@link Field#equal(Object)} argument, this method will be + * removed in the future. + */ + @Deprecated + @Support + SelectQualifyConditionStep andNot(Boolean condition); + + /** + * Combine the currently assembled conditions with an EXISTS clause using + * the {@link Operator#AND} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep andExists(Select select); + + /** + * Combine the currently assembled conditions with a NOT EXISTS clause using + * the {@link Operator#AND} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep andNotExists(Select select); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep or(Condition condition); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep or(Field condition); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + * + * @deprecated - 3.8.0 - [#4763] - Use {@link #or(Condition)} or + * {@link #or(Field)} instead. Due to ambiguity between + * calling this method using {@link Field#equals(Object)} + * argument, vs. calling the other method via a + * {@link Field#equal(Object)} argument, this method will be + * removed in the future. + */ + @Deprecated + @Support + SelectQualifyConditionStep or(Boolean condition); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + *

+ * 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 DSL#condition(SQL) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep or(SQL sql); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + *

+ * 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 DSL#condition(String) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep or(String sql); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + *

+ * 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 DSL#condition(String, Object...) + * @see DSL#sql(String, Object...) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep or(String sql, Object... bindings); + + /** + * Combine the currently assembled conditions with another one using the + * {@link Operator#OR} operator and proceed to the next step. + *

+ * 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 DSL#condition(String, QueryPart...) + * @see DSL#sql(String, QueryPart...) + * @see SQL + */ + @Support + @PlainSQL + SelectQualifyConditionStep or(String sql, QueryPart... parts); + + /** + * Combine the currently assembled conditions with a negated other one using + * the {@link Operator#OR} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep orNot(Condition condition); + + /** + * Combine the currently assembled conditions with a negated other one using + * the {@link Operator#OR} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep orNot(Field condition); + + /** + * Combine the currently assembled conditions with a negated other one using + * the {@link Operator#OR} operator and proceed to the next step. + * + * @deprecated - 3.8.0 - [#4763] - Use {@link #orNot(Condition)} or + * {@link #orNot(Field)} instead. Due to ambiguity between + * calling this method using {@link Field#equals(Object)} + * argument, vs. calling the other method via a + * {@link Field#equal(Object)} argument, this method will be + * removed in the future. + */ + @Deprecated + @Support + SelectQualifyConditionStep orNot(Boolean condition); + + /** + * Combine the currently assembled conditions with an EXISTS clause using + * the {@link Operator#OR} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep orExists(Select select); + + /** + * Combine the currently assembled conditions with a NOT EXISTS clause using + * the {@link Operator#OR} operator and proceed to the next step. + */ + @Support + SelectQualifyConditionStep orNotExists(Select select); +} diff --git a/jOOQ/src/main/java/org/jooq/SelectQualifyStep.java b/jOOQ/src/main/java/org/jooq/SelectQualifyStep.java new file mode 100644 index 0000000000..efcd3918ff --- /dev/null +++ b/jOOQ/src/main/java/org/jooq/SelectQualifyStep.java @@ -0,0 +1,198 @@ +/* + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * + * Other licenses: + * ----------------------------------------------------------------------------- + * Commercial licenses for this work are available. These replace the above + * ASL 2.0 and offer limited warranties, support, maintenance, and commercial + * database integrations. + * + * For more information, please visit: http://www.jooq.org/licenses + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + * + */ +package org.jooq; + +import static org.jooq.SQLDialect.H2; +// ... + +import java.util.Collection; + +import org.jooq.impl.DSL; + +/** + * This type is used for the {@link Select}'s DSL API when selecting generic + * {@link Record} types. + *

+ * Example:

+ * -- get all authors' first and last names, and the number
+ * -- of books they've written in German, if they have written
+ * -- more than five books in German in the last three years
+ * -- (from 2011), and sort those authors by last names
+ * -- limiting results to the second and third row
+ *
+ *   SELECT T_AUTHOR.FIRST_NAME, T_AUTHOR.LAST_NAME, COUNT(*)
+ *     FROM T_AUTHOR
+ *     JOIN T_BOOK ON T_AUTHOR.ID = T_BOOK.AUTHOR_ID
+ *    WHERE T_BOOK.LANGUAGE = 'DE'
+ *      AND T_BOOK.PUBLISHED > '2008-01-01'
+ * GROUP BY T_AUTHOR.FIRST_NAME, T_AUTHOR.LAST_NAME
+ *   HAVING COUNT(*) > 5
+ * ORDER BY T_AUTHOR.LAST_NAME ASC NULLS FIRST
+ *    LIMIT 2
+ *   OFFSET 1
+ *      FOR UPDATE
+ *       OF FIRST_NAME, LAST_NAME
+ *       NO WAIT
+ * 
Its equivalent in jOOQ
+ * create.select(TAuthor.FIRST_NAME, TAuthor.LAST_NAME, create.count())
+ *       .from(T_AUTHOR)
+ *       .join(T_BOOK).on(TBook.AUTHOR_ID.equal(TAuthor.ID))
+ *       .where(TBook.LANGUAGE.equal("DE"))
+ *       .and(TBook.PUBLISHED.greaterThan(parseDate('2008-01-01')))
+ *       .groupBy(TAuthor.FIRST_NAME, TAuthor.LAST_NAME)
+ *       .qualify(create.count().greaterThan(5))
+ *       .orderBy(TAuthor.LAST_NAME.asc().nullsFirst())
+ *       .limit(2)
+ *       .offset(1)
+ *       .forUpdate()
+ *       .of(TAuthor.FIRST_NAME, TAuthor.LAST_NAME)
+ *       .noWait();
+ * 
Refer to the manual for more details + *

+ *

Referencing XYZ*Step types directly from client code

+ *

+ * It 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 + */ +public interface SelectQualifyStep extends SelectOrderByStep { + + /** + * Add a QUALIFY clause to the query, connecting them with each + * other with {@link Operator#AND}. + */ + @Support({ H2 }) + SelectQualifyConditionStep qualify(Condition condition); + + /** + * Add a QUALIFY clause to the query, connecting them with each + * other with {@link Operator#AND}. + */ + @Support({ H2 }) + SelectQualifyConditionStep qualify(Condition... conditions); + + /** + * Add a QUALIFY clause to the query, connecting them with each + * other with {@link Operator#AND}. + */ + @Support({ H2 }) + SelectQualifyConditionStep qualify(Collection conditions); + + /** + * Add a QUALIFY clause to the query. + */ + @Support({ H2 }) + SelectQualifyConditionStep qualify(Field condition); + + /** + * Add a QUALIFY clause to the query. + *

+ * 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 DSL#condition(SQL) + * @see SQL + */ + @Support({ H2 }) + @PlainSQL + SelectQualifyConditionStep qualify(SQL sql); + + /** + * Add a QUALIFY clause to the query. + *

+ * 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 DSL#condition(String) + * @see SQL + */ + @Support({ H2 }) + @PlainSQL + SelectQualifyConditionStep qualify(String sql); + + /** + * Add a QUALIFY clause to the query. + *

+ * 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 DSL#condition(String, Object...) + * @see DSL#sql(String, Object...) + * @see SQL + */ + @Support({ H2 }) + @PlainSQL + SelectQualifyConditionStep qualify(String sql, Object... bindings); + + /** + * Add a QUALIFY clause to the query. + *

+ * 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 DSL#condition(String, QueryPart...) + * @see DSL#sql(String, QueryPart...) + * @see SQL + */ + @Support({ H2 }) + @PlainSQL + SelectQualifyConditionStep qualify(String sql, QueryPart... parts); + +}