# DataFlowExecutableSource {{< rawhtml >}}

Class DataFlowExecutableSource<TOutput>

Base implementation for a source that can be executed.

Inheritance
object
LoggableTask
DataFlowComponent
DataFlowSource<TOutput>
DataFlowExecutableSource<TOutput>
VectorStoreSource<TKey, TRecord>
DataFrameSource<TOutput>
KafkaSource<TOutput>
CosmosSource<TOutput>
ServiceBusSource<TOutput>
TableSource<TOutput>
CouchbaseSource<TOutput>
CustomBatchSource<TOutput>
CustomBatchSource<TOutput>
CustomSource<TOutput>
CustomSource<TOutput>
DataFlowStreamSource<TOutput>
DataFlowStreamSource<TOutput>
DbSource<TOutput>
DbSource<TOutput>
ErrorSource
ErrorSource
MemorySource<TOutput>
MemorySource<TOutput>
MongoDbSource<TOutput>
Neo4jSource<TOutput>
RedisSource<TOutput>
Implements
IDataFlowExecutableSource<TOutput>
IDataFlowSource<TOutput>
IDataFlowExecutableSource
IDataFlowSource
IDataFlowComponent
ILoggableTask
Inherited Members
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>)
DataFlowSource<TOutput>.LinkTo<TConvert>(IDataFlowDestination<TOutput>, Predicate<TOutput>, Predicate<TOutput>)
DataFlowComponent.MaxBufferSize
DataFlowComponent.Predecessors
DataFlowComponent.Successors
DataFlowComponent.Completion
DataFlowComponent.BufferCancellationSource
DataFlowComponent.BufferCancellationToken
DataFlowComponent.WasComponentInitialized
DataFlowComponent.IsReadyForProcessing
DataFlowComponent.SetParentComponent(DataFlowComponent)
DataFlowComponent.LinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.InternalLinkTo<T>(IDataFlowDestination, object, object)
DataFlowComponent.AddComplementVoidLinkToOtherTargets(Func<Type, IDataFlowDestination>, Delegate)
DataFlowComponent.ResetComponent()
DataFlowComponent.InitBufferObjects(CancellationToken?)
DataFlowComponent.Reset()
DataFlowComponent.PrepareParameterForCheck()
DataFlowComponent.CheckParameter()
DataFlowComponent.InitCheckedParameter()
DataFlowComponent.OnInitialization
DataFlowComponent.OnCompletion
DataFlowComponent.OnException
DataFlowComponent.CompleteOrFaultBufferOnPredecessorCompletion(Task)
DataFlowComponent.CleanUpOnSuccess()
DataFlowComponent.CleanUpOnFaulted(Exception)
DataFlowComponent.Exception
DataFlowComponent.ErrorSource
DataFlowComponent.CancelBufferAndThrowOperationCanceledException()
DataFlowComponent.InternalLinkErrorTo(IDataFlowDestination<ETLBoxError>)
DataFlowComponent.ThrowOrRedirectError(Exception, string, string)
DataFlowComponent.ThrowErrorAndFaultNetwork(Exception, string)
DataFlowComponent.CancelComponent()
DataFlowComponent.ErrorCount
DataFlowComponent.ProgressCount
DataFlowComponent.OnProgress
DataFlowComponent.ExecutionStartTime
DataFlowComponent.ExecutionEndTime
DataFlowComponent.Tag
DataFlowComponent.LoggingStartOnce()
DataFlowComponent.LoggingFinishOnce()
DataFlowComponent.LogProgressBatch_AfterThrowOrRedirectError(int)
DataFlowComponent.LogProgress_AfterThrowOrRedirectError()
LoggableTask.TaskType
LoggableTask.TaskName
LoggableTask.DisableLogging
LoggableTask.LogThreshold
LoggableTask.TaskHash
LoggableTask.LogInstance
LoggableTask.ParentTask
LoggableTask.LogTrace(string, params object[])
LoggableTask.LogDebug(string, params object[])
LoggableTask.LogInfo(string, params object[])
LoggableTask.LogInfoOrDebug(string, params object[])
LoggableTask.LogWarn(string, params object[])
LoggableTask.LogError(string, params object[])
LoggableTask.LogFatal(string, params object[])
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: ETLBox.DataFlow
Assembly: ETLBox.dll
Syntax
{{< /rawhtml >}} ```C# public abstract class DataFlowExecutableSource : DataFlowSource, IDataFlowExecutableSource, IDataFlowSource, IDataFlowExecutableSource, IDataFlowSource, IDataFlowComponent, ILoggableTask ``` {{< rawhtml >}}
Type Parameters
Name Description
TOutput

Fields

SourceTask

Declaration
{{< /rawhtml >}} ```C# protected Task SourceTask ``` {{< rawhtml >}}
Field Value
Type Description
Task

Properties

Buffer

Declaration
{{< /rawhtml >}} ```C# protected BufferBlock Buffer { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
BufferBlock<TOutput>

CompleteManually

Declaration
{{< /rawhtml >}} ```C# protected virtual bool CompleteManually { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
bool

Limit

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

Declaration
{{< /rawhtml >}} ```C# public int Limit { get; set; } ``` {{< rawhtml >}}
Property Value
Type Description
int

ProgressCountIsExceedingLimit

Declaration
{{< /rawhtml >}} ```C# protected bool ProgressCountIsExceedingLimit { get; } ``` {{< rawhtml >}}
Property Value
Type Description
bool

ProgressCountIsInLimit

Declaration
{{< /rawhtml >}} ```C# protected bool ProgressCountIsInLimit { get; } ``` {{< rawhtml >}}
Property Value
Type Description
bool

SourceBlock

SourceBlock from the underlying TPL.Dataflow which is used as output buffer for the component.

Declaration
{{< /rawhtml >}} ```C# public override ISourceBlock SourceBlock { get; } ``` {{< rawhtml >}}
Property Value
Type Description
ISourceBlock<TOutput>
Overrides

Methods

CompleteBuffer()

Declaration
{{< /rawhtml >}} ```C# protected override void CompleteBuffer() ``` {{< rawhtml >}}
Overrides

Execute()

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

Declaration
{{< /rawhtml >}} ```C# public void Execute() ``` {{< rawhtml >}}

Execute(CancellationToken)

Execute()

Declaration
{{< /rawhtml >}} ```C# public void Execute(CancellationToken cancellationToken) ``` {{< rawhtml >}}
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
{{< /rawhtml >}} ```C# public Task ExecuteAsync() ``` {{< rawhtml >}}
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
{{< /rawhtml >}} ```C# public Task ExecuteAsync(CancellationToken cancellationToken) ``` {{< rawhtml >}}
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.

FaultBuffer(Exception)

Declaration
{{< /rawhtml >}} ```C# protected override void FaultBuffer(Exception e) ``` {{< rawhtml >}}
Parameters
Type Name Description
Exception e
Overrides

InitComponent()

Declaration
{{< /rawhtml >}} ```C# protected override void InitComponent() ``` {{< rawhtml >}}
Overrides

OnExecutionDoAsyncWork()

Declaration
{{< /rawhtml >}} ```C# protected abstract void OnExecutionDoAsyncWork() ``` {{< rawhtml >}}

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
{{< /rawhtml >}} ```C# public Task StartAsync(CancellationToken? cancellationToken = null) ``` {{< rawhtml >}}
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.

Implements

{{< /rawhtml >}}