View Source

Class AsyncMigrationBase

Provides a base class to all migrations.

Inheritance

object

Namespace: Umbraco.Cms.Infrastructure.Migrations

Assembly: Umbraco.Infrastructure.dll

Syntax

public abstract class AsyncMigrationBase : IDiscoverable

Constructors

AsyncMigrationBase(IMigrationContext)

Initializes a new instance of the AsyncMigrationBase class.

Declaration

protected AsyncMigrationBase(IMigrationContext context)

Parameters

Type	Name	Description
IMigrationContext	context	A migration context.

Properties

Alter

Builds an Alter expression.

Declaration

public IAlterBuilder Alter { get; }

Property Value

Type	Description
IAlterBuilder

Context

Gets the migration context.

Declaration

protected IMigrationContext Context { get; }

Property Value

Type	Description
IMigrationContext

Create

Builds a Create expression.

Declaration

public ICreateBuilder Create { get; }

Property Value

Type	Description
ICreateBuilder

Database

Gets the database instance.

Declaration

protected IUmbracoDatabase Database { get; }

Property Value

Type	Description
IUmbracoDatabase

DatabaseType

Gets the database type.

Declaration

protected DatabaseType DatabaseType { get; }

Property Value

Type	Description
DatabaseType

Delete

Builds a Delete expression.

Declaration

public IDeleteBuilder Delete { get; }

Property Value

Type	Description
IDeleteBuilder

Execute

Builds an Execute expression.

Declaration

public IExecuteBuilder Execute { get; }

Property Value

Type	Description
IExecuteBuilder

Insert

Builds an Insert expression.

Declaration

public IInsertBuilder Insert { get; }

Property Value

Type	Description
IInsertBuilder

InvalidateBackofficeUserAccess

If this is set to true, all back-office client tokens will be revoked upon successful completion of the migration.

Declaration

public bool InvalidateBackofficeUserAccess { get; set; }

Property Value

Type	Description
bool

Logger

Gets the logger.

Declaration

protected ILogger Logger { get; }

Property Value

Type	Description
ILogger

RebuildCache

If this is set to true, the published cache will be rebuild upon successful completion of the migration.

Declaration

public bool RebuildCache { get; set; }

Property Value

Type	Description
bool

Rename

Builds a Rename expression.

Declaration

public IRenameBuilder Rename { get; }

Property Value

Type	Description
IRenameBuilder

SqlSyntax

Gets the SQL syntax.

Declaration

protected ISqlSyntaxProvider SqlSyntax { get; }

Property Value

Type	Description
ISqlSyntaxProvider

Update

Builds an Update expression.

Declaration

public IUpdateBuilder Update { get; }

Property Value

Type	Description
IUpdateBuilder

Methods

AddColumnIfNotExists<T>(IEnumerable<ColumnInfo>, string)

Declaration

protected void AddColumnIfNotExists<T>(IEnumerable<ColumnInfo> columns, string columnName)

Parameters

Type	Name	Description
IEnumerable<ColumnInfo>	columns
string	columnName

Type Parameters

Name	Description
T

AddColumnIfNotExists<T>(IEnumerable<ColumnInfo>, string, string)

Declaration

protected void AddColumnIfNotExists<T>(IEnumerable<ColumnInfo> columns, string tableName, string columnName)

Parameters

Type	Name	Description
IEnumerable<ColumnInfo>	columns
string	tableName
string	columnName

Type Parameters

Name	Description
T

AddColumn<T>(string)

Declaration

protected void AddColumn<T>(string columnName)

Parameters

Type	Name	Description
string	columnName

Type Parameters

Name	Description
T

AddColumn<T>(string, out IEnumerable<string>)

Declaration

protected void AddColumn<T>(string columnName, out IEnumerable<string> sqls)

Parameters

Type	Name	Description
string	columnName
IEnumerable<string>	sqls

Type Parameters

Name	Description
T

AddColumn<T>(string, string)

Declaration

protected void AddColumn<T>(string tableName, string columnName)

Parameters

Type	Name	Description
string	tableName
string	columnName

Type Parameters

Name	Description
T

AddColumn<T>(string, string, out IEnumerable<string>)

Declaration

protected void AddColumn<T>(string tableName, string columnName, out IEnumerable<string> sqls)

Parameters

Type	Name	Description
string	tableName
string	columnName
IEnumerable<string>	sqls

Type Parameters

Name	Description
T

AlterColumn<T>(string, string)

Declaration

protected void AlterColumn<T>(string tableName, string columnName)

Parameters

Type	Name	Description
string	tableName
string	columnName

Type Parameters

Name	Description
T

ColumnExists(string, string)

Declaration

protected bool ColumnExists(string tableName, string columnName)

Parameters

Type	Name	Description
string	tableName
string	columnName

Returns

Type	Description
bool

ColumnType(string, string)

Declaration

protected string? ColumnType(string tableName, string columnName)

Parameters

Type	Name	Description
string	tableName
string	columnName

Returns

Type	Description
string

CreateIndex<T>(string)

Declaration

protected void CreateIndex<T>(string toCreate)

Parameters

Type	Name	Description
string	toCreate

Type Parameters

Name	Description
T

DeleteIndex<T>(string)

Declaration

protected void DeleteIndex<T>(string toDelete)

Parameters

Type	Name	Description
string	toDelete

Type Parameters

Name	Description
T

IndexExists(string)

Declaration

protected bool IndexExists(string indexName)

Parameters

Type	Name	Description
string	indexName

Returns

Type	Description
bool

MigrateAsync()

Executes the migration.

Declaration

protected abstract Task MigrateAsync()

Returns

Type	Description
Task

PrimaryKeyExists(string, string)

Declaration

protected bool PrimaryKeyExists(string tableName, string primaryKeyName)

Parameters

Type	Name	Description
string	tableName
string	primaryKeyName

Returns

Type	Description
bool

ReplaceColumn<T>(string, string, string)

Declaration

protected void ReplaceColumn<T>(string tableName, string currentName, string newName)

Parameters

Type	Name	Description
string	tableName
string	currentName
string	newName

Type Parameters

Name	Description
T

RunAsync()

Runs the migration.

Declaration

public Task RunAsync()

Returns

Type	Description
Task

Sql()

Creates a new Sql statement.

Declaration

protected Sql<ISqlContext> Sql()

Returns

Type	Description
Sql<ISqlContext>

Sql(string, params object[])

Creates a new Sql statement with arguments.

Declaration

protected Sql<ISqlContext> Sql(string sql, params object[] args)

Parameters

Type	Name	Description
string	sql
object[]	args

Returns

Type	Description
Sql<ISqlContext>

TableExists(string)

Declaration

protected bool TableExists(string tableName)

Parameters

Type	Name	Description
string	tableName

Returns

Type	Description
bool