Class CreateProcedureTask
Creates or updates a procedure.
Implements
Inherited Members
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()
CreateProcedureTask(ProcedureDefinition)
Declaration
public CreateProcedureTask(ProcedureDefinition definition)
Parameters
| Type | Name | Description |
|---|---|---|
| ProcedureDefinition | definition |
CreateProcedureTask(string, string)
Declaration
public CreateProcedureTask(string procedureName, string procedureDefinition)
Parameters
| Type | Name | Description |
|---|---|---|
| string | procedureName | |
| string | procedureDefinition |
CreateProcedureTask(string, string, IList<ProcedureParameter>)
Declaration
public CreateProcedureTask(string procedureName, string procedureDefinition, IList<ProcedureParameter> procedureParameter)
Parameters
| Type | Name | Description |
|---|---|---|
| string | procedureName | |
| string | procedureDefinition | |
| IList<ProcedureParameter> | procedureParameter |
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 |
ProcedureParameters
The parameters for the procedure
Declaration
public ICollection<ProcedureParameter> ProcedureParameters { get; set; }
Property Value
| Type | Description |
|---|---|
| ICollection<ProcedureParameter> |
Sql
The sql code that is used to create/update the procedure.
Declaration
public string Sql { get; }
Property Value
| Type | Description |
|---|---|
| string |
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)
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(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 |
| IList<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 |
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 |
| IList<ProcedureParameter> | procedureParameter | A list of the parameters for the procedure |