Interface IDataConnector

Namespace

Datafication.Core.Connectors

Assembly

Datafication.Core.dll

Defines a contract for data connectors that can asynchronously retrieve sets of data records.

public interface IDataConnector

Extension Methods

DataConnectorExtensions.AsStorageConnector(IDataConnector)

DataConnectorExtensions.GetDataBatchesAsync(IDataConnector, int)

DataConnectorExtensions.GetSourceInfoAsync(IDataConnector)

Methods

GetConnectorId()

Gets the unique identifier for this data connector.

string GetConnectorId()

Returns

string

The unique identifier string for the connector.

GetDataAsync()

Retrieves a collection of data records asynchronously.

Task<DataBlock> GetDataAsync()

Returns

Task<DataBlock>

A task that represents the asynchronous operation. The value of the TResult parameter contains an DataBlock.

GetStorageDataAsync(IStorageDataBlock, int)

Retrieves data records and appends them in batches to the provided storage data block.

Task<IStorageDataBlock> GetStorageDataAsync(IStorageDataBlock target, int batchSize = 10000)

Parameters

target IStorageDataBlock

The storage data block to append batches to.

batchSize int

The maximum number of rows to accumulate before appending a batch. Defaults to 10000.

Returns

Task<IStorageDataBlock>

A task that represents the asynchronous operation. The value of the TResult parameter contains the provided IStorageDataBlock with all data appended.