SchemaBuilder<R> class

Carries the Table reference for a schema under construction. Column builder extensions ($.integer, $.text, etc.) register columns on this builder's table.

Available extensions

• ColumnBuilderProvider

Constructors

SchemaBuilder(Table<Schema<R>, R> table)

Construct a builder for a specific table.

const

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

table → Table<Schema<R>, R>

The table being built.

final

Methods

column<V extends Object, W extends V?>(String name, Field<R, W> field, {String? sqlType, ColumnOr<V>? defaultValue}) → ColumnType<W>

Available on SchemaBuilder<R>, provided by the ColumnBuilderProvider extension

Register a plain column.

custom<I extends Object, O extends Object, W extends I?>(String name, Field<R, W> field, {required ColumnTransformer<I, O> transformer, String? sqlType, ColumnOr<I>? defaultValue}) → ColumnType<W>

Available on SchemaBuilder<R>, provided by the ColumnBuilderProvider extension

Register a column with a custom transformer between the in-memory type I and the SQL storage type O. W is the field value type, so nullability follows the accessor (see column).

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