Class AdbExecuteNonQueryTargetFactory

Factory methods that create an AdbExecuteNonQueryTarget<TInputError> dataflow worker, which executes an SQL query for each incoming row. It also has an ErrorOutput port that receives any rows that throw an exception when creating and executing their queries.

The Input port is linked to (if available) the upstream output or error output port specified by the factory.

Get the factory from Link when the upstream port is known ahead of time (which is usually the case). Otherwise get it from GetDownstreamFactory<TInput>(), and link the transform or target explicitly using LinkTo(InputPort<TOutput>) or LinkFrom(OutputPortBase<TInput>).

Also see SQL Database Access.

Note: This worker does participate in any transaction currently active on the connection.

Inheritance

Object

AdbExecuteNonQueryTargetFactory

Namespace: actionETL.Adb

Assembly: actionETL.dll

Syntax

public static class AdbExecuteNonQueryTargetFactory

Methods

AdbExecuteNonQueryTarget<TInputError>(in DownstreamFactory<TInputError>, String, AdbCommandBuilder)

Initializes a new instance of the AdbExecuteNonQueryTarget<TInputError> dataflow worker, which executes an SQL query for each incoming row. It also has an ErrorOutput port that receives any rows that throw an exception when creating and executing their queries.

The worker uses CreateSetParametersFromRowAction<T>(AdbParameterCollection) to set parameter values from incoming rows.

The Input port is linked to (if available) the upstream output or error output port specified by the factory.

Declaration

public static AdbExecuteNonQueryTarget<TInputError> AdbExecuteNonQueryTarget<TInputError>(this in DownstreamFactory<TInputError> downstreamFactory, string workerName, AdbCommandBuilder commandBuilder)
    where TInputError : class

Parameters

Type	Name	Description
DownstreamFactory<TInputError>	downstreamFactory	The downstream factory, which specifies the parent worker and (optionally) the upstream port to link the "first" input port of this dataflow worker to. Get it from Link when the upstream port is known ahead of time (which is usually the case). Otherwise get it from GetDownstreamFactory<TInput>(), and link the transform or target explicitly using LinkTo(InputPort<TOutput>) or LinkFrom(OutputPortBase<TInput>).
String	workerName	Name of the worker. Set to a prefix plus a trailing `"/"` (e.g. `"MyPrefix-/"`) to generate a unique name from the prefix plus an increasing number starting at 1. While less useful, set to `null`, whitespace or `"/"` to generate a unique name from the worker type plus an increasing number starting at 1. The name cannot otherwise contain `"/"`, and cannot start with double underscore `"__"`.
AdbCommandBuilder	commandBuilder	A builder for the database command. Can be `null`, in which case CommandBuilder must be set before the worker starts running.

Returns

Type	Description
AdbExecuteNonQueryTarget<TInputError>	The newly created and (optionally) linked worker.

Type Parameters

Name	Description
TInputError	The type of each `Input` and `ErrorOutput` row.

Exceptions

Type	Condition
ArgumentException	`workerName`: Workers with the same parent must have unique names. Worker and worker system names cannot contain '/' or start with double underscore '__'.
ArgumentNullException	`workerParent` - All workers must have a parent. The top level workers have the worker system as parent.
InvalidOperationException	Cannot add child worker to parent which has completed. Are you adding it to the correct parent? Cannot add worker to parent, since its children have been started. Are you adding it to the correct parent?