MssqlDateBucket class

Fixed-width DATE_BUCKET groups from an optional origin.

Requires SQL Server 2022 at compatibility level 160. No fallback is used because alternate arithmetic can produce different boundaries.

Inheritance

• Object
• MssqlExpression
• MssqlDateBucket

Implemented types

• MssqlTypedExpression

Mixed-in types

• MssqlTemporalExpression
• MssqlStableExpression

Available extensions

• MssqlExpressionOperators
• MssqlSubqueryExpressionOperators
• MssqlTemporalOperators

Annotations

• @immutable

Constructors

MssqlDateBucket(MssqlExpression operand, {required MssqlDateBucketUnit unit, required int width, DateTime? origin, Duration? zoneOffset})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

operand → MssqlExpression

final

origin → DateTime?

Where the counting starts. Null leaves SQL Server's 1900-01-01.

final

resultType → MssqlColumnType?

The operand's own type: DATE_BUCKET returns what it was given.

no setter, override

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

unit → MssqlDateBucketUnit

final

width → int

How many units one bucket spans.

final

zoneOffset → Duration?

The offset origin is read in, for a datetimeoffset operand.

final

Methods

as(String alias) → MssqlAliased

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Gives this expression a result alias.

asc({MssqlNulls? nulls}) → MssqlOrder

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Orders by this expression, ascending.

between(Object? lower, Object? upper) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

betweenColumns(String lower, String upper) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

BETWEEN two other columns rather than two values.

compile(MssqlParameterAllocator parameters, MssqlDialect dialect) → String

Writes this expression's SQL, binding any values through parameters.

inherited

compileStable(MssqlParameterAllocator parameters, MssqlDialect dialect) → String

Writes the SQL. Called at most once per statement.

override

dateBucket({required MssqlDateBucketUnit unit, required int width, DateTime? origin, Duration? zoneOffset}) → MssqlExpression

Available on MssqlTemporalExpression, provided by the MssqlTemporalOperators extension

This value snapped back to a fixed-width bucket: DATE_BUCKET.

desc({MssqlNulls? nulls}) → MssqlOrder

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Orders by this expression, descending.

eq(Object? value) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

eqCol(String identifier) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Compares this expression to another column rather than to a value.

eqExpr(MssqlExpression other) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Compares this expression to another expression.

gt(Object? value) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

gte(Object? value) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

inList(Iterable<Object?> values) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

inQuery(MssqlSelectQuery query) → MssqlCondition

Available on MssqlExpression, provided by the MssqlSubqueryExpressionOperators extension

inYear(int year, {MssqlOperator operator = MssqlOperator.eq, Duration? zoneOffset}) → MssqlCondition

Available on MssqlTemporalExpression, provided by the MssqlTemporalOperators extension

Every row whose value falls in year, as a half-open range.

isNotNull() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

isNull() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

lt(Object? value) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

lte(Object? value) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

monthStart() → MssqlExpression

Available on MssqlTemporalExpression, provided by the MssqlTemporalOperators extension

This value snapped back to the first day of its month, as a date.

ne(Object? value) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notBetween(Object? lower, Object? upper) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

notBetweenColumns(String lower, String upper) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

notInList(Iterable<Object?> values) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

notInQuery(MssqlSelectQuery query) → MssqlCondition

Available on MssqlExpression, provided by the MssqlSubqueryExpressionOperators extension

onDate(DateTime day, {MssqlOperator operator = MssqlOperator.eq, Duration? zoneOffset}) → MssqlCondition

Available on MssqlTemporalExpression, provided by the MssqlTemporalOperators extension

Every row whose value falls on the calendar day day, as a half-open range.

toString() → String

A string representation of this object.

inherited

truncatedTo(MssqlTemporalGrain grain) → MssqlExpression

Available on MssqlTemporalExpression, provided by the MssqlTemporalOperators extension

This value snapped back to the start of its grain.

whereAfterToday() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereBeforeToday() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereDate(Object? value, [MssqlOperator operator = MssqlOperator.eq]) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Compares the date alone, so the whole day matches rather than midnight.

whereDay(int value, [MssqlOperator operator = MssqlOperator.eq]) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereFuture() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereMonth(int value, [MssqlOperator operator = MssqlOperator.eq]) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereNowOrFuture() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereNowOrPast() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

wherePast() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Strictly earlier than now, again by the server's clock.

whereTime(Object? value, [MssqlOperator operator = MssqlOperator.eq]) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Compares the time of day, with the date discarded.

whereToday() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

The date part equals today, as the server reckons it.

whereTodayOrAfter() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereTodayOrBefore() → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

whereYear(int value, [MssqlOperator operator = MssqlOperator.eq]) → MssqlCondition

Available on MssqlExpression, provided by the MssqlExpressionOperators extension

Operators

operator ==(Object other) → bool

The equality operator.

inherited