DatabaseDefinition class abstract
Defines the structure of the database used by Serverpod.
- Implemented types
Constructors
-
DatabaseDefinition({String? name, required String moduleName, required List<
TableDefinition> tables, required List<DatabaseMigrationVersion> installedModules, required int migrationApiVersion}) -
factory
-
DatabaseDefinition.fromJson(Map<
String, dynamic> jsonSerialization) -
factory
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
-
installedModules
↔ List<
DatabaseMigrationVersion> -
Modules installed in the database, together with their version. Only
set if known.
getter/setter pair
- migrationApiVersion ↔ int
-
The version of the database definition.
getter/setter pair
- moduleName ↔ String
-
The name of the module that defines the database.
getter/setter pair
- name ↔ String?
-
The name of the database.
Null if the name is not available.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
tables
↔ List<
TableDefinition> -
The tables of the database.
getter/setter pair
Methods
-
copyWith(
{String? name, String? moduleName, List< TableDefinition> ? tables, List<DatabaseMigrationVersion> ? installedModules, int? migrationApiVersion}) → DatabaseDefinition - Returns a shallow copy of this DatabaseDefinition with some or all fields replaced by the given arguments.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
Returns a serialized JSON structure of the model which also includes
fields used by the database.
override
-
toJsonForProtocol(
) → Map< String, dynamic> -
Returns a JSON structure of the model, optimized for Protocol communication.
override
-
toString(
) → String -
A string representation of this object.
override
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited