flyway CLI reference

ModularPipelines.Flyway provides strongly typed access to the flyway CLI.

Installation

dotnet add package ModularPipelines.Flyway

Resolve the service with context.Tools.Flyway. For projects older than C# 14, import ModularPipelines.Flyway.Extensions and use the context.Flyway() extension method as a compatibility fallback.

Module example

using ModularPipelines.Context;
using ModularPipelines.Models;
using ModularPipelines.Modules;
using ModularPipelines.Flyway.Options;

public class RunCommandModule : Module<CommandResult>
{
    protected override async Task<CommandResult> ExecuteAsync(
        IModuleContext context,
        CancellationToken cancellationToken)
    {
        return await context.Tools.Flyway.InfoAsync(
            new FlywayInfoOptions(),
            cancellationToken: cancellationToken);
    }
}

Commands

CLI command	Options record
flyway baseline	FlywayBaselineOptions
flyway check	FlywayCheckOptions
flyway clean	FlywayCleanOptions
flyway deploy	FlywayDeployOptions
flyway info	FlywayInfoOptions
flyway init	FlywayInitOptions
flyway list-engines	FlywayListEnginesOptions
flyway migrate	FlywayMigrateOptions
flyway prepare	FlywayPrepareOptions
flyway repair	FlywayRepairOptions
flyway snapshot	FlywaySnapshotOptions
flyway validate	FlywayValidateOptions