jooq/jOOQ/src/main/java/org/jooq/SelectSeekStep11.java

/*
 * 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
 *
 *  https://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: https://www.jooq.org/legal/licensing
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 *
 */
package org.jooq;

import org.jetbrains.annotations.NotNull;

/**
 * This type is used for the {@link Select}'s DSL API when selecting generic
 * {@link Record} types.
 * <p>
 * Example: <pre><code>
 * -- 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 &gt; '2008-01-01'
 * GROUP BY T_AUTHOR.FIRST_NAME, T_AUTHOR.LAST_NAME
 *   HAVING COUNT(*) &gt; 5
 * ORDER BY T_AUTHOR.LAST_NAME ASC NULLS FIRST
 *    LIMIT 2
 *   OFFSET 1
 *      FOR UPDATE
 *       OF FIRST_NAME, LAST_NAME
 *       NO WAIT
 * </code></pre> Its equivalent in jOOQ <pre><code>
 * 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();
 * </code></pre> Refer to the manual for more details
 *
 * @author Lukas Eder
 */
public interface SelectSeekStep11<R extends Record, T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11> extends SelectLimitStep<R> {

    /**
     * Add a synthetic <code>SEEK AFTER</code> clause to the query.
     * <p>
     * The synthetic <code>SEEK AFTER</code> clause is an alternative way to specify
     * an <code>OFFSET</code>, and thus to perform paging in a SQL query. This
     * can be advantageous for two reasons:
     * <p>
     * <ol>
     * <li>The SQL generated from the <code>SEEK AFTER</code> clause is a regular
     * predicate, which can be used by query plan optimisers to choose an
     * appropriate index. The SQL standard <code>OFFSET</code> clause will need
     * to skip <code>N</code> rows in memory.</li>
     * <li>The <code>SEEK AFTER</code> clause is stable with respect to new data being
     * inserted or data being deleted while paging through pages.</li>
     * </ol>
     * <p>
     * Example: <pre><code>
     * DSL.using(configuration)
     *    .selectFrom(TABLE)
     *    .orderBy(ID, CODE)
     *    .seek(3, "abc")
     *    .fetch();
     * </code></pre>
     * <p>
     * The above query will render the following SQL statement:
     * <p>
     * <pre><code>
     * SELECT table.col1, table.col2, ... FROM table
     * WHERE (id, code) &gt; (3, 'abc')
     * ORDER BY id ASC, code ASC
     * </code></pre>
     * <p>
     * The actual row value expression predicate may be expanded into this
     * equivalent predicate:
     * <p>
     * <pre><code>
     * WHERE (id &gt; 3) OR (id = 3 AND code &gt; 'abc')
     * </code></pre>
     * <p>
     * The seek column list length must match the <code>ORDER BY</code> expression
     * list length.
     * <p>
     * <h3><code>NULL</code> handling</h3>
     * <p>
     * <code>NULL</code> handling in the <code>SEEK</code> clause is enabled
     * only for <code>ORDER BY</code> expressions when providing explicit
     * {@link SortField#nullsFirst()} or {@link SortField#nullsLast()} clauses,
     * in case of which the <code>SEEK</code> predicate is always composed of
     * multiple predicates containing {@link Field#isNull()} or
     * {@link Field#isNotNull()}, respectively, never of <code>ROW</code>
     * predicates.
     *
     * @see <a
     *      href="http://use-the-index-luke.com/sql/partial-results/fetch-next-page">http://use-the-index-luke.com/sql/partial-results/fetch-next-page</a>
     * @see <a
     *      href="https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method/">https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method</a>
     * @see #seekAfter(Object, Object, Object, Object, Object, Object, Object, Object, Object, Object, Object)
     */
    @NotNull @CheckReturnValue
    @Support
    SelectSeekLimitStep<R> seek(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8, T9 t9, T10 t10, T11 t11);

    /**
     * Add a synthetic <code>SEEK AFTER</code> clause to the query.
     * <p>
     * The synthetic <code>SEEK AFTER</code> clause is an alternative way to specify
     * an <code>OFFSET</code>, and thus to perform paging in a SQL query. This
     * can be advantageous for two reasons:
     * <p>
     * <ol>
     * <li>The SQL generated from the <code>SEEK AFTER</code> clause is a regular
     * predicate, which can be used by query plan optimisers to choose an
     * appropriate index. The SQL standard <code>OFFSET</code> clause will need
     * to skip <code>N</code> rows in memory.</li>
     * <li>The <code>SEEK AFTER</code> clause is stable with respect to new data being
     * inserted or data being deleted while paging through pages.</li>
     * </ol>
     * <p>
     * Example: <pre><code>
     * DSL.using(configuration)
     *    .selectFrom(TABLE)
     *    .orderBy(ID, CODE)
     *    .seek(3, "abc")
     *    .fetch();
     * </code></pre>
     * <p>
     * The above query will render the following SQL statement:
     * <p>
     * <pre><code>
     * SELECT table.col1, table.col2, ... FROM table
     * WHERE (id, code) &gt; (3, 'abc')
     * ORDER BY id ASC, code ASC
     * </code></pre>
     * <p>
     * The actual row value expression predicate may be expanded into this
     * equivalent predicate:
     * <p>
     * <pre><code>
     * WHERE (id &gt; 3) OR (id = 3 AND code &gt; 'abc')
     * </code></pre>
     * <p>
     * The seek column list length must match the <code>ORDER BY</code> expression
     * list length.
     * <p>
     * <h3><code>NULL</code> handling</h3>
     * <p>
     * <code>NULL</code> handling in the <code>SEEK</code> clause is enabled
     * only for <code>ORDER BY</code> expressions when providing explicit
     * {@link SortField#nullsFirst()} or {@link SortField#nullsLast()} clauses,
     * in case of which the <code>SEEK</code> predicate is always composed of
     * multiple predicates containing {@link Field#isNull()} or
     * {@link Field#isNotNull()}, respectively, never of <code>ROW</code>
     * predicates.
     *
     * @see <a
     *      href="http://use-the-index-luke.com/sql/partial-results/fetch-next-page">http://use-the-index-luke.com/sql/partial-results/fetch-next-page</a>
     * @see <a
     *      href="https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method/">https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method</a>
     * @see #seekAfter(Field, Field, Field, Field, Field, Field, Field, Field, Field, Field, Field)
     */
    @NotNull @CheckReturnValue
    @Support
    SelectSeekLimitStep<R> seek(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11);

    /**
     * Add a synthetic <code>SEEK AFTER</code> clause to the query.
     * <p>
     * The synthetic <code>SEEK AFTER</code> clause is an alternative way to specify
     * an <code>OFFSET</code>, and thus to perform paging in a SQL query. This
     * can be advantageous for two reasons:
     * <p>
     * <ol>
     * <li>The SQL generated from the <code>SEEK AFTER</code> clause is a regular
     * predicate, which can be used by query plan optimisers to choose an
     * appropriate index. The SQL standard <code>OFFSET</code> clause will need
     * to skip <code>N</code> rows in memory.</li>
     * <li>The <code>SEEK AFTER</code> clause is stable with respect to new data being
     * inserted or data being deleted while paging through pages.</li>
     * </ol>
     * <p>
     * Example: <pre><code>
     * DSL.using(configuration)
     *    .selectFrom(TABLE)
     *    .orderBy(ID, CODE)
     *    .seekAfter(3, "abc")
     *    .fetch();
     * </code></pre>
     * <p>
     * The above query will render the following SQL statement:
     * <p>
     * <pre><code>
     * SELECT table.col1, table.col2, ... FROM table
     * WHERE (id, code) &gt; (3, 'abc')
     * ORDER BY id ASC, code ASC
     * </code></pre>
     * <p>
     * The actual row value expression predicate may be expanded into this
     * equivalent predicate:
     * <p>
     * <pre><code>
     * WHERE (id &gt; 3) OR (id = 3 AND code &gt; 'abc')
     * </code></pre>
     * <p>
     * The seek column list length must match the <code>ORDER BY</code> expression
     * list length.
     * <p>
     * <h3><code>NULL</code> handling</h3>
     * <p>
     * <code>NULL</code> handling in the <code>SEEK</code> clause is enabled
     * only for <code>ORDER BY</code> expressions when providing explicit
     * {@link SortField#nullsFirst()} or {@link SortField#nullsLast()} clauses,
     * in case of which the <code>SEEK</code> predicate is always composed of
     * multiple predicates containing {@link Field#isNull()} or
     * {@link Field#isNotNull()}, respectively, never of <code>ROW</code>
     * predicates.
     *
     * @see <a
     *      href="http://use-the-index-luke.com/sql/partial-results/fetch-next-page">http://use-the-index-luke.com/sql/partial-results/fetch-next-page</a>
     * @see <a
     *      href="https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method/">https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method</a>
     */
    @NotNull @CheckReturnValue
    @Support
    SelectSeekLimitStep<R> seekAfter(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8, T9 t9, T10 t10, T11 t11);

    /**
     * Add a synthetic <code>SEEK AFTER</code> clause to the query.
     * <p>
     * The synthetic <code>SEEK AFTER</code> clause is an alternative way to specify
     * an <code>OFFSET</code>, and thus to perform paging in a SQL query. This
     * can be advantageous for two reasons:
     * <p>
     * <ol>
     * <li>The SQL generated from the <code>SEEK AFTER</code> clause is a regular
     * predicate, which can be used by query plan optimisers to choose an
     * appropriate index. The SQL standard <code>OFFSET</code> clause will need
     * to skip <code>N</code> rows in memory.</li>
     * <li>The <code>SEEK AFTER</code> clause is stable with respect to new data being
     * inserted or data being deleted while paging through pages.</li>
     * </ol>
     * <p>
     * Example: <pre><code>
     * DSL.using(configuration)
     *    .selectFrom(TABLE)
     *    .orderBy(ID, CODE)
     *    .seekAfter(3, "abc")
     *    .fetch();
     * </code></pre>
     * <p>
     * The above query will render the following SQL statement:
     * <p>
     * <pre><code>
     * SELECT table.col1, table.col2, ... FROM table
     * WHERE (id, code) &gt; (3, 'abc')
     * ORDER BY id ASC, code ASC
     * </code></pre>
     * <p>
     * The actual row value expression predicate may be expanded into this
     * equivalent predicate:
     * <p>
     * <pre><code>
     * WHERE (id &gt; 3) OR (id = 3 AND code &gt; 'abc')
     * </code></pre>
     * <p>
     * The seek column list length must match the <code>ORDER BY</code> expression
     * list length.
     * <p>
     * <h3><code>NULL</code> handling</h3>
     * <p>
     * <code>NULL</code> handling in the <code>SEEK</code> clause is enabled
     * only for <code>ORDER BY</code> expressions when providing explicit
     * {@link SortField#nullsFirst()} or {@link SortField#nullsLast()} clauses,
     * in case of which the <code>SEEK</code> predicate is always composed of
     * multiple predicates containing {@link Field#isNull()} or
     * {@link Field#isNotNull()}, respectively, never of <code>ROW</code>
     * predicates.
     *
     * @see <a
     *      href="http://use-the-index-luke.com/sql/partial-results/fetch-next-page">http://use-the-index-luke.com/sql/partial-results/fetch-next-page</a>
     * @see <a
     *      href="https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method/">https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method</a>
     */
    @NotNull @CheckReturnValue
    @Support
    SelectSeekLimitStep<R> seekAfter(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11);

    /**
     * Add a synthetic <code>SEEK BEFORE</code> clause to the query.
     * <p>
     * The synthetic <code>SEEK BEFORE</code> clause is an alternative way to specify
     * an <code>OFFSET</code>, and thus to perform paging in a SQL query. This
     * can be advantageous for two reasons:
     * <p>
     * <ol>
     * <li>The SQL generated from the <code>SEEK BEFORE</code> clause is a regular
     * predicate, which can be used by query plan optimisers to choose an
     * appropriate index. The SQL standard <code>OFFSET</code> clause will need
     * to skip <code>N</code> rows in memory.</li>
     * <li>The <code>SEEK BEFORE</code> clause is stable with respect to new data being
     * inserted or data being deleted while paging through pages.</li>
     * </ol>
     * <p>
     * Example: <pre><code>
     * DSL.using(configuration)
     *    .selectFrom(TABLE)
     *    .orderBy(ID, CODE)
     *    .seekBefore(3, "abc")
     *    .fetch();
     * </code></pre>
     * <p>
     * The above query will render the following SQL statement:
     * <p>
     * <pre><code>
     * SELECT table.col1, table.col2, ... FROM table
     * WHERE (id, code) &lt; (3, 'abc')
     * ORDER BY id ASC, code ASC
     * </code></pre>
     * <p>
     * The actual row value expression predicate may be expanded into this
     * equivalent predicate:
     * <p>
     * <pre><code>
     * WHERE (id &lt; 3) OR (id = 3 AND code &lt; 'abc')
     * </code></pre>
     * <p>
     * The seek column list length must match the <code>ORDER BY</code> expression
     * list length.
     * <p>
     * <h3><code>NULL</code> handling</h3>
     * <p>
     * <code>NULL</code> handling in the <code>SEEK</code> clause is enabled
     * only for <code>ORDER BY</code> expressions when providing explicit
     * {@link SortField#nullsFirst()} or {@link SortField#nullsLast()} clauses,
     * in case of which the <code>SEEK</code> predicate is always composed of
     * multiple predicates containing {@link Field#isNull()} or
     * {@link Field#isNotNull()}, respectively, never of <code>ROW</code>
     * predicates.
     *
     * @see <a
     *      href="http://use-the-index-luke.com/sql/partial-results/fetch-next-page">http://use-the-index-luke.com/sql/partial-results/fetch-next-page</a>
     * @see <a
     *      href="https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method/">https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method</a>
     * @deprecated - [#7461] - SEEK BEFORE is not implemented correctly
     */
    @Deprecated
    @NotNull @CheckReturnValue
    @Support
    SelectSeekLimitStep<R> seekBefore(T1 t1, T2 t2, T3 t3, T4 t4, T5 t5, T6 t6, T7 t7, T8 t8, T9 t9, T10 t10, T11 t11);

    /**
     * Add a synthetic <code>SEEK BEFORE</code> clause to the query.
     * <p>
     * The synthetic <code>SEEK BEFORE</code> clause is an alternative way to specify
     * an <code>OFFSET</code>, and thus to perform paging in a SQL query. This
     * can be advantageous for two reasons:
     * <p>
     * <ol>
     * <li>The SQL generated from the <code>SEEK BEFORE</code> clause is a regular
     * predicate, which can be used by query plan optimisers to choose an
     * appropriate index. The SQL standard <code>OFFSET</code> clause will need
     * to skip <code>N</code> rows in memory.</li>
     * <li>The <code>SEEK BEFORE</code> clause is stable with respect to new data being
     * inserted or data being deleted while paging through pages.</li>
     * </ol>
     * <p>
     * Example: <pre><code>
     * DSL.using(configuration)
     *    .selectFrom(TABLE)
     *    .orderBy(ID, CODE)
     *    .seekBefore(3, "abc")
     *    .fetch();
     * </code></pre>
     * <p>
     * The above query will render the following SQL statement:
     * <p>
     * <pre><code>
     * SELECT table.col1, table.col2, ... FROM table
     * WHERE (id, code) &lt; (3, 'abc')
     * ORDER BY id ASC, code ASC
     * </code></pre>
     * <p>
     * The actual row value expression predicate may be expanded into this
     * equivalent predicate:
     * <p>
     * <pre><code>
     * WHERE (id &lt; 3) OR (id = 3 AND code &lt; 'abc')
     * </code></pre>
     * <p>
     * The seek column list length must match the <code>ORDER BY</code> expression
     * list length.
     * <p>
     * <h3><code>NULL</code> handling</h3>
     * <p>
     * <code>NULL</code> handling in the <code>SEEK</code> clause is enabled
     * only for <code>ORDER BY</code> expressions when providing explicit
     * {@link SortField#nullsFirst()} or {@link SortField#nullsLast()} clauses,
     * in case of which the <code>SEEK</code> predicate is always composed of
     * multiple predicates containing {@link Field#isNull()} or
     * {@link Field#isNotNull()}, respectively, never of <code>ROW</code>
     * predicates.
     *
     * @see <a
     *      href="http://use-the-index-luke.com/sql/partial-results/fetch-next-page">http://use-the-index-luke.com/sql/partial-results/fetch-next-page</a>
     * @see <a
     *      href="https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method/">https://blog.jooq.org/faster-sql-paging-with-jooq-using-the-seek-method</a>
     * @deprecated - [#7461] - SEEK BEFORE is not implemented correctly
     */
    @Deprecated
    @NotNull @CheckReturnValue
    @Support
    SelectSeekLimitStep<R> seekBefore(Field<T1> field1, Field<T2> field2, Field<T3> field3, Field<T4> field4, Field<T5> field5, Field<T6> field6, Field<T7> field7, Field<T8> field8, Field<T9> field9, Field<T10> field10, Field<T11> field11);
}