Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

FluentMigratorHelper

Contains functions to run FluentMigrator

Nested types and modules

TypeDescription
DatabaseConnection
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Database connection configuration

DatabaseProvider
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Fluent Migrator SQL syntax provider

DatabaseTask
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Database operation to execute

FakeAnnouncer
MigrationOptions
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Fluent Migrator options

MigrationRunningMode
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Fluent Migrator execution mode

OracleVersion
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Oracle database driver version

SqlServerVersion
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

MS SQL Server driver version

Functions and values

Function or valueDescription
createAnnouncer(...)
Signature: outputFileName:string -> verbose:bool -> provider:DatabaseProvider -> IAnnouncer * StreamWriter
DefaultMigrationOptions
Signature: MigrationOptions
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Default migration options

ExecuteDatabaseTask(...)
Signature: task:DatabaseTask -> assemblies:seq<string> -> options:MigrationOptions -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Executes the specified task using configuration options

Parameters

  • task - Database task to execute
  • assemblies - Assembly files which contain migrations
  • options - Migration options which are passed to FluentMigrator
getModeFromTask(task)
Signature: task:DatabaseTask -> MigrationRunningMode option
getProviderFromConnection(connection)
Signature: connection:DatabaseConnection -> DatabaseProvider
getProviderFromMode(mode)
Signature: mode:MigrationRunningMode -> DatabaseProvider
getProviderFromTask(task)
Signature: task:DatabaseTask -> DatabaseProvider
getProviderName(provider)
Signature: provider:DatabaseProvider -> string
horizontalRule
Signature: string
ListAppliedMigrations(...)
Signature: connection:DatabaseConnection -> assemblies:seq<string> -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Lists all migrations which were applied to the database - connection - Database connection - assemblies - Assembly files which contain migrations

MigrateDown(...)
Signature: version:int64 -> connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Migrates database up to the specified version

Parameters

  • version - Target version
  • connection - Database connection
  • assemblies - Assembly files which contain migrations
  • options - Migration options which are passed to FluentMigrator
MigrateToLatest(...)
Signature: connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Migrates database up to the latest version

Parameters

  • connection - Database connection
  • assemblies - Assembly files which contain migrations
  • options - Migration options which are passed to FluentMigrator
MigrateUp(...)
Signature: version:int64 -> connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Migrates database up to the specified version

Parameters

  • version - Target version
  • connection - Database connection
  • assemblies - Assembly files which contain migrations
  • options - Migration options which are passed to FluentMigrator
Rollback(...)
Signature: steps:int -> connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Rollbacks several applied migrations

Parameters

  • steps - Number of migrations to rollback
  • connection - Database connection
  • assemblies - Assembly files which contain migrations
  • options - Migration options which are passed to FluentMigrator
RollbackLatest(...)
Signature: connection:DatabaseConnection -> assemblies:seq<string> -> options:MigrationOptions -> unit
Attributes:
[<Obsolete("This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.")>]
OBSOLETE

This API is obsolete. There is no alternative in FAKE 5 yet. You can help by porting this module.

Rollbacks latest applied migration - connection - Database connection - assemblies - Assembly files which contain migrations - options - Migration options which are passed to FluentMigrator

setupConnection context connection
Signature: context:IRunnerContext -> connection:DatabaseConnection -> unit
setupConnectionForMode context mode
Signature: context:IRunnerContext -> mode:MigrationRunningMode -> unit
toRunnerContext task assemblies options
Signature: task:DatabaseTask -> assemblies:'?8319 -> options:MigrationOptions -> RunnerContext * StreamWriter
Type parameters: '?8319
validate(assemblies)
Signature: assemblies:'?8309 -> unit
Type parameters: '?8309, '?8310