org.jooq.Select Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hello-world-plugin Show documentation
Kill Bill Hello World plugin
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 static org.jooq.SQLDialect.CUBRID;
// ...
import static org.jooq.SQLDialect.DERBY;
import static org.jooq.SQLDialect.H2;
// ...
import static org.jooq.SQLDialect.HSQLDB;
// ...
// ...
import static org.jooq.SQLDialect.MARIADB;
import static org.jooq.SQLDialect.MYSQL;
// ...
import static org.jooq.SQLDialect.POSTGRES;
import static org.jooq.SQLDialect.SQLITE;
// ...
// ...
// ...

import java.util.List;

import org.jooq.exception.DataAccessException;

/**
 * A {@link Query} that can provide a {@link Result} after execution
 *
 * @param  The record type being returned by this query
 * @author Lukas Eder
 */
public interface Select extends ResultQuery, TableLike, FieldLike {

    /**
     * Apply the UNION set operation.
     */
    @Support
    Select union(Select select);

    /**
     * Apply the UNION ALL set operation.
     */
    @Support
    Select unionAll(Select select);

    /**
     * Apply the EXCEPT (or MINUS) set operation.
     */
    @Support({ CUBRID, DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    Select except(Select select);

    /**
     * Apply the EXCEPT ALL set operation.
     */
    @Support({ CUBRID, DERBY, HSQLDB, POSTGRES })
    Select exceptAll(Select select);

    /**
     * Apply the INTERSECT set operation.
     */
    @Support({ CUBRID, DERBY, H2, HSQLDB, MARIADB, MYSQL, POSTGRES, SQLITE })
    Select intersect(Select select);

    /**
     * Apply the INTERSECT ALL set operation.
     */
    @Support({ CUBRID, DERBY, HSQLDB, POSTGRES })
    Select intersectAll(Select select);

    /**
     * All fields selected in this query
     */
    List> getSelect();

    /**
     * Execute this query in the context of its attached executor and return a
     * COUNT(*) value.
     * 
     * This wraps a pre-existing SELECT query in another one to
     * calculate the COUNT(*) value, without modifying the original
     * SELECT. An example: 
     * -- Original query:
     * SELECT id, title FROM book WHERE title LIKE '%a%'
     *
     * -- Wrapped query:
     * SELECT count(*) FROM (
     *   SELECT id, title FROM book WHERE title LIKE '%a%'
     * )
     *  This is particularly useful for those databases that do not
     * support the COUNT(*) OVER() window function to calculate
     * total results in paged queries.
     *
     * @return The COUNT(*) result
     * @throws DataAccessException if something went wrong executing the query
     * @deprecated - 3.5.0 - [#3356] - This method is being removed as it is
     *             confusingly different from all the other types of
     *             {@link #fetch()} methods, in that it modifies the original
     *             {@link Select} statement by wrapping it. In particular, this
     *             method can be easily confused with {@link #fetch(Field)}, or
     *             more concretely fetch(count()), which has an
     *             entirely different semantics. Use
     *             {@link DSLContext#fetchCount(Select)} instead.
     */
    @Deprecated
    int fetchCount() throws DataAccessException;
}