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.

RoundhouseParams

Parameter type to configure the RoundhousE runner

Record Fields

Record FieldDescription
AlterDatabaseFolderName
Signature: string

The name of the folder where you keep your alter database scripts. Read up on token replacement. You will want to use {{DatabaseName}} here instead of specifying a database name.

CommandTimeout
Signature: int

This is the timeout when commands are run. This is not for admin commands or restore.

CommandTimeoutAdmin
Signature: int

This is the timeout when administration commands are run (except for restore, which has its own).

ConnectionString
Signature: string

As an alternative to ServerName and Database - You can provide an entire connection string instead.

ConnectionStringAdmin
Signature: string

This is used for connecting to master when you may have a different uid and password than normal.

CustomCreateScript
Signature: string

This instructs RH to use this script for creating a database instead of the default based on the SQLType.

DatabaseName
Signature: string

The database you want to create/migrate.

DatabaseType
Signature: string

Database Type (fully qualified class name implementing [roundhouse.sql.Database, roundhouse])

Drop
Signature: bool

This instructs RH to remove a database and not run migration scripts.

Environment
Signature: string

This allows RH to be environment aware and only run scripts that are in a particular environment based on the namingof the script. LOCAL.something.ENV.sql would only be run in the LOCAL environment.

FunctionsFolderName
Signature: string

The name of the folder where you keep your functions.

IndexesFolderName
Signature: string

The name of the folder where you keep your indexes.

OutputPath
Signature: string

Output path. Path to where migration artifacts are stored.

PermissionsFolderName
Signature: string

The name of the folder where you keep your permissions scripts.

RepositoryPath
Signature: string

Path to code repository to be able to correlate versions

Restore
Signature: bool

This instructs RH to do a restore (with the restorefrompath parameter) of a database before running migration scripts.

RestoreFilePath
Signature: string

File path of back when Restore is set to true

RunAfterCreateDatabaseFolderName
Signature: string

The name of the folder where you will keep scripts that ONLY run after a database is created.

RunAfterOtherAnyTimeScriptsFolderName
Signature: string

The name of the folder where you keep scripts that will be run after all of the other any time scripts complete.

RunBeforeUpFolderName
Signature: string

The name of the folder where you keep scripts that you want to run before your update scripts.

RunFirstAfterUpdateFolderName
Signature: string

The name of the folder where you keep any functions, views, or sprocs that are order dependent. If you have a function that depends on a view, you definitely need the view in this folder.

SchemaName
Signature: string

The schema where RH stores it's tables

ServerDatabase
Signature: string

The server and instance you would like to run on. (local) and (local)\SQL2008 are both valid values.

Silent
Signature: bool

Tells RH not to ask for any input when it runs.

Simple
Signature: bool

This instructs RH to set the database recovery mode to simple recovery. Only works with SqlServer.

SprocsFolderName
Signature: string

The name of the folder where you keep your stored procedures.

SqlFilesDirectory
Signature: string

The directory where your SQL scripts are.

TimeOut
Signature: TimeSpan

A timeout for the runner.

ToolPath
Signature: string

FileName of the Roundhouse runner.

UpFolderName
Signature: string

The name of the folder where you keep your update scripts.

VersionFile
Signature: string

Path to the file to use for versioning. Either a .XML file, a .DLL or a .TXT file that a version can be resolved from.

VersionXPath
Signature: string

Works in conjunction with an XML version file.

ViewsFolderName
Signature: string

The name of the folder where you keep your views.

WarnOnOneTimeScriptChanges
Signature: bool

Instructs RH to execute changed one time scripts (DDL/DML in Up folder) that have previously been run against the database instead of failing. A warning is logged for each one time scripts that is rerun.

WithTransaction
Signature: bool

This instructs RH to run inside of a transaction.

WorkingDir
Signature: string

Working directory (optional).