ColumnDescription class

Description of a single table column.

Constructors

ColumnDescription({required String name, required String postgresFormat, required ColumnTypeKind typeKind, required bool isRequired, required bool hasDefault, required bool isNullable, bool isReadOnly = false, ColumnTypeKind? elementTypeKind, ColumnTypeKind? boundTypeKind, List<String>? enumValues, ForeignKeyDescription? foreignKey, String? comment})
const

Properties

boundTypeKind → ColumnTypeKind?
The kind of Dart type of the bounds for ColumnTypeKind.range columns.
final
comment → String?
The column comment, when one is set.
final
elementTypeKind → ColumnTypeKind?
The kind of Dart type of the array elements for ColumnTypeKind.array columns.
final
enumValues → List<String>?
The values of the Postgres enum for enum columns.
final
foreignKey → ForeignKeyDescription?
The referenced table and column for foreign key columns.
final
hasDefault → bool
Whether the column has a database default.
final
hashCode → int
The hash code for this object.
no setterinherited
isNullable → bool
Whether the column can be null in query results.
final
isReadOnly → bool
Whether the column can never be written, because it is a GENERATED ALWAYS identity, a generated column, or a column the database reports as not updatable, such as a computed column of an otherwise writable view. Read-only columns appear in the row type but not in the insert and update value types.
final
isRequired → bool
Whether the column is NOT NULL without a database default, which makes it required on insert.
final
name → String
Name of the column in the database.
final
postgresFormat → String
The Postgres type, for example int8, _text or public.mood.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
typeKind → ColumnTypeKind
The kind of Dart type the column maps to.
final

Methods

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