OrderingTerm class final

A single term in a OrderBy clause. The priority of this term is determined by its position in OrderBy.terms.

Implemented types

Constructors

OrderingTerm({required Expression<Object> expression, OrderingMode mode = OrderingMode.asc, NullsOrder? nulls})
Creates an ordering term by the expression, the mode (defaults to ascending) and the nulls.
OrderingTerm.asc(Expression<Object> expression, {NullsOrder? nulls})
Creates an ordering term that sorts for ascending values of expression and the nulls.
factory
OrderingTerm.desc(Expression<Object> expression, {NullsOrder? nulls})
Creates an ordering term that sorts for descending values of expression and the nulls.
factory
OrderingTerm.random()
Creates an ordering term that sorts rows in a random order using sqlite random function.
factory

Properties

expression → Expression<Object>
The expression with which different rows should be compared.
final
hashCode → int
The hash code for this object.
no setterinherited
mode → OrderingMode
The ordering mode (ascending or descending).
final
nulls → NullsOrder?
How to order NULLs. When nulls is null, then it's ignored.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

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