Class DataDefinition

A DataDefinition object is used to maintain how data is defined and processed. It contains the Workspace.XBR.Xperiflow.Etl.IConnectionContext, Workspace.XBR.Xperiflow.Etl.IDataContainerContext, and Workspace.XBR.Xperiflow.Etl.IDataFormat 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"); `

Namespace: Workspace.XBR.Xperiflow.Etl

Assembly: Xperiflow.dll

Declaration

public class DataDefinition

Properties

ConnectionContext

The Workspace.XBR.Xperiflow.Etl.IConnectionContext property

Declaration

[JsonPropertyName("connectionContext")]
public IConnectionContext ConnectionContext { get; set; }

DataContainerContext

The Workspace.XBR.Xperiflow.Etl.IDataContainerContext property

Declaration

[JsonPropertyName("dataContainerContext")]
public IDataContainerContext DataContainerContext { get; set; }

DataFormat

The Workspace.XBR.Xperiflow.Etl.IDataFormat property

Declaration

[JsonPropertyName("dataFormat")]
public IDataFormat DataFormat { get; set; }

Methods

ToJson()

Serializes the Workspace.XBR.Xperiflow.Etl.DataDefinition object to a JSON string.

Declaration

public string ToJson()

Returns

System.String

A serialized representation of the DataDefinition

FromJson(string)

Deserializes a JSON string to a Workspace.XBR.Xperiflow.Etl.DataDefinition object.

Declaration

public static DataDefinition FromJson(string data)

Returns

Workspace.XBR.Xperiflow.Etl.DataDefinition

A Workspace.XBR.Xperiflow.Etl.DataDefinition

Parameters

Type	Name	Description
System.String	data	The JSON string representation of the DataDefinition

Exceptions

System.Text.Json.JsonException

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString