OrmConfig class final
Project paths, frozen migration history and database connection ownership.
Pass this configuration to the project CLI. The history fixes one database engine; changing a connection URL does not translate migrations.
Constructors
-
OrmConfig({String schema = 'lib/schema.dart', String? output, String migrations = 'migrations', required MigrationHistory history, required SchemaSnapshot snapshot, MigrationConnection? connect, SchemaRenames renames = const SchemaRenames(), Map<
String, Map< using = const {}})String, String> > -
Configures a project without opening a database or executing a migration.
const
Properties
- connect → MigrationConnection?
-
Connection factory for commands that inspect or change a database.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- history → MigrationHistory
-
Statically imported migrations and their reviewed fingerprints.
final
- migrations → String
-
Directory containing reviewed migration files and their static registry.
final
- output → String?
-
Generated client path, or the schema basename with
.orm.dartwhen null.final - renames → SchemaRenames
-
Explicit table and column renames applied when creating a migration.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- schema → String
-
Source declaration read by generation and migration creation.
final
- snapshot → SchemaSnapshot
-
Desired physical schema used by inspection and migration commands.
final
-
using
→ Map<
String, Map< String, String> > -
Table and column conversion expressions for reviewed type changes.
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