Search Results for

    Show / Hide Table of Contents

    Class RowActionTransform<TInputError, TOutput>

    A dataflow transform worker which executes a callback for each incoming row. The callback is passed the row as a parameter, and the return value controls whether to send zero or one row (which can be of a different type) to the output, or to the error output. When outputting a row, the callback is responsible for either allocating a new output row, or if appropriate cast the input row to the output type, before passing it to the downstream worker.

    Note: Use the factory methods in RowActionTransformFactory to create instances of this class.

    If the function throws an exception, the input row will be rejected to the ErrorOutput port.

    Use RowActionTransform<TInputOutputError> instead if the input and output types are the same.

    The input port uses the Default policy. Consider whether this is appropriate, or should be overridden, see BufferingMode for further details.

    Also see the RowActionTransform example.

    Note that this worker does not support asynchronous row methods. If that is needed, consider using RowsActionTransform<TInputError, TOutput> or RowsTransformBase<TDerived, TInput, TOutput, TError> instead.

    To create a transform without any ErrorOutput, consider inheriting from RowsTransformBase<TDerived, TInput, TOutput>.

    Inheritance
    Object
    WorkerParent
    WorkerBase
    WorkerBase<RowActionTransform<TInputError, TOutput>>
    RowsTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>
    RowTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>
    RowActionTransform<TInputError, TOutput>
    Implements
    IDisposeOnFinished
    Inherited Members
    RowTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.ErrorOutput
    RowTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.OnInputRow(TInputError)
    RowTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.OnRowsAndDemandAsync()
    RowsTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.Input
    RowsTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.Output
    RowsTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.RunAsync()
    WorkerBase<RowActionTransform<TInputError, TOutput>>.AddCompletedCallback(Func<RowActionTransform<TInputError, TOutput>, OutcomeStatus, Task<OutcomeStatus>>)
    WorkerBase<RowActionTransform<TInputError, TOutput>>.AddRanCallback(Func<RowActionTransform<TInputError, TOutput>, OutcomeStatus, WorkerParentChildrenState, Task<OutcomeStatus>>)
    WorkerBase<RowActionTransform<TInputError, TOutput>>.AddStartingCallback(Func<RowActionTransform<TInputError, TOutput>, Task<ProgressStatus>>)
    WorkerBase.AddCompletedCallback(Func<WorkerBase, OutcomeStatus, Task<OutcomeStatus>>)
    WorkerBase.AddRanCallback(Func<WorkerBase, OutcomeStatus, WorkerParentChildrenState, Task<OutcomeStatus>>)
    WorkerBase.AddStartingCallback(Func<WorkerBase, Task<ProgressStatus>>)
    WorkerBase.DefaultIsStartable()
    WorkerBase.ErroredPortErrorsWorkerProtected
    WorkerBase.ErrorOutputs
    WorkerBase.EscalateError
    WorkerBase.Inputs
    WorkerBase.IsStartable
    WorkerBase.Outputs
    WorkerBase.Parent
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, WorkerBase, WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(WorkerBase, TLastWorker)
    WorkerBase.SucceededSequence<TLastWorker>(TLastWorker)
    WorkerParent.AddChildCompletedCallback(Action<WorkerBase>)
    WorkerParent.AddStartingChildrenCallback(Func<WorkerParent, Task<ProgressStatus>>)
    WorkerParent.BytesPerRowBuffer
    WorkerParent.Children
    WorkerParent.DisposeOnFinished<TDisposable>(TDisposable)
    WorkerParent.GetDownstreamFactory<TInput>()
    WorkerParent.HasChildren
    WorkerParent.IsCanceled
    WorkerParent.IsCompleted
    WorkerParent.IsCreated
    WorkerParent.IsError
    WorkerParent.IsFailed
    WorkerParent.IsFatal
    WorkerParent.IsRunning
    WorkerParent.IsSucceeded
    WorkerParent.KeepChildrenLevels
    WorkerParent.Locator
    WorkerParent.LogFactory
    WorkerParent.Logger
    WorkerParent.MaxRunningChildren
    WorkerParent.Name
    WorkerParent.RemoveChildren()
    WorkerParent.RescheduleChildren()
    WorkerParent.RunAsync()
    WorkerParent.RunChildrenAsync(Boolean)
    WorkerParent.RunChildrenAsync()
    WorkerParent.Status
    WorkerParent.Item[String]
    WorkerParent.ToString()
    WorkerParent.WorkerSystem
    WorkerParent.DebugCommands
    WorkerParent.AggregateErrorOutputRows
    WorkerParent.AggregateOutputRows
    WorkerParent.AggregateWorkersCompleted
    WorkerParent.InstantCompleted
    WorkerParent.InstantCreated
    WorkerParent.InstantStarted
    WorkerParent.RunningDuration
    Namespace: actionETL
    Assembly: actionETL.dll
    Syntax
    public class RowActionTransform<TInputError, TOutput> : RowTransformBase<RowActionTransform<TInputError, TOutput>, TInputError, TOutput>, IDisposeOnFinished where TInputError : class where TOutput : class
    Type Parameters
    Name Description
    TInputError

    The type of each Input and ErrorOutput row.

    TOutput

    The type of each Output row.

    Methods

    OnInputRow(TInputError)

    For internal use.

    Declaration
    protected sealed override (TransformRowTreatment, TOutput) OnInputRow(TInputError inputRow)
    Parameters
    Type Name Description
    TInputError inputRow

    Incoming row.

    Returns
    Type Description
    (T1, T2)<TransformRowTreatment, TOutput>
    Overrides
    actionETL.RowTransformBase<actionETL.RowActionTransform<TInputError, TOutput>, TInputError, TOutput>.OnInputRow(TInputError)

    Implements

    IDisposeOnFinished

    See Also

    RowActionTransformFactory
    RowActionTransform<TInputOutputError>
    In This Article
    Back to top Copyright © 2023 Envobi Ltd