ResultSet<Row extends Object, Self extends ResultSet<Row, Self>> mixin

A result set as it appears in the database schema.

Row is the Dart type to represent a value of this result set. Self is the actual subtype.

To read a result set from a row, use DriftRow.readTable.

Implemented types
Available extensions

Properties

alias → String?
When created through withAlias, an alias for this result set.
no setter
aliasOrName → String
If an alias is set, the alias. Otherwise, the entityName for this result set.
no setter
columns → List<SchemaColumn<Object>>
The columns of this result set.
no setter
columnsByName → Map<String, SchemaColumn<Object>>
All columns, indexed by their name.
latefinal
entityName → String
The default name of this result set (if no alias is set).
no setter
hashCode → int
The hash code for this object.
no setteroverride
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

asSelfType() → Self
Type-level hack: Result sets are supposed to inherit from the Self type they declare, so this returns just this.
createMapperFromPositions(DriftDialect dialect, List<ColumnPosition> positions) → Row? Function(RawRow)
Like createMapperToDart, but with positions already resolved.
createMapperToDart(DriftDialect dialect, ResultSetStructure structure) → Row? Function(RawRow)
Creates a function that, when receiving a DriftRow, extracts columns for this result set into the mapped Row type.
mapFromCompanion(Insertable<Row> companion, DriftDialect dialect) → Row
Converts a companion to the real model class, Row.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
statements(DatabaseConnectionUser db) → TableOrViewStatements<Row, RS>

Available on ResultSet<Row, RS>, provided by the GetTableOrViewStatements extension

Creates a TableOrViewStatements instance that can be used to create common select statements on this table or view.
toString() → String
A string representation of this object.
inherited
withAlias(String alias) → Self
Returns a new instance of this result set with alias set to the given value.

Operators

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