Namespace Workspace.XBR.Xperiflow.Etl

Classes

CsvDataFormat

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IDataFormat](../Xperiflow.Etl/IDataFormat.md) interface that represents a CSV file.

DataDefinition

A DataDefinition object is used to maintain how data is defined and processed. It contains the [Workspace.XBR.Xperiflow.Etl.IConnectionContext](../Xperiflow.Etl/IConnectionContext.md), [Workspace.XBR.Xperiflow.Etl.IDataContainerContext](../Xperiflow.Etl/IDataContainerContext.md), and [Workspace.XBR.Xperiflow.Etl.IDataFormat](../Xperiflow.Etl/IDataFormat.md) properties.

The DataDefinition is used heavily in the ETL process to define how to process data, typically with a Source DataDefinition and a Destination DataDefinition.

DataDefinition objects can be created easily using the XBRApi as follows:

Example:

` var dataDefinition = XBRApi.Etl.CreateDataDefinition(si, connectionContext, dataContainerContext);`

Or more specifically when you know the type you need:

Example:

` var dataDefinition = XBRApi.Etl.CreateOneStreamSqlConnectionDataDefinition(si, "BiBlendWarehouse", "MyTable"); `

DataDefinitionFactory

The DataDefinitionFactory class is a factory class that creates a [Workspace.XBR.Xperiflow.Etl.DataDefinition](../Xperiflow.Etl/DataDefinition.md) objects based on the [Workspace.XBR.Xperiflow.Etl.IConnectionContext](../Xperiflow.Etl/IConnectionContext.md) and [Workspace.XBR.Xperiflow.Etl.IDataContainerContext](../Xperiflow.Etl/IDataContainerContext.md). Implements the [Workspace.XBR.Xperiflow.Etl.IDataDefinitionFactory](../Xperiflow.Etl/IDataDefinitionFactory.md) interface.

FileDataFormatFactory

The FileDataFormatFactory class is a factory class that creates [Workspace.XBR.Xperiflow.Etl.IDataFormat](../Xperiflow.Etl/IDataFormat.md) objects based on the file extension. Implements the [Workspace.XBR.Xperiflow.Etl.IFileDataFormatFactory](../Xperiflow.Etl/IFileDataFormatFactory.md) interface.

FilePathDataContainerContext

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IDataContainerContext](../Xperiflow.Etl/IDataContainerContext.md) interface that represents a file path.

LocalFileSystemConnector

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IFileConnector](../Xperiflow.Etl/IFileConnector.md) interface that reads and writes files from the local file system.

MetaFileSystemConnectionContext

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IConnectionContext](../Xperiflow.Etl/IConnectionContext.md) interface that is used to connect to a MetaFileSystem.

MetaFileSystemConnector

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IFileConnector](../Xperiflow.Etl/IFileConnector.md) interface that reads and writes files from the MetaFileSystem.

OneStreamFileSystemConnectionContext

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IConnectionContext](../Xperiflow.Etl/IConnectionContext.md) interface that is used to connect to a OneStream file system.

OneStreamFileSystemConnector

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IFileConnector](../Xperiflow.Etl/IFileConnector.md) interface that reads and writes files from the OneStream file system.

OneStreamSqlConnectionContext

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IConnectionContext](../Xperiflow.Etl/IConnectionContext.md) interface that is used to connect to a OneStream SQL database.

ParquetDataFormat

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IDataFormat](../Xperiflow.Etl/IDataFormat.md) interface that represents a Parquet file.

SqlDataFormat

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IDataFormat](../Xperiflow.Etl/IDataFormat.md) interface that represents a SQL data format.

SqlQueryDataContainerContext

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IDataContainerContext](../Xperiflow.Etl/IDataContainerContext.md) interface that represents a SQL query.

TableDataContainerContext

A concrete implementation of the [Workspace.XBR.Xperiflow.Etl.IDataContainerContext](../Xperiflow.Etl/IDataContainerContext.md) interface that represents a table.

UnstructuredDataFormat

Any unstructured data format. Examples include, TXT, JSON, XML, PNG, PDF, etc. Basically, any data format that does not have a standard well-defined structure will be considered "unstructured".

Interfaces

IConnectionContext

Defines a contract for connecting to a data source. One of three requirements in defining / properties of a [Workspace.XBR.Xperiflow.Etl.DataDefinition](../Xperiflow.Etl/DataDefinition.md)

IDataContainerContext

Defines a contract for data container contexts, providing information on how the data is stored. One of three requirements in defining / properties of a [Workspace.XBR.Xperiflow.Etl.DataDefinition](../Xperiflow.Etl/DataDefinition.md)

IDataDefinitionFactory

A factory that creates a Workspace.XBR.Xperiflow.Etl.DataDefinition based on the provided Workspace.XBR.Xperiflow.Etl.IConnectionContext and Workspace.XBR.Xperiflow.Etl.IDataContainerContext.

IDataFormat

The DTO interface that is used to represent a data format. This is used to define the format of the data that is being processed so that the data can be processed correctly. One of the three requirements in defining / properties of a [Workspace.XBR.Xperiflow.Etl.DataDefinition](../Xperiflow.Etl/DataDefinition.md)

IExtractor<T>

Defines the contract for extracting data from various sources in ETL (Extract, Transform, Load) operations.

IFileConnector

Defines a contract for file handling, enabling reading from and writing to a file.

IFileDataFormatFactory

An interface that is used to create a Workspace.XBR.Xperiflow.Etl.IDataFormat based on the file-like data.

ILoader<T>

Defines the contract for loading (storing) data into various destinations in ETL (Extract, Transform, Load) operations.

Enums

DataEngineType

An enum representing the different types of data sources that can be connected to.