Assembly: OptimaJet.Workflow.Migrator

Class Migrator

OptimaJet.Workflow.Migrator.Migrator

Provides methods for running FluentMigrator migrations.

Namespace: OptimaJet.Workflow.Migrator

public static class Migrator

Methods

public static void MigrateUp(WorkflowRuntime runtime) #
Runs migrations for the specified runtime.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The WorkflowEngine runtime instance.
public static void CustomMigrateUp(WorkflowRuntime runtime, Assembly assembly) #
Runs migrations for the specified runtime from the specified assembly.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The WorkflowEngine runtime instance.
assembly
Assembly
The assembly with migrations.
public static IEnumerable<string> GetUnappliedMigrationNames(WorkflowRuntime runtime, Assembly? scanIn = null) #
Get a list of names of not applied SQL scripts.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The WorkflowEngine runtime instance.
scanIn
Assembly
The custom assembly with migrations.

Returns

Type
Description
IEnumerable<String>
The list of script names.
public static IEnumerable<string> GetMigrationNames(WorkflowRuntime runtime, Assembly? scanIn = null) #
Get a list of SQL script names.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The WorkflowEngine runtime instance.
scanIn
Assembly
The custom assembly with migrations.

Returns

Type
Description
IEnumerable<String>
The list of script names.
public static string GetMigrationSql(WorkflowRuntime runtime, string scriptName, Assembly? scanIn = null) #
Get the text of the SQL script.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The WorkflowEngine runtime instance.
scriptName
String
The full name of the SQL script.
scanIn
Assembly
The custom assembly with SQL

Returns

Type
Description
String
The text of the SQL script.
public static IReadOnlyList<MigrationInfo> GetMigrations(WorkflowRuntime runtime, Assembly? scanIn = null) #
Discovers workflow engine migrations in the persistence provider assembly and, optionally, in an additional assembly.

Parameters

Name
Type
Description
runtime
WorkflowRuntime
The WorkflowEngine runtime instance.
scanIn
Assembly
An optional additional assembly to scan for migrations.

Returns

Type
Description
IReadOnlyList<MigrationInfo>
A read-only list of discovered migrations ordered by migration version. Returns an empty list when no migrations are found.