org.jooq.WindowSpecificationExcludeStep Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jooq Show documentation
There is a newer version: 3.19.18
/*
 * 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 static org.jooq.SQLDialect.FIREBIRD;
import static org.jooq.SQLDialect.H2;
// ...
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 static org.jooq.SQLDialect.YUGABYTEDB;

import org.jetbrains.annotations.NotNull;

/**
 * An intermediate step in the construction of a {@link WindowSpecification}.
 * 
 * Example: 

 * WindowSpecification spec =
 * DSL.partitionBy(BOOK.AUTHOR_ID)
 *    .orderBy(BOOK.ID)
 *    .rowsBetweenUnboundedPreceding()
 *    .andCurrentRow();
 * 
 * 
 * 
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 WindowSpecificationExcludeStep extends WindowSpecificationFinalStep {

    /**
     * Add an EXCLUDE CURRENT ROW clause.
     */
    @NotNull
    @Support({ H2, POSTGRES, SQLITE, YUGABYTEDB })
    WindowSpecificationFinalStep excludeCurrentRow();

    /**
     * Add an EXCLUDE GROUP clause.
     */
    @NotNull
    @Support({ H2, POSTGRES, SQLITE, YUGABYTEDB })
    WindowSpecificationFinalStep excludeGroup();

    /**
     * Add an EXCLUDE TIES clause.
     */
    @NotNull
    @Support({ H2, POSTGRES, SQLITE, YUGABYTEDB })
    WindowSpecificationFinalStep excludeTies();

    /**
     * Add an EXCLUDE NO OTHERS clause.
     */
    @NotNull
    @Support({ FIREBIRD, H2, MARIADB, MYSQL, POSTGRES, SQLITE, YUGABYTEDB })
    WindowSpecificationFinalStep excludeNoOthers();
}