Class CreateProcedureTask

Creates or updates a procedure.

Inheritance
System.Object
CreateProcedureTask
Implements
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: ETLBox.ControlFlow.Tasks
Assembly: ETLBox.dll
Syntax
    public sealed class CreateProcedureTask : ControlFlowTask, ILoggableTask
Examples
CRUDProcedureTask.CreateOrAlter("demo.proc1", "select 1 as test");

Constructors

CreateProcedureTask()

Declaration
    public CreateProcedureTask()

CreateProcedureTask(ProcedureDefinition)

Declaration
    public CreateProcedureTask(ProcedureDefinition definition)
Parameters
TypeNameDescription
ProcedureDefinitiondefinition

CreateProcedureTask(String, String)

Declaration
    public CreateProcedureTask(string procedureName, string procedureDefinition)
Parameters
TypeNameDescription
System.StringprocedureName
System.StringprocedureDefinition

CreateProcedureTask(String, String, IList<ProcedureParameter>)

Declaration
    public CreateProcedureTask(string procedureName, string procedureDefinition, IList<ProcedureParameter> procedureParameter)
Parameters
TypeNameDescription
System.StringprocedureName
System.StringprocedureDefinition
System.Collections.Generic.IList<ProcedureParameter>procedureParameter

Properties

PN

The formatted procedure name

Declaration
    public ObjectNameDescriptor PN { get; }
Property Value
TypeDescription
ObjectNameDescriptor

ProcedureDefinition

The sql code of the procedure

Declaration
    public string ProcedureDefinition { get; set; }
Property Value
TypeDescription
System.String

ProcedureName

The name of the procedure

Declaration
    public string ProcedureName { get; set; }
Property Value
TypeDescription
System.String

ProcedureOptions

Declaration
    public string ProcedureOptions { get; set; }
Property Value
TypeDescription
System.String

ProcedureParameters

The parameters for the procedure

Declaration
    public ICollection<ProcedureParameter> ProcedureParameters { get; set; }
Property Value
TypeDescription
System.Collections.Generic.ICollection<ProcedureParameter>

Sql

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

Declaration
    public string Sql { get; }
Property Value
TypeDescription
System.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
TypeDescription
System.String
Overrides

Methods

CreateOrAlter(IConnectionManager, ProcedureDefinition)

Creates or updates a procedure.

Declaration
    public static void CreateOrAlter(IConnectionManager connectionManager, ProcedureDefinition procedure)
Parameters
TypeNameDescription
IConnectionManagerconnectionManager

The connection manager of the database you want to connect

ProcedureDefinitionprocedure

The procedure definition object containing procedure name, code and potential parameters

CreateOrAlter(IConnectionManager, String, String)

Creates or updates a procedure.

Declaration
    public static void CreateOrAlter(IConnectionManager connectionManager, string procedureName, string procedureDefinition)
Parameters
TypeNameDescription
IConnectionManagerconnectionManager

The connection manager of the database you want to connect

System.StringprocedureName

The name of the procedure

System.StringprocedureDefinition

The sql code of the procedure

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
TypeNameDescription
IConnectionManagerconnectionManager

The connection manager of the database you want to connect

System.StringprocedureName

The name of the procedure

System.StringprocedureDefinition

The sql code of the procedure

System.Collections.Generic.IList<ProcedureParameter>procedureParameter

A list of the parameters for the procedure

CreateOrAlter(ProcedureDefinition)

Creates or updates a procedure.

Declaration
    public static void CreateOrAlter(ProcedureDefinition procedure)
Parameters
TypeNameDescription
ProcedureDefinitionprocedure

The procedure definition object containing procedure name, code and potential parameters

CreateOrAlter(String, String)

Creates or updates a procedure.

Declaration
    public static void CreateOrAlter(string procedureName, string procedureDefinition)
Parameters
TypeNameDescription
System.StringprocedureName

The name of the procedure

System.StringprocedureDefinition

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
TypeNameDescription
System.StringprocedureName

The name of the procedure

System.StringprocedureDefinition

The sql code of the procedure

System.Collections.Generic.IList<ProcedureParameter>procedureParameter

A list of the parameters for the procedure

Implements