Class CreateProcedureTask

Creates or updates a procedure.

Inheritance

object

LoggableTask

ControlFlowTask

CreateProcedureTask

Implements

ILoggableTask

Inherited Members

ControlFlowTask.ConnectionManager

ControlFlowTask.ConnectionType

ControlFlowTask.QB

ControlFlowTask.QE

LoggableTask.TaskType

LoggableTask.DisableLogging

LoggableTask.TaskHash

LoggableTask.CopyLogTaskProperties(ILoggableTask)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: ETLBox.ControlFlow

Assembly: ETLBox.dll

Syntax

    public sealed class CreateProcedureTask : ControlFlowTask, ILoggableTask

Examples

CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

Constructors

CreateProcedureTask()

Declaration

    public CreateProcedureTask()

Examples

CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

CreateProcedureTask(ProcedureDefinition)

Declaration

    public CreateProcedureTask(ProcedureDefinition definition)

Parameters

Type	Name	Description
ProcedureDefinition	definition

Examples

CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

CreateProcedureTask(string, string, IList<ProcedureParameter>)

Declaration

    public CreateProcedureTask(string procedureName, string procedureDefinition, IList<ProcedureParameter> procedureParameter)

Parameters

Type	Name	Description
string	procedureName
string	procedureDefinition
System.Collections.Generic.IList<T><ProcedureParameter>	procedureParameter

Examples

CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

CreateProcedureTask(string, string)

Declaration

    public CreateProcedureTask(string procedureName, string procedureDefinition)

Parameters

Type	Name	Description
string	procedureName
string	procedureDefinition

Examples

CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

Properties

PN

The formatted procedure name

Declaration

    public ObjectNameDescriptor PN { get; }

Property Value

Type	Description
ObjectNameDescriptor

ProcedureDefinition

The sql code of the procedure

Declaration

    public string ProcedureDefinition { get; set; }

Property Value

Type	Description
string

ProcedureName

The name of the procedure

Declaration

    public string ProcedureName { get; set; }

Property Value

Type	Description
string

ProcedureOptions

Declaration

    public string ProcedureOptions { get; set; }

Property Value

Type	Description
string

Examples

CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

ProcedureParameters

The parameters for the procedure

Declaration

    public ICollection<ProcedureParameter> ProcedureParameters { get; set; }

Property Value

Type	Description
System.Collections.Generic.ICollection<T><ProcedureParameter>

Sql

The sql code that is used to create/update the procedure.

Declaration

    public string Sql { get; }

Property Value

Type	Description
string

TaskName

A name to identify the task or component. Every component or task comes with a default name that can be overwritten.

Declaration

    public override string TaskName { get; set; }

Property Value

Type	Description
string

Overrides

LoggableTask.TaskName

Methods

CreateOrAlter(ProcedureDefinition)

Creates or updates a procedure.

Declaration

    public static void CreateOrAlter(ProcedureDefinition procedure)

Parameters

Type	Name	Description
ProcedureDefinition	procedure	The procedure definition object containing procedure name, code and potential parameters

CreateOrAlter(IConnectionManager, ProcedureDefinition)

Creates or updates a procedure.

Declaration

    public static void CreateOrAlter(IConnectionManager connectionManager, ProcedureDefinition procedure)

Parameters

Type	Name	Description
IConnectionManager	connectionManager	The connection manager of the database you want to connect
ProcedureDefinition	procedure	The procedure definition object containing procedure name, code and potential parameters

CreateOrAlter(IConnectionManager, string, string, IList<ProcedureParameter>)

Creates or updates a procedure.

Declaration

    public static void CreateOrAlter(IConnectionManager connectionManager, string procedureName, string procedureDefinition, IList<ProcedureParameter> procedureParameter)

Parameters

Type	Name	Description
IConnectionManager	connectionManager	The connection manager of the database you want to connect
string	procedureName	The name of the procedure
string	procedureDefinition	The sql code of the procedure
System.Collections.Generic.IList<T><ProcedureParameter>	procedureParameter	A list of the parameters for the procedure

CreateOrAlter(IConnectionManager, string, string)

Creates or updates a procedure.

Declaration

    public static void CreateOrAlter(IConnectionManager connectionManager, string procedureName, string procedureDefinition)

Parameters

Type	Name	Description
IConnectionManager	connectionManager	The connection manager of the database you want to connect
string	procedureName	The name of the procedure
string	procedureDefinition	The sql code of the procedure

CreateOrAlter(string, string, IList<ProcedureParameter>)

Creates or updates a procedure.

Declaration

    public static void CreateOrAlter(string procedureName, string procedureDefinition, IList<ProcedureParameter> procedureParameter)

Parameters

Type	Name	Description
string	procedureName	The name of the procedure
string	procedureDefinition	The sql code of the procedure
System.Collections.Generic.IList<T><ProcedureParameter>	procedureParameter	A list of the parameters for the procedure

CreateOrAlter(string, string)

Creates or updates a procedure.

Declaration

    public static void CreateOrAlter(string procedureName, string procedureDefinition)

Parameters

Type	Name	Description
string	procedureName	The name of the procedure
string	procedureDefinition	The sql code of the procedure

Implements

ILoggableTask