DateTimeModifier class Null safety

DateTime modifier constants.

These modifiers are used on DateTimeExpressions.modify and DateTimeExpressions.modifyAll to apply transformations on date time values.

For instance, DateTimeModifier.days can be used to add or subtract calendar days from a date time value. Note that this is different from just subtracting a duration with DateTimeExpressions.+, which only adds a duration as seconds without respecting calendar units.

For another explanation of modifiers, see the sqlite3 docs.

Inheritance

• Object
• Expression<String>
• Constant<String>
• DateTimeModifier

Available Extensions

• ArithmeticAggregates
• ArithmeticExpr
• BaseAggregate
• ComparableExpr
• DriftNativeStringExtensions
• JsonExtensions
• StringExpressionOperators

Constructors

DateTimeModifier.days(int days)

Adds or subtracts days calendar days from the date time value.

const

DateTimeModifier.hours(int hours)

Adds or subtracts hours hours from this date time value.

const

DateTimeModifier.localTime()

Move a date time that is in UTC to the local time zone.

const

DateTimeModifier.minutes(int minutes)

Adds or subtracts minutes minutes from this date time value.

const

DateTimeModifier.months(int months)

Adds or subtracts months months from this date time value.

const

DateTimeModifier.seconds(num seconds)

Adds or subtracts seconds seconds from this date time value.

const

DateTimeModifier.startOfDay()

The "start of day" modifier shifts the date backwards to the beginning of the day.

const

DateTimeModifier.startOfMonth()

The "start of month" modifier shifts the date backwards to the beginning of the month.

const

DateTimeModifier.startOfYear()

The "start of year" modifier shifts the date backwards to the beginning of the year.

const

DateTimeModifier.utc()

Move a date time that is in the local time zone back to UTC.

const

DateTimeModifier.weekday(int weekday)

The "weekday" modifier shifts the date forward to the next date where the weekday is the weekday provided here.

DateTimeModifier.years(int years)

Adds or subtracts years years from this date time value.

const

Properties

driftSqlType → DriftSqlType<String>

The supported DriftSqlType backing this expression.

read-only, inherited

hashCode → int

The hash code for this object.

read-only, inherited

isLiteral → bool

Whether this expression is a literal. Some use-sites need to put parentheses around non-literals.

read-only, inherited

precedence → Precedence

The precedence of this expression. This can be used to automatically put parentheses around expressions as needed.

read-only, inherited

runtimeType → Type

A representation of the runtime type of the object.

read-only, inherited

value → String?

The value that will be converted to an sql literal.

final, inherited

Methods

caseMatch<T extends Object>({required Map<Expression<String>, Expression<T>> when, Expression<T>? orElse}) → Expression<T>

A CASE WHEN construct using the current expression as a base.

inherited

cast<D2 extends Object>() → Expression<D2>

Generates a CAST(expression AS TYPE) expression.

inherited

dartCast<D2 extends Object>() → Expression<D2>

Casts this expression to an expression of D.

inherited

equals(String compare) → Expression<bool>

Whether this column is equal to the given value, which must have a fitting type. The compare value will be written as a variable using prepared statements, so there is no risk of an SQL-injection.

inherited

equalsExp(Expression<String> compare) → Expression<bool>

Whether this expression is equal to the given expression.

inherited

equalsNullable(String? compare) → Expression<bool>

Compares the value of this column to compare or null.

inherited

iif<T extends Object>(Expression<bool> predicate, Expression<T> ifFalse) → Expression<T>

Evaluates to this if predicate is true, otherwise evaluates to ifFalse.

inherited

isExp(Expression<String> other) → Expression<bool>

Generates an IS expression in SQL, comparing this expression with the other expression.

inherited

isIn(Iterable<String> values) → Expression<bool>

An expression that is true if this resolves to any of the values in values.

inherited

isInQuery(BaseSelectStatement select) → Expression<bool>

An expression checking whether this is included in any row of the provided select statement.

inherited

isNotExp(Expression<String> other) → Expression<bool>

Generates an IS NOT expression in SQL, comparing this expression with the other expression.

inherited

isNotIn(Iterable<String> values) → Expression<bool>

An expression that is true if this does not resolve to any of the values in values.

inherited

isNotInQuery(BaseSelectStatement select) → Expression<bool>

An expression checking whether this is not included in any row of the provided select statement.

inherited

isNotNull() → Expression<bool>

Expression that is true if the inner expression resolves to a non-null value.

inherited

isNotValue(String value) → Expression<bool>

Generates an IS NOT expression in SQL, comparing this expression with the Dart value.

inherited

isNull() → Expression<bool>

Expression that is true if the inner expression resolves to a null value.

inherited

isValue(String value) → Expression<bool>

Generates an IS expression in SQL, comparing this expression with the Dart value.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a non-existent method or property is accessed.

inherited

nullIf(Expression<String> matcher) → Expression<String>

Returns null if matcher is equal to this expression, this otherwise.

inherited

toString() → String

A string representation of this object.

inherited

writeAroundPrecedence(GenerationContext context, Precedence precedence) → void

Writes this expression into the GenerationContext, assuming that there's an outer expression with precedence. If the Expression.precedence of this expression is lower, it will be wrap}ped in

inherited

writeInner(GenerationContext ctx, Expression<Object> inner) → void

If this Expression wraps an inner expression, this utility method can be used inside writeInto to write that inner expression while wrapping it in parentheses if necessary.

inherited

writeInto(GenerationContext context) → void

Writes this component into the context by writing to its GenerationContext.buffer or by introducing bound variables. When writing into the buffer, no whitespace around the this component should be introduced. When a component consists of multiple composed component, it's responsible for introducing whitespace between its child components.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited