IDataFlowExecutableSource

Interface IDataFlowExecutableSource

Shared methods for sources that can be executed

Namespace: ETLBox
Assembly: ETLBox.dll
Syntax
    public interface IDataFlowExecutableSource : IDataFlowSource, IDataFlowComponent, ILoggableTask

Properties

Limit

Reads data from the source until the limit is reached. Default is 0 (=no limit).

Declaration
    int Limit { get; set; }
Property Value
TypeDescription
int

Methods

Execute()

Starts the data flow for all connected components (also for other sources in the network). Waits until all destinations run to completion.

Declaration
    void Execute()

Execute(CancellationToken)

Declaration
    void Execute(CancellationToken cancellationToken)
Parameters
TypeNameDescription
CancellationTokencancellationToken

A cancellation token which can be used to cancel the task of component (and all subsequent components in the flow)

ExecuteAsync()

Starts the data flow asynchronously.

Declaration
    Task ExecuteAsync()
Returns
TypeDescription
Task

Returns an awaitable task that completes or faults when the flow ran to completion.

ExecuteAsync(CancellationToken)

Starts the data flow asynchronously.

Declaration
    Task ExecuteAsync(CancellationToken cancellationToken)
Parameters
TypeNameDescription
CancellationTokencancellationToken

A cancellation token which can be used to cancel the task of component (and all subsequent components in the flow)

Returns
TypeDescription
Task

Returns an awaitable task that completes or faults when the flow ran to completion.

StartAsync(CancellationToken?)

Starts the source asynchronously. Will return only the task for the source component, which completes when all data was posted into the data flow.

Declaration
    Task StartAsync(CancellationToken? cancellationToken)
Parameters
TypeNameDescription
CancellationToken?cancellationToken

A cancellation token which can be used to cancel the task of component (and all subsequent components in the flow)

Returns
TypeDescription
Task

Returns an awaitable task that completes or faults when the source ran to completion.