Sqlite class

An annotation used to specify how a field is serialized. Heavily inspired by JsonKey


Sqlite({Column? columnType, String? defaultValue, bool? enumAsString, String? fromGenerator, bool? ignore, bool? ignoreTo, bool? ignoreFrom, bool? index, String? name, bool? nullable, bool? onDeleteCascade, bool? onDeleteSetDefault, String? toGenerator, bool? unique})
Creates a new Sqlite instance.


columnType Column?
In very exceptional circumstance, the SQLite column type can be declared.
defaultValue String?
The value to use if the source's value is null. This is often directly injected to the adapter, and wrapping is required for strings. (e.g. defaultValue: "'Missing Last Name'")
enumAsString bool
By default, all enums are assumed to be delivered as int. However, this requires order to be maintained; additionally some providers deliver enums as String (e.g. {"party", "baseball", ...}). This field value should apply to Iterable and single field types of enum.
fromGenerator String?
Manipulates output for the field in the deserialize generator. The instance's field name is automatically defined. While the build method is ultimately responsible for how the output is applied, it is most often directly injected as the value of the field in the deserialize adapter.
hashCode int
The hash code for this object.
no setterinherited
ignore bool
true if the generator should ignore this field completely. When true, takes precedence over ignoreFrom and ignoreTo. Defaults to false.
ignoreFrom bool
true if this field should be ignored only during deserializization (when remote data is converted to Dart code). Defaults to false.
ignoreTo bool
true if this field should be ignored only during serializization (when Dart code is sent to a remote source). Defaults to false.
index bool
Create an INDEX on a single column. A UNIQUE index will be created when unique is true. When unique is true and index is absent or false, an index is not created.
name String?
The column name to use when reading and writing values corresponding to the annotated fields.
nullable bool
When false, the column will be inserted as NOT NULL and a value will be required in subsequent operations. Takes precedence over SqliteSerializable's #nullable. Defaults to true.
onDeleteCascade bool
When true, deletion of the referenced record by foreignKeyColumn on the foreignTableName this record. For example, if the foreign table is "departments" and the local table is "employees," whenever that department is deleted, "employee" will be deleted. Defaults false.
onDeleteSetDefault bool
When true, deletion of a parent will set this table's referencing column to the default, usually NULL unless otherwise declared. Defaults false.
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
toGenerator String?
Manipulates output for the field in the SqliteSerializeGenerator The serializing key is defined from Sqlite or the default naming of the field.
unique bool
When true, the column will be inserted with a UNIQUE constraint. Unique columns will also be listed in the adapter for querying if implemented by the invoking provider. Defaults to false. Does not apply to associations.


noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
toString() String
A string representation of this object.


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


defaults → const Sqlite
An instance of Sqlite with all fields set to their default values.