org.jooq.WindowDefinition 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
*
* 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.jooq.impl.QOM;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.jetbrains.annotations.ApiStatus.Experimental;
/**
* A window definition.
*
* Window definitions can be
*
* - declared in the
WINDOW clause (see
* {@link SelectWindowStep#window(WindowDefinition...)}
* - referenced from the
OVER clause (see
* {@link AggregateFunction#over(WindowDefinition)}
*
*
* The WINDOW clause is only natively supported by
*
* - {@link SQLDialect#AURORA_POSTGRES}
* - {@link SQLDialect#H2}
* - {@link SQLDialect#MYSQL}
* - {@link SQLDialect#POSTGRES}
* - {@link SQLDialect#SQLITE}
* - {@link SQLDialect#SYBASE}
*
*
* If your database supports window functions, but not the WINDOW
* clause, jOOQ will inline window definitions into their respective window
* functions.
*
* Instances can be created using {@link Name#as(WindowSpecification)} and
* overloads.
*
* @author Lukas Eder
*/
public interface WindowDefinition extends WindowSpecificationOrderByStep {
// -------------------------------------------------------------------------
// XXX: Query Object Model
// -------------------------------------------------------------------------
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@NotNull Name $name();
/**
* Experimental query object model accessor method, see also {@link QOM}.
* Subject to change in future jOOQ versions, use at your own risk.
*/
@Experimental
@Nullable WindowSpecification $windowSpecification();
}