Class CreateIndexTask

Creates an index if the index doesn't exists, otherwise the index is dropped and recreated.

Inheritance

object

LoggableTask

ControlFlowTask

CreateIndexTask

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 CreateIndexTask : ControlFlowTask, ILoggableTask ``` {{< rawhtml >}}

Examples

CreateIndexTask.Create("indexname","tablename", indexColumns)

Constructors

CreateIndexTask()

Declaration

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

CreateIndexTask(string, string, IList<string>)

Declaration

{{< /rawhtml >}} ```C# public CreateIndexTask(string indexName, string tableName, IList indexColumns) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
string	indexName
string	tableName
IList<string>	indexColumns

CreateIndexTask(string, string, IList<string>, IList<string>)

Declaration

{{< /rawhtml >}} ```C# public CreateIndexTask(string indexName, string tableName, IList indexColumns, IList includeColumns) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
string	indexName
string	tableName
IList<string>	indexColumns
IList<string>	includeColumns

Properties

IN

The formatted name of the index

Declaration

{{< /rawhtml >}} ```C# public ObjectNameDescriptor IN { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
ObjectNameDescriptor

IncludeColumns

A list of included column names for the index.

Declaration

{{< /rawhtml >}} ```C# public IList IncludeColumns { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
IList<string>

IndexColumns

A list of column names for the index

Declaration

{{< /rawhtml >}} ```C# public IList IndexColumns { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
IList<string>

IndexName

The name of the index

Declaration

{{< /rawhtml >}} ```C# public string IndexName { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

IsClustered

Set the index as a clustered index

Declaration

{{< /rawhtml >}} ```C# public bool IsClustered { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
bool

IsUnique

Set the index as Unique.

Declaration

{{< /rawhtml >}} ```C# public bool IsUnique { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
bool

Sql

The sql code used to generate the index

Declaration

{{< /rawhtml >}} ```C# public string Sql { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

TN

The formatted name of the table.

Declaration

{{< /rawhtml >}} ```C# public ObjectNameDescriptor TN { get; } ``` {{< rawhtml >}}

Property Value

Type	Description
ObjectNameDescriptor

TableName

The name of the table the index is based on.

Declaration

{{< /rawhtml >}} ```C# public string TableName { get; set; } ``` {{< rawhtml >}}

Property Value

Type	Description
string

Methods

CreateOrRecreate()

Runs the sql to (re)create the index on a table.

Declaration

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

CreateOrRecreate(IConnectionManager, string, string, IList<string>)

Creates an index. If the index exists, it is dropped and recreated.

Declaration

{{< /rawhtml >}} ```C# public static void CreateOrRecreate(IConnectionManager connectionManager, string indexName, string tableName, IList indexColumns) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IConnectionManager	connectionManager	The connection manager of the database you want to connect
string	indexName	The name of the index
string	tableName	The name of the table the index is based on
IList<string>	indexColumns	The name of the columns for the index

CreateOrRecreate(IConnectionManager, string, string, IList<string>, IList<string>)

Creates an index. If the index exists, it is dropped and recreated.

Declaration

{{< /rawhtml >}} ```C# public static void CreateOrRecreate(IConnectionManager connectionManager, string indexName, string tableName, IList indexColumns, IList includeColumns) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
IConnectionManager	connectionManager	The connection manager of the database you want to connect
string	indexName	The name of the index
string	tableName	The name of the table the index is based on
IList<string>	indexColumns	The name of the columns for the index
IList<string>	includeColumns	The name of the columns that are included in the index.

CreateOrRecreate(string, string, IList<string>)

Creates an index. If the index exists, it is dropped and recreated.

Declaration

{{< /rawhtml >}} ```C# public static void CreateOrRecreate(string indexName, string tableName, IList indexColumns) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
string	indexName	The name of the index
string	tableName	The name of the table the index is based on
IList<string>	indexColumns	The name of the columns for the index

CreateOrRecreate(string, string, IList<string>, IList<string>)

Creates an index. If the index exists, it is dropped and recreated.

Declaration

{{< /rawhtml >}} ```C# public static void CreateOrRecreate(string indexName, string tableName, IList indexColumns, IList includeColumns) ``` {{< rawhtml >}}

Parameters

Type	Name	Description
string	indexName	The name of the index
string	tableName	The name of the table the index is based on
IList<string>	indexColumns	The name of the columns for the index
IList<string>	includeColumns	The name of the columns that are included in the index

Implements

ILoggableTask