runMigrationCli function

Future<void> runMigrationCli(List<String> arguments, { required MigrationHistory history, required String directory, SchemaSnapshot? schema, MigrationConnection? connect, SchemaRenames renames = const SchemaRenames(), Map<String, Map<String, String>> using = const {}, bool json = true, })

Runs commands against a project's statically imported migration history.

Offline commands never call connect. Database commands close the returned runtime when finished. json selects machine-readable reports; saved schema and migration files remain Dart source. Errors are written to stderr and set the process exit code: 64 for usage errors, 2 for drift, or 1 for failure.

Implementation

Future<void> runMigrationCli(
  List<String> arguments, {
  required MigrationHistory history,
  required String directory,
  SchemaSnapshot? schema,
  MigrationConnection? connect,
  SchemaRenames renames = const SchemaRenames(),
  Map<String, Map<String, String>> using = const {},
  bool json = true,
}) async {
  exitCode = await runMigrationCommand(
    arguments,
    history: history,
    directory: directory,
    schema: schema,
    connect: connect,
    renames: renames,
    using: using,
    json: json,
  );
}