IMigrondi (Migrondi) | Migrondi

IMigrondi Type

Namespace: Migrondi.Core
Assembly: Migrondi.Core.dll
Base Type: obj
All Interfaces: IMigrondi

This is the main service that coordinates all of the other parts of this library. The main purpose of the Migrondi service is to provide a simple and straight forward way to Operate against the databases and the file system.

Instance members

Instance member	Description
`this.DryRunDown` Full Usage: `this.DryRunDown` Parameters: ?amount : `int` - The amount of migrations to roll back Returns: `IReadOnlyList<Migration>` A list of all migrations that would be reverted Modifiers: abstract	Makes a list of the pending migrations that would be reverted ?amount : `int` The amount of migrations to roll back Returns: `IReadOnlyList<Migration>` A list of all migrations that would be reverted
`this.DryRunDownAsync` Full Usage: `this.DryRunDownAsync` Parameters: ?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<Migration>>` Modifiers: abstract	?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<Migration>>`
`this.DryRunUp` Full Usage: `this.DryRunUp` Parameters: ?amount : `int` - The amount of migrations to apply Returns: `IReadOnlyList<Migration>` A list of all migrations that would be applied Modifiers: abstract	Makes a list of the pending migrations that would be applied ?amount : `int` The amount of migrations to apply Returns: `IReadOnlyList<Migration>` A list of all migrations that would be applied
`this.DryRunUpAsync` Full Usage: `this.DryRunUpAsync` Parameters: ?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<Migration>>` Modifiers: abstract	?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<Migration>>`
`this.Initialize` Full Usage: `this.Initialize` Modifiers: abstract
`this.InitializeAsync` Full Usage: `this.InitializeAsync` Parameters: ?cancellationToken : `CancellationToken` Returns: `Task` Modifiers: abstract	?cancellationToken : `CancellationToken` Returns: `Task`
`this.MigrationsList` Full Usage: `this.MigrationsList` Returns: `IReadOnlyList<MigrationStatus>` A list of all migrations and their status Modifiers: abstract	Makes a list of all migrations and their status This method coordinates between the source scripts and the database Returns: `IReadOnlyList<MigrationStatus>` A list of all migrations and their status
`this.MigrationsListAsync` Full Usage: `this.MigrationsListAsync` Parameters: ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<MigrationStatus>>` Modifiers: abstract	?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<MigrationStatus>>`
`this.RunDown` Full Usage: `this.RunDown` Parameters: ?amount : `int` - The amount of migrations to roll back Returns: `IReadOnlyList<MigrationRecord>` A list of all migrations that were reverted including previously applied ones Modifiers: abstract	Reverts all migrations that were previously applied This method coordinates between the source scripts and the database ?amount : `int` The amount of migrations to roll back Returns: `IReadOnlyList<MigrationRecord>` A list of all migrations that were reverted including previously applied ones
`this.RunDownAsync` Full Usage: `this.RunDownAsync` Parameters: ?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<MigrationRecord>>` Modifiers: abstract	?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<MigrationRecord>>`
`this.RunNew` Full Usage: `this.RunNew` Parameters: friendlyName : `string` - The friendly name of the migration, usually this comes from the user's input ?upContent : `string` - The content of the up migration ?downContent : `string` - The content of the down migration Returns: `Migration` The newly created migration as a record Modifiers: abstract	Creates a new migration file with the default naming convention and returns it friendlyName : `string` The friendly name of the migration, usually this comes from the user's input ?upContent : `string` The content of the up migration ?downContent : `string` The content of the down migration Returns: `Migration` The newly created migration as a record
`this.RunNewAsync` Full Usage: `this.RunNewAsync` Parameters: friendlyName : `string` - The friendly name of the migration, usually this comes from the user's input ?upContent : `string` - The content of the up migration ?downContent : `string` - The content of the down migration ?cancellationToken : `CancellationToken` - A cancellation token to cancel the operation Returns: `Task<Migration>` The newly created migration as a record Modifiers: abstract	Creates a new migration file with the default naming convention and returns it friendlyName : `string` The friendly name of the migration, usually this comes from the user's input ?upContent : `string` The content of the up migration ?downContent : `string` The content of the down migration ?cancellationToken : `CancellationToken` A cancellation token to cancel the operation Returns: `Task<Migration>` The newly created migration as a record
`this.RunUp` Full Usage: `this.RunUp` Parameters: ?amount : `int` - The amount of migrations to apply Returns: `IReadOnlyList<MigrationRecord>` A list of all migrations that were applied including previously applied ones Modifiers: abstract	Runs all pending migrations against the database This method coordinates between the source scripts and the database ?amount : `int` The amount of migrations to apply Returns: `IReadOnlyList<MigrationRecord>` A list of all migrations that were applied including previously applied ones
`this.RunUpAsync` Full Usage: `this.RunUpAsync` Parameters: ?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<MigrationRecord>>` Modifiers: abstract	?amount : `int` ?cancellationToken : `CancellationToken` Returns: `Task<IReadOnlyList<MigrationRecord>>`
`this.ScriptStatus` Full Usage: `this.ScriptStatus` Parameters: migrationPath : `string` - The relative path to the migration file Returns: `MigrationStatus` The status of the migration Modifiers: abstract	Takes a relative path to the migrations dir to a migration file and returns its status This method coordinates between the source scripts and the database migrationPath : `string` The relative path to the migration file Returns: `MigrationStatus` The status of the migration
`this.ScriptStatusAsync` Full Usage: `this.ScriptStatusAsync` Parameters: arg0 : `string` ?cancellationToken : `CancellationToken` Returns: `Task<MigrationStatus>` Modifiers: abstract	arg0 : `string` ?cancellationToken : `CancellationToken` Returns: `Task<MigrationStatus>`