Interface IMigrationProcessor

Interface for a migration processor

Inherited Members

IQuerySchema.DatabaseType

IQuerySchema.DatabaseTypeAliases

IQuerySchema.SchemaExists(string)

IQuerySchema.TableExists(string, string)

IQuerySchema.ColumnExists(string, string, string)

IQuerySchema.ConstraintExists(string, string, string)

IQuerySchema.IndexExists(string, string, string)

IQuerySchema.SequenceExists(string, string)

IQuerySchema.DefaultValueExists(string, string, string, object)

IDisposable.Dispose()

Namespace: FluentMigrator

Assembly: FluentMigrator.Abstractions.dll

Syntax

public interface IMigrationProcessor : IQuerySchema, IDisposable

Remarks

A migration processor generates the SQL statements using a IMigrationGenerator and executes it using the given connection string.

Properties

ConnectionString

Gets the connection string

Declaration

[Obsolete]
string ConnectionString { get; }

Property Value

Type	Description
string

Options

Gets the migration processor options

Declaration

[Obsolete]
IMigrationProcessorOptions Options { get; }

Property Value

Type	Description
IMigrationProcessorOptions

Methods

BeginTransaction()

Begins a transaction

Declaration

void BeginTransaction()

CommitTransaction()

Commits a transaction

Declaration

void CommitTransaction()

Execute(string)

Execute an SQL statement (escaping not needed)

Declaration

void Execute(string sql)

Parameters

Type	Name	Description
string	sql	The SQL statement

Execute(string, params object[])

Execute an SQL statement

Declaration

void Execute(string template, params object[] args)

Parameters

Type	Name	Description
string	template	The SQL statement
object[]	args	The arguments to replace in the SQL statement

Exists(string, params object[])

Returns true if data could be found for the given SQL query

Declaration

bool Exists(string template, params object[] args)

Parameters

Type	Name	Description
string	template	The SQL query
object[]	args	The arguments of the SQL query

Returns

Type	Description
bool	true when the SQL query returned data

Process(AlterColumnExpression)

Executes a ALTER TABLE ALTER COLUMN SQL expression

Declaration

void Process(AlterColumnExpression expression)

Parameters

Type	Name	Description
AlterColumnExpression	expression	The expression to execute

Process(AlterDefaultConstraintExpression)

Executes an SQL expression to alter a default constraint

Declaration

void Process(AlterDefaultConstraintExpression expression)

Parameters

Type	Name	Description
AlterDefaultConstraintExpression	expression	The expression to execute

Process(AlterSchemaExpression)

Executes a ALTER SCHEMA SQL expression

Declaration

void Process(AlterSchemaExpression expression)

Parameters

Type	Name	Description
AlterSchemaExpression	expression	The expression to execute

Process(AlterTableExpression)

Executes a ALTER TABLE SQL expression

Declaration

void Process(AlterTableExpression expression)

Parameters

Type	Name	Description
AlterTableExpression	expression	The expression to execute

Process(CreateColumnExpression)

Executes a ALTER TABLE ADD COLUMN SQL expression

Declaration

void Process(CreateColumnExpression expression)

Parameters

Type	Name	Description
CreateColumnExpression	expression	The expression to execute

Process(CreateConstraintExpression)

Executes an SQL expression to create a constraint

Declaration

void Process(CreateConstraintExpression expression)

Parameters

Type	Name	Description
CreateConstraintExpression	expression	The expression to execute

Process(CreateForeignKeyExpression)

Executes an SQL expression to create a foreign key

Declaration

void Process(CreateForeignKeyExpression expression)

Parameters

Type	Name	Description
CreateForeignKeyExpression	expression	The expression to execute

Process(CreateIndexExpression)

Executes an SQL expression to create an index

Declaration

void Process(CreateIndexExpression expression)

Parameters

Type	Name	Description
CreateIndexExpression	expression	The expression to execute

Process(CreateSchemaExpression)

Executes a CREATE SCHEMA SQL expression

Declaration

void Process(CreateSchemaExpression expression)

Parameters

Type	Name	Description
CreateSchemaExpression	expression	The expression to execute

Process(CreateSequenceExpression)

Executes a CREATE SEQUENCE SQL expression

Declaration

void Process(CreateSequenceExpression expression)

Parameters

Type	Name	Description
CreateSequenceExpression	expression	The expression to execute

Process(CreateTableExpression)

Executes a CREATE TABLE SQL expression

Declaration

void Process(CreateTableExpression expression)

Parameters

Type	Name	Description
CreateTableExpression	expression	The expression to execute

Process(DeleteColumnExpression)

Executes a ALTER TABLE DROP COLUMN SQL expression

Declaration

void Process(DeleteColumnExpression expression)

Parameters

Type	Name	Description
DeleteColumnExpression	expression	The expression to execute

Process(DeleteConstraintExpression)

Executes an SQL expression to drop a constraint

Declaration

void Process(DeleteConstraintExpression expression)

Parameters

Type	Name	Description
DeleteConstraintExpression	expression	The expression to execute

Process(DeleteDataExpression)

Executes an SQL expression to DELETE data

Declaration

void Process(DeleteDataExpression expression)

Parameters

Type	Name	Description
DeleteDataExpression	expression	The expression to execute

Process(DeleteDefaultConstraintExpression)

Executes an SQL expression to drop a default constraint

Declaration

void Process(DeleteDefaultConstraintExpression expression)

Parameters

Type	Name	Description
DeleteDefaultConstraintExpression	expression	The expression to execute

Process(DeleteForeignKeyExpression)

Executes an SQL expression to drop a foreign key

Declaration

void Process(DeleteForeignKeyExpression expression)

Parameters

Type	Name	Description
DeleteForeignKeyExpression	expression	The expression to execute

Process(DeleteIndexExpression)

Executes an SQL expression to drop an index

Declaration

void Process(DeleteIndexExpression expression)

Parameters

Type	Name	Description
DeleteIndexExpression	expression	The expression to execute

Process(DeleteSchemaExpression)

Executes a DROP SCHEMA SQL expression

Declaration

void Process(DeleteSchemaExpression expression)

Parameters

Type	Name	Description
DeleteSchemaExpression	expression	The expression to execute

Process(DeleteSequenceExpression)

Executes a DROP SEQUENCE SQL expression

Declaration

void Process(DeleteSequenceExpression expression)

Parameters

Type	Name	Description
DeleteSequenceExpression	expression	The expression to execute

Process(DeleteTableExpression)

Executes a DROP TABLE SQL expression

Declaration

void Process(DeleteTableExpression expression)

Parameters

Type	Name	Description
DeleteTableExpression	expression	The expression to execute

Process(InsertDataExpression)

Executes an SQL expression to INSERT data

Declaration

void Process(InsertDataExpression expression)

Parameters

Type	Name	Description
InsertDataExpression	expression	The expression to execute

Process(PerformDBOperationExpression)

Executes a DB operation

Declaration

void Process(PerformDBOperationExpression expression)

Parameters

Type	Name	Description
PerformDBOperationExpression	expression	The expression to execute

Process(RenameColumnExpression)

Executes an SQL expression to rename a column

Declaration

void Process(RenameColumnExpression expression)

Parameters

Type	Name	Description
RenameColumnExpression	expression	The expression to execute

Process(RenameTableExpression)

Executes an SQL expression to rename a table

Declaration

void Process(RenameTableExpression expression)

Parameters

Type	Name	Description
RenameTableExpression	expression	The expression to execute

Process(UpdateDataExpression)

Executes an SQL expression to UPDATE data

Declaration

void Process(UpdateDataExpression expression)

Parameters

Type	Name	Description
UpdateDataExpression	expression	The expression to execute

Read(string, params object[])

Executes and returns the result of an SQL query

Declaration

DataSet Read(string template, params object[] args)

Parameters

Type	Name	Description
string	template	The SQL query
object[]	args	The arguments of the SQL query

Returns

Type	Description
DataSet	The data from the specified SQL query

ReadTableData(string, string)

Reads all data from all rows from a table

Declaration

DataSet ReadTableData(string schemaName, string tableName)

Parameters

Type	Name	Description
string	schemaName	The schema name of the table
string	tableName	The table name

Returns

Type	Description
DataSet	The data from the specified table

RollbackTransaction()

Rollback of a transaction

Declaration

void RollbackTransaction()