FrameType enum

Describes the type of frame for a window function.

Inheritance
Implemented types
Available extensions

Values

range → const FrameType

A frame that considers a range of values for the provided boundary.

RANGE frames operate based on the values in the ORDER BY clause, not row positions. It includes all rows that fall within the specified value range relative to the current row.

If multiple rows have the same value in the ORDER BY column, they are all included in the frame.

const FrameType._('RANGE')
rows → const FrameType

A frame that considers a number of rows for the provided boundary.

Each row is treated as a separate entity, and the frame is defined by a specific number of rows before or after the current row.

const FrameType._('ROWS')
groups → const FrameType

A frame that considers a number of groups for the provided boundary.

A group is a set of rows that share the same values for every term in the ORDER BY clause. The frame includes a specified number of groups before or after the current group.

const FrameType._('GROUPS')

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
type → String
The string representation of the frame type.
final

Methods

compileWith(StatementCompiler compiler) → void
Compiles this component with the given StatementCompiler by invoking the relevant add method on it.
override
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<FrameType>
A constant List of the values in this enum, in order of their declaration.