All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.jooq.SelectOnStep Maven / Gradle / Ivy

The newest version!
/*
 * Copyright (c) 2009-2016, Data Geekery GmbH (http://www.datageekery.com)
 * All rights reserved.
 *
 * 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 java.util.Collection;

import org.jooq.exception.DataAccessException;
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 * * @author Lukas Eder */ public interface SelectOnStep { /** * Add an ON clause to the previous JOIN, * connecting them with each other with {@link Operator#AND}. */ @Support SelectOnConditionStep on(Condition... conditions); /** * Add an ON clause to the previous JOIN. */ @Support SelectOnConditionStep on(Field condition); /** * Add an ON clause to the previous JOIN. * * @deprecated - 3.8.0 - [#4763] - Use {@link #on(Condition...)} or * {@link #on(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 SelectOnConditionStep on(Boolean condition); /** * Add an ON clause to the previous JOIN. *

* 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 SelectOnConditionStep on(SQL sql); /** * Add an ON clause to the previous JOIN. *

* 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 SelectOnConditionStep on(String sql); /** * Add an ON clause to the previous JOIN. *

* 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 SelectOnConditionStep on(String sql, Object... bindings); /** * Add an ON clause to the previous JOIN. *

* 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 SelectOnConditionStep on(String sql, QueryPart... parts); /** * Join the previous table on a non-ambiguous foreign key relationship * between the two joined tables. *

* See {@link TableOnStep#onKey(ForeignKey)} for examples. * * @see TableOnStep#onKey(ForeignKey) * @throws DataAccessException If there is no non-ambiguous key definition * known to jOOQ */ @Support SelectJoinStep onKey() throws DataAccessException; /** * Join the previous table on a non-ambiguous foreign key relationship * between the two joined tables. *

* See {@link TableOnStep#onKey(ForeignKey)} for examples. * * @see TableOnStep#onKey(ForeignKey) * @throws DataAccessException If there is no non-ambiguous key definition * known to jOOQ */ @Support SelectJoinStep onKey(TableField... keyFields) throws DataAccessException; /** * Join the table on a non-ambiguous foreign key relationship between the * two joined tables. *

* See {@link TableOnStep#onKey(ForeignKey)} for examples. * * @see TableOnStep#onKey(ForeignKey) */ @Support SelectJoinStep onKey(ForeignKey key); /** * Join the previous table with the USING(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. */ @Support SelectJoinStep using(Field... fields); /** * Join the previous table with the USING(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. */ @Support SelectJoinStep using(Collection> fields); }





© 2015 - 2024 Weber Informatics LLC | Privacy Policy