org.jooq.SelectOnConditionStep Maven / Gradle / Ivy
/*
* 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
* Apache-2.0 license 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.jetbrains.annotations.*;
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:
*
* - 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 SelectOnConditionStep extends SelectJoinStep {
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator and proceed to the next step.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep and(Condition condition);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#AND} operator and proceed to the next step.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep and(Field 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep 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.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep andNot(Field condition);
/**
* Combine the currently assembled conditions with an EXISTS clause using
* the {@link Operator#AND} operator and proceed to the next step.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep 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.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep andNotExists(Select select);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator and proceed to the next step.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep or(Condition condition);
/**
* Combine the currently assembled conditions with another one using the
* {@link Operator#OR} operator and proceed to the next step.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep or(Field 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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
*/
@NotNull @CheckReturnValue
@Support
@PlainSQL
SelectOnConditionStep 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.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep 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.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep orNot(Field condition);
/**
* Combine the currently assembled conditions with an EXISTS clause using
* the {@link Operator#OR} operator and proceed to the next step.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep 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.
*/
@NotNull @CheckReturnValue
@Support
SelectOnConditionStep orNotExists(Select select);
}