Top Description Methods
org.jooq

public Interface WindowSpecification

extends QueryPart
Known Direct Subinterfaces
org.jooq.WindowSpecificationFinalStep
Imports
org.jooq.impl.DSL, .QOM, .QOM.FrameExclude, .QOM.FrameUnits, .QOM.UnmodifiableList, org.jetbrains.annotations.NotNull, .Nullable, .ApiStatus.Experimental

A window specification.

Window specifications are the syntactic clauses that can be passed to both window definitions in WINDOW clauses, as well as to the OVER clause of window functions. This makes window specifications highly reusable across several queries.

Example:


WindowSpecification spec =
DSL.partitionBy(BOOK.AUTHOR_ID)
   .orderBy(BOOK.ID)
   .rowsBetweenUnboundedPreceding()
   .andCurrentRow();

Instances can be created using DSL#partitionBy(GroupField...), DSL#orderBy(OrderField...), and overloads as well as rows / range / groups related methods in DSL.

Author
Lukas Eder

Method Summary

Modifier and TypeMethod and Description
public @Nullable QOM.FrameExclude
$exclude()

Experimental query object model accessor method, see also QOM.

public @Nullable Integer
$frameEnd()

Experimental query object model accessor method, see also QOM.

public @Nullable Integer
$frameStart()

Experimental query object model accessor method, see also QOM.

public @Nullable QOM.FrameUnits
$frameUnits()

Experimental query object model accessor method, see also QOM.

public @NotNull QOM.UnmodifiableList<? extends SortField<?>>
$orderBy()

Experimental query object model accessor method, see also QOM.

public @NotNull QOM.UnmodifiableList<? extends GroupField>
$partitionBy()

Experimental query object model accessor method, see also QOM.

public @Nullable WindowDefinition
$windowDefinition()

Deprecated as a consequence of WindowDefinition being deprecated.
Experimental query object model accessor method, see also QOM.
Inherited from org.jooq.QueryPart:
equalshashCodetoString

Method Detail

$excludeback to summary
public @Nullable QOM.FrameExclude $exclude()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@Nullable
$frameEndback to summary
public @Nullable Integer $frameEnd()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@Nullable
$frameStartback to summary
public @Nullable Integer $frameStart()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@Nullable
$frameUnitsback to summary
public @Nullable QOM.FrameUnits $frameUnits()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@Nullable
$orderByback to summary
public @NotNull QOM.UnmodifiableList<? extends SortField<?>> $orderBy()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@NotNull
$partitionByback to summary
public @NotNull QOM.UnmodifiableList<? extends GroupField> $partitionBy()

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@NotNull
$windowDefinitionback to summary
public @Nullable WindowDefinition $windowDefinition()

Deprecated

as a consequence of WindowDefinition being deprecated. See corresponding docs for further information.

Experimental query object model accessor method, see also QOM. Subject to change in future jOOQ versions, use at your own risk.

Annotations
@Experimental
@Nullable