# CreateTableTask {{< rawhtml >}}

Class CreateTableTask

Creates a table. If the tables exists, this task won't change the table.

Inheritance
object
LoggableTask
ControlFlowTask
CreateTableTask
Implements
ILoggableTask
Inherited Members
ControlFlowTask.ConnectionManager
ControlFlowTask.ConnectionType
ControlFlowTask.QB
ControlFlowTask.QE
LoggableTask.TaskType
LoggableTask.TaskName
LoggableTask.DisableLogging
LoggableTask.LogThreshold
LoggableTask.TaskHash
LoggableTask.LogInstance
LoggableTask.ParentTask
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.ControlFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}} ```C# public sealed class CreateTableTask : ControlFlowTask, ILoggableTask ``` {{< rawhtml >}}
Examples
CreateTableTask.Create("demo.table1", new List<TableColumn>() {
new TableColumn(name:"key", dataType:"int", allowNulls:false, isPrimaryKey:true, isIdentity:true),
    new TableColumn(name:"value", dataType:"nvarchar(100)", allowNulls:true)
});

Constructors

CreateTableTask()

Declaration
{{< /rawhtml >}} ```C# public CreateTableTask() ``` {{< rawhtml >}}

CreateTableTask(TableDefinition)

Declaration
{{< /rawhtml >}} ```C# public CreateTableTask(TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
TableDefinition tableDefinition

CreateTableTask(string, List<TableColumn>)

Declaration
{{< /rawhtml >}} ```C# public CreateTableTask(string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
string tableName
List<TableColumn> columns

Properties

Columns

The list of columns to create. Either use the TableDefinition or a combination of TableName and TableColumn.

Declaration
{{< /rawhtml >}} ```C# public IList Columns { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
IList<TableColumn>

DataTypeConverter

A data type converter that is used to remap the current data type names in the TableDefintion to other, database specific type names. E.g. you can remap that the type VARCHAR(8000) is created as TEXT.

Declaration
{{< /rawhtml >}} ```C# public IDataTypeConverter DataTypeConverter { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
IDataTypeConverter

IgnoreCollation

When creating the CREATE TABLE sql, ignore the Collation definition that a TableColumn potentially has.

Declaration
{{< /rawhtml >}} ```C# public bool IgnoreCollation { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
bool

IsTemporaryTable

If set to true, the table will be create as temp table on the database.

Declaration
{{< /rawhtml >}} ```C# public bool IsTemporaryTable { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
bool

Sql

The sql code that is used to create the table.

Declaration
{{< /rawhtml >}} ```C# public string Sql { get; } ``` {{< rawhtml >}}
Property Value
Type Description
string

TN

The formatted table name

Declaration
{{< /rawhtml >}} ```C# public ObjectNameDescriptor TN { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ObjectNameDescriptor

TableDefinition

The table definition for the table that should be created. Either use the TableDefinition or a combination of TableName and TableColumn.

Declaration
{{< /rawhtml >}} ```C# public TableDefinition TableDefinition { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
TableDefinition

TableName

The name of the table to create.

Declaration
{{< /rawhtml >}} ```C# public string TableName { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
string

Methods

Alter()

Declaration
{{< /rawhtml >}} ```C# public void Alter() ``` {{< rawhtml >}}

Alter(TableDefinition)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void Alter(TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
TableDefinition tableDefinition

The definition of the table containing table name and columns.

Alter(IConnectionManager, TableDefinition)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void Alter(IConnectionManager connectionManager, TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
TableDefinition tableDefinition

The definition of the table containing table name and columns.

Alter(IConnectionManager, string, List<TableColumn>)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void Alter(IConnectionManager connectionManager, string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

Alter(string, List<TableColumn>)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void Alter(string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

AlterIfDifferent()

Execute the alter statements to change the table

Declaration
{{< /rawhtml >}} ```C# public void AlterIfDifferent() ``` {{< rawhtml >}}

AlterIfNeeded(TableDefinition)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void AlterIfNeeded(TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
TableDefinition tableDefinition

The definition of the table containing table name and columns.

AlterIfNeeded(IConnectionManager, TableDefinition)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void AlterIfNeeded(IConnectionManager connectionManager, TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
TableDefinition tableDefinition

The definition of the table containing table name and columns.

AlterIfNeeded(IConnectionManager, string, List<TableColumn>)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void AlterIfNeeded(IConnectionManager connectionManager, string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

AlterIfNeeded(string, List<TableColumn>)

Alters a table using ALTER TABLE statements.

Declaration
{{< /rawhtml >}} ```C# public static void AlterIfNeeded(string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

CheckTableDefinition()

Declaration
{{< /rawhtml >}} ```C# public void CheckTableDefinition() ``` {{< rawhtml >}}

Create()

Executes the table creation. Throws an exception if the table exists.

Declaration
{{< /rawhtml >}} ```C# public void Create() ``` {{< rawhtml >}}

Create(TableDefinition)

Creates a table using a CREATE TABLE statement. Throws an exception if the table already exists.

Declaration
{{< /rawhtml >}} ```C# public static void Create(TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
TableDefinition tableDefinition

The definition of the table containing table name and columns.

Create(IConnectionManager, TableDefinition)

Creates a table using a CREATE TABLE statement. Throws an exception if the table already exists.

Declaration
{{< /rawhtml >}} ```C# public static void Create(IConnectionManager connectionManager, TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
TableDefinition tableDefinition

The definition of the table containing table name and columns.

Create(IConnectionManager, string, List<TableColumn>)

Creates a table using a CREATE TABLE statement. Throws an exception if the table already exists.

Declaration
{{< /rawhtml >}} ```C# public static void Create(IConnectionManager connectionManager, string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

Create(string, List<TableColumn>)

Creates a table using a CREATE TABLE statement. Throws an exception if the table already exists.

Declaration
{{< /rawhtml >}} ```C# public static void Create(string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

CreateIfNotExists()

Executes the table creation if the table doesn't exist.

Declaration
{{< /rawhtml >}} ```C# public void CreateIfNotExists() ``` {{< rawhtml >}}

CreateIfNotExists(TableDefinition)

Creates a table using a CREATE TABLE statement if the table doesn't exist.

Declaration
{{< /rawhtml >}} ```C# public static void CreateIfNotExists(TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
TableDefinition tableDefinition

The definition of the table containing table name and columns.

CreateIfNotExists(IConnectionManager, TableDefinition)

Creates a table using a CREATE TABLE statement if the table doesn't exist.

Declaration
{{< /rawhtml >}} ```C# public static void CreateIfNotExists(IConnectionManager connectionManager, TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
TableDefinition tableDefinition

The definition of the table containing table name and columns.

CreateIfNotExists(IConnectionManager, string, List<TableColumn>)

Creates a table using a CREATE TABLE statement if the table doesn't exist.

Declaration
{{< /rawhtml >}} ```C# public static void CreateIfNotExists(IConnectionManager connectionManager, string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

CreateIfNotExists(string, List<TableColumn>)

Creates a table using a CREATE TABLE statement if the table doesn't exist.

Declaration
{{< /rawhtml >}} ```C# public static void CreateIfNotExists(string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

CreateOrAlter()

Executes the table creation or execute the corresponding alter statements to adjust the table. If the table is empty, the new table is always dropped and recreated.

Declaration
{{< /rawhtml >}} ```C# public void CreateOrAlter() ``` {{< rawhtml >}}

CreateOrAlter(TableDefinition)

Creates a table if the table doesn't exist or alters a table using ALTER TABLE statements. If the table does not contain any rows, it will be dropped and created again.

Declaration
{{< /rawhtml >}} ```C# public static void CreateOrAlter(TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
TableDefinition tableDefinition

The definition of the table containing table name and columns.

CreateOrAlter(IConnectionManager, TableDefinition)

Creates a table if the table doesn't exist or alters a table using ALTER TABLE statements. If the table does not contain any rows, it will be dropped and created again.

Declaration
{{< /rawhtml >}} ```C# public static void CreateOrAlter(IConnectionManager connectionManager, TableDefinition tableDefinition) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
TableDefinition tableDefinition

The definition of the table containing table name and columns.

CreateOrAlter(IConnectionManager, string, List<TableColumn>)

Creates a table if the table doesn't exist or alters a table using ALTER TABLE statements. If the table does not contain any rows, it will be dropped and created again.

Declaration
{{< /rawhtml >}} ```C# public static void CreateOrAlter(IConnectionManager connectionManager, string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
IConnectionManager connectionManager

The connection manager of the database you want to connect
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

CreateOrAlter(string, List<TableColumn>)

Creates a table if the table doesn't exist or alters a table using ALTER TABLE statements. If the table does not contain any rows, it will be dropped and created again.

Declaration
{{< /rawhtml >}} ```C# public static void CreateOrAlter(string tableName, List columns) ``` {{< rawhtml >}}
Parameters
Type Name Description
string tableName

The name of the table
List<TableColumn> columns

The columns of the table

Implements

{{< /rawhtml >}}