ETLBox
Title here
Summary here
IDataFlowExecutableSource
Interface IDataFlowExecutableSource
Shared methods for sources that can be executed
Inherited Members
Namespace: ETLBox
Assembly: ETLBox.dll
Syntax
public interface IDataFlowExecutableSource : IDataFlowSource, IDataFlowComponent, ILoggableTaskProperties
Limit
Reads data from the source until the limit is reached. Default is 0 (=no limit).
Declaration
int Limit { get; set; }Property Value
| Type | Description |
|---|---|
| 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
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | 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
| Type | Description |
|---|---|
| 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
| Type | Name | Description |
|---|---|---|
| CancellationToken | cancellationToken | A cancellation token which can be used to cancel the task of component (and all subsequent components in the flow) |
Returns
| Type | Description |
|---|---|
| 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
| Type | Name | Description |
|---|---|---|
| CancellationToken? | cancellationToken | A cancellation token which can be used to cancel the task of component (and all subsequent components in the flow) |
Returns
| Type | Description |
|---|---|
| Task | Returns an awaitable task that completes or faults when the source ran to completion. |