OrderDirection enum

The direction of the "order by" clause of a select operation.

Used by the orderDirection parameter of the select* methods. Only has effect while the ordering is active (see the orderByID parameter and resolveOrderByID).

Inheritance
Available extensions

Values

ascending → const OrderDirection

Ascending order (SQL ASC). The defaultDirection.

descending → const OrderDirection

Descending order (SQL DESC).

Properties

hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
isAscending → bool
Returns true if this is ascending.
no setter
isDescending → bool
Returns true if this is descending.
no setter
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
sqlKeyword → String
The SQL keyword of this direction: ASC or DESC.
no setter

Methods

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

Static Methods

parse(Object? o) → OrderDirection?
Parses o to an OrderDirection, or returns null if it can't be resolved.
resolve(OrderDirection? direction) → OrderDirection
Resolves a nullable direction to a non-null one, defaulting to defaultDirection.
resolveOrderByID(bool? orderByID, int? offset, [int? limit]) → bool
Resolves if a select operation should order by the table ID column.

Constants

defaultDirection → const OrderDirection
The direction used when none is defined: ascending.
values → const List<OrderDirection>
A constant List of the values in this enum, in order of their declaration.