Interface ITabularEtlManager

Defines a contract for managing the extraction and loading of tabular data.

Using an Workspace.XBR.Xperiflow.Etl.Tabular.ITabularEtlManager, you can extract data from a source and load it into a destination in separate steps, or with a call to ExtractAndLoad(). Use the XBRApi to instantiate a Workspace.XBR.Xperiflow.Etl.Tabular.ITabularEtlManager. For example:

Example:

` var etlManager = XBRApi.Etl.GetTabularEtlManager(si); `

Example:

` var dataReader = etlManager.ExtractDataReader(sourceData); `

Example:

` etlManager.Load(destinationData, dataReader) `

• OR more simply -

Example:

` etlManager.ExtractAndLoad(sourceDataDefinition, destinationDataDefinition); `

Namespace: Workspace.XBR.Xperiflow.Etl.Tabular

Assembly: Xperiflow.dll

Declaration

public interface ITabularEtlManager

Derived: Workspace.XBR.Xperiflow.Etl.Tabular.TabularEtlManager

Methods

ExtractDataReader(DataDefinition)

Extracts data from a Workspace.XBR.Xperiflow.Etl.DataDefinition as an IDataReader, for example:

Example:

` var dataReader = etlManager.ExtractDataReader(sourceDataDefinition); `

Declaration

IDataReader ExtractDataReader(DataDefinition sourceDataDefinition)

Returns

System.Data.IDataReader

An IDataReader object

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Etl.DataDefinition	sourceDataDefinition	The Workspace.XBR.Xperiflow.Etl.DataDefinition object to extract data from

ExtractDataReader(string)

Extracts data from a JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinition as an IDataReader, for example:

Example:

` var dataReader = etlManager.ExtractDataReader(jsonSource); `

Declaration

IDataReader ExtractDataReader(string sourceDataDefinition)

Returns

System.Data.IDataReader

An IDataReader object

Parameters

Type	Name	Description
System.String	sourceDataDefinition	The JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinition object to extract data from

ExtractDataTable(DataDefinition)

Extracts data from a Workspace.XBR.Xperiflow.Etl.DataDefinition as a DataTable, for example:

Example:

` var dt = etlManager.ExtractDataTable(sourceDataDefinition);`

Declaration

DataTable ExtractDataTable(DataDefinition sourceDataDefinition)

Returns

System.Data.DataTable

A DataTable object containing the data defined by the sourceDataDefinition

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Etl.DataDefinition	sourceDataDefinition	The Workspace.XBR.Xperiflow.Etl.DataDefinition object to extract data from

ExtractDataTable(string)

Extracts data from a JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinition as a DataTable, for example:

Example:

` var dt = etlManager.ExtractDataTable(jsonSource);`

Declaration

DataTable ExtractDataTable(string sourceDataDefinition)

Returns

System.Data.DataTable

A DataTable object containing the data defined by the sourceDataDefinition

Parameters

Type	Name	Description
System.String	sourceDataDefinition	The JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinition object to extract data from

Load(DataDefinition, DataTable)

Writes data from a DataTable to a destination Workspace.XBR.Xperiflow.Etl.DataDefinition, for example:

Example:

` etlManager.Load(destinationDataDefinition, dt); `

Declaration

void Load(DataDefinition destinationDataDefinition, DataTable dt)

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Etl.DataDefinition	destinationDataDefinition	The Workspace.XBR.Xperiflow.Etl.DataDefinition object to load data into
System.Data.DataTable	dt	The DataTable object containing the data to load

Load(DataDefinition, IDataReader)

Writes data from an IDataReader to a destination Workspace.XBR.Xperiflow.Etl.DataDefinition, for example:

Example:

` etlManager.Load(destinationDataDefinition, reader); `

Declaration

void Load(DataDefinition destinationDataDefinition, IDataReader reader)

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Etl.DataDefinition	destinationDataDefinition	The Workspace.XBR.Xperiflow.Etl.DataDefinition object to load data into
System.Data.IDataReader	reader	The IDataReader object containing the data to load

Load(string, DataTable)

Writes data from a DataTable to a JSON serialized destination Workspace.XBR.Xperiflow.Etl.DataDefinition, for example:

Example:

` etlManager.Load(destinationJSON, dt); `

Declaration

void Load(string destinationDataDefinition, DataTable dt)

Parameters

Type	Name	Description
System.String	destinationDataDefinition	The JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinition object to load data into
System.Data.DataTable	dt	The DataTable object containing the data to load

Load(string, IDataReader)

Writes data from an IDataReader to a JSON serialized destination Workspace.XBR.Xperiflow.Etl.DataDefinition, for example:

Example:

` etlManager.Load(destinationJSON, reader); `

Declaration

void Load(string destinationDataDefinition, IDataReader reader)

Parameters

Type	Name	Description
System.String	destinationDataDefinition	The JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinition object to load data into
System.Data.IDataReader	reader	The IDataReader object containing the data to load

ExtractAndLoad(DataDefinition, DataDefinition)

Extracts data from a source Workspace.XBR.Xperiflow.Etl.DataDefinition and loads it into a destination Workspace.XBR.Xperiflow.Etl.DataDefinition, for example:

Example:

` etlManager.ExtractAndLoad(sourceDataDefinition, destinationDataDefinition); `

Declaration

void ExtractAndLoad(DataDefinition sourceDataDefinition, DataDefinition destinationDataDefinition)

Remarks

Note: This method does not support loading from and extracting to JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinitions. However, if you have JSON serialized Workspace.XBR.Xperiflow.Etl.DataDefinitions, you can instantiate Workspace.XBR.Xperiflow.Etl.DataDefinition objects using Workspace.XBR.Xperiflow.Etl.DataDefinition

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Etl.DataDefinition	sourceDataDefinition	The Workspace.XBR.Xperiflow.Etl.DataDefinition object to extract data from
Workspace.XBR.Xperiflow.Etl.DataDefinition	destinationDataDefinition	The Workspace.XBR.Xperiflow.Etl.DataDefinition object to load data into