Class ProcessorBase

Inheritance

object

ProcessorBase

GenericProcessorBase

GenericProcessorBase

JetProcessor

JetProcessor

Implements

IMigrationProcessor

IQuerySchema

IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: FluentMigrator.Runner.Processors

Assembly: FluentMigrator.Runner.Core.dll

Syntax

public abstract class ProcessorBase : IMigrationProcessor, IQuerySchema, IDisposable

Constructors

ProcessorBase(IMigrationGenerator, IAnnouncer, IMigrationProcessorOptions)

Declaration

[Obsolete]
protected ProcessorBase(IMigrationGenerator generator, IAnnouncer announcer, IMigrationProcessorOptions options)

Parameters

Type	Name	Description
IMigrationGenerator	generator
IAnnouncer	announcer
IMigrationProcessorOptions	options

ProcessorBase(IMigrationGenerator, IAnnouncer, ProcessorOptions)

Declaration

[Obsolete]
protected ProcessorBase(IMigrationGenerator generator, IAnnouncer announcer, ProcessorOptions options)

Parameters

Type	Name	Description
IMigrationGenerator	generator
IAnnouncer	announcer
ProcessorOptions	options

ProcessorBase(IMigrationGenerator, ILogger, ProcessorOptions)

Declaration

protected ProcessorBase(IMigrationGenerator generator, ILogger logger, ProcessorOptions options)

Parameters

Type	Name	Description
IMigrationGenerator	generator
ILogger	logger
ProcessorOptions	options

Fields

Announcer

Declaration

[Obsolete]
protected readonly IAnnouncer Announcer

Field Value

Type	Description
IAnnouncer

Generator

Declaration

protected readonly IMigrationGenerator Generator

Field Value

Type	Description
IMigrationGenerator

Properties

ConnectionString

Gets the connection string

Declaration

[Obsolete]
public abstract string ConnectionString { get; }

Property Value

Type	Description
string

DatabaseType

Gets the database type

Declaration

public abstract string DatabaseType { get; }

Property Value

Type	Description
string

DatabaseTypeAliases

Gets the database type aliases

Declaration

public abstract IList<string> DatabaseTypeAliases { get; }

Property Value

Type	Description
IList<string>

Logger

Declaration

protected ILogger Logger { get; }

Property Value

Type	Description
ILogger

Options

Declaration

[NotNull]
protected ProcessorOptions Options { get; }

Property Value

Type	Description
ProcessorOptions

WasCommitted

Declaration

public bool WasCommitted { get; protected set; }

Property Value

Type	Description
bool

Methods

BeginTransaction()

Begins a transaction

Declaration

public virtual void BeginTransaction()

ColumnExists(string, string, string)

Tests if a column exists

Declaration

public abstract bool ColumnExists(string schemaName, string tableName, string columnName)

Parameters

Type	Name	Description
string	schemaName	The schema name
string	tableName	The table name
string	columnName	The column name

Returns

Type	Description
bool	true when it exists

CommitTransaction()

Commits a transaction

Declaration

public virtual void CommitTransaction()

ConstraintExists(string, string, string)

Tests if a constraint exists

Declaration

public abstract bool ConstraintExists(string schemaName, string tableName, string constraintName)

Parameters

Type	Name	Description
string	schemaName	The schema name
string	tableName	The table name
string	constraintName	The constraint name

Returns

Type	Description
bool	true when it exists

DefaultValueExists(string, string, string, object)

Tests if a default value for a column exists

Declaration

public abstract bool DefaultValueExists(string schemaName, string tableName, string columnName, object defaultValue)

Parameters

Type	Name	Description
string	schemaName	The schema name
string	tableName	The table name
string	columnName	The column name
object	defaultValue	The default value

Returns

Type	Description
bool	true when it exists

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Dispose(bool)

Declaration

protected abstract void Dispose(bool isDisposing)

Parameters

Type	Name	Description
bool	isDisposing

Execute(string)

Execute an SQL statement (escaping not needed)

Declaration

public virtual void Execute(string sql)

Parameters

Type	Name	Description
string	sql	The SQL statement

Execute(string, params object[])

Execute an SQL statement

Declaration

public abstract 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

public abstract 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

IndexExists(string, string, string)

Tests if an index exists

Declaration

public abstract bool IndexExists(string schemaName, string tableName, string indexName)

Parameters

Type	Name	Description
string	schemaName	The schema name
string	tableName	The table name
string	indexName	The index name

Returns

Type	Description
bool	true when it exists

Process(AlterColumnExpression)

Executes a ALTER TABLE ALTER COLUMN SQL expression

Declaration

public virtual 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

public virtual void Process(AlterDefaultConstraintExpression expression)

Parameters

Type	Name	Description
AlterDefaultConstraintExpression	expression	The expression to execute

Process(AlterSchemaExpression)

Executes a ALTER SCHEMA SQL expression

Declaration

public virtual void Process(AlterSchemaExpression expression)

Parameters

Type	Name	Description
AlterSchemaExpression	expression	The expression to execute

Process(AlterTableExpression)

Executes a ALTER TABLE SQL expression

Declaration

public virtual 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

public virtual 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

public virtual 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

public virtual 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

public virtual void Process(CreateIndexExpression expression)

Parameters

Type	Name	Description
CreateIndexExpression	expression	The expression to execute

Process(CreateSchemaExpression)

Executes a CREATE SCHEMA SQL expression

Declaration

public virtual void Process(CreateSchemaExpression expression)

Parameters

Type	Name	Description
CreateSchemaExpression	expression	The expression to execute

Process(CreateSequenceExpression)

Executes a CREATE SEQUENCE SQL expression

Declaration

public virtual void Process(CreateSequenceExpression expression)

Parameters

Type	Name	Description
CreateSequenceExpression	expression	The expression to execute

Process(CreateTableExpression)

Executes a CREATE TABLE SQL expression

Declaration

public virtual 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

public virtual 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

public virtual void Process(DeleteConstraintExpression expression)

Parameters

Type	Name	Description
DeleteConstraintExpression	expression	The expression to execute

Process(DeleteDataExpression)

Executes an SQL expression to DELETE data

Declaration

public virtual 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

public virtual 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

public virtual 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

public virtual void Process(DeleteIndexExpression expression)

Parameters

Type	Name	Description
DeleteIndexExpression	expression	The expression to execute

Process(DeleteSchemaExpression)

Executes a DROP SCHEMA SQL expression

Declaration

public virtual void Process(DeleteSchemaExpression expression)

Parameters

Type	Name	Description
DeleteSchemaExpression	expression	The expression to execute

Process(DeleteSequenceExpression)

Executes a DROP SEQUENCE SQL expression

Declaration

public virtual void Process(DeleteSequenceExpression expression)

Parameters

Type	Name	Description
DeleteSequenceExpression	expression	The expression to execute

Process(DeleteTableExpression)

Executes a DROP TABLE SQL expression

Declaration

public virtual void Process(DeleteTableExpression expression)

Parameters

Type	Name	Description
DeleteTableExpression	expression	The expression to execute

Process(InsertDataExpression)

Executes an SQL expression to INSERT data

Declaration

public virtual void Process(InsertDataExpression expression)

Parameters

Type	Name	Description
InsertDataExpression	expression	The expression to execute

Process(PerformDBOperationExpression)

Executes a DB operation

Declaration

public abstract 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

public virtual 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

public virtual void Process(RenameTableExpression expression)

Parameters

Type	Name	Description
RenameTableExpression	expression	The expression to execute

Process(UpdateDataExpression)

Executes an SQL expression to UPDATE data

Declaration

public virtual void Process(UpdateDataExpression expression)

Parameters

Type	Name	Description
UpdateDataExpression	expression	The expression to execute

Process(string)

Declaration

protected abstract void Process(string sql)

Parameters

Type	Name	Description
string	sql

Read(string, params object[])

Executes and returns the result of an SQL query

Declaration

public abstract 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

public abstract 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

public virtual void RollbackTransaction()

SchemaExists(string)

Tests if the schema exists

Declaration

public abstract bool SchemaExists(string schemaName)

Parameters

Type	Name	Description
string	schemaName	The schema name

Returns

Type	Description
bool	true when it exists

SequenceExists(string, string)

Tests if a sequence exists

Declaration

public abstract bool SequenceExists(string schemaName, string sequenceName)

Parameters

Type	Name	Description
string	schemaName	The schema name
string	sequenceName	The sequence name

Returns

Type	Description
bool	true when it exists

TableExists(string, string)

Tests if the table exists

Declaration

public abstract bool TableExists(string schemaName, string tableName)

Parameters

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

Returns

Type	Description
bool	true when it exists

Implements

IMigrationProcessor

IQuerySchema

IDisposable