Share via

TabularTranslator Class

  • Reference

A copy activity tabular translator.

All required parameters must be populated in order to send to server.

Inheritance
azure.mgmt.datafactory.models._models_py3.CopyTranslator
TabularTranslator

Constructor

TabularTranslator(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, column_mappings: MutableMapping[str, Any] | None = None, schema_mapping: MutableMapping[str, Any] | None = None, collection_reference: MutableMapping[str, Any] | None = None, map_complex_values_to_string: MutableMapping[str, Any] | None = None, mappings: MutableMapping[str, Any] | None = None, type_conversion: MutableMapping[str, Any] | None = None, type_conversion_settings: _models.TypeConversionSettings | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
column_mappings
<xref:JSON>

Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property.
schema_mapping
<xref:JSON>

The schema mapping to map between tabular data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property.
collection_reference
<xref:JSON>

The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).
map_complex_values_to_string
<xref:JSON>

Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).
mappings
<xref:JSON>

Column mappings with logical types. Tabular->tabular example: [{"source":{"name":"CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"name":"CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. # pylint: disable=line-too-long Hierarchical->tabular example: [{"source":{"path":"$.CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$.CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. # pylint: disable=line-too-long Type: object (or Expression with resultType object).
type_conversion
<xref:JSON>

Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).
type_conversion_settings
TypeConversionSettings

Type conversion settings.

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.
type
str

Copy translator type. Required.
column_mappings
<xref:JSON>

Column mappings. Example: "UserId: MyUserId, Group: MyGroup, Name: MyName" Type: string (or Expression with resultType string). This property will be retired. Please use mappings property.
schema_mapping
<xref:JSON>

The schema mapping to map between tabular data and hierarchical data. Example: {"Column1": "$.Column1", "Column2": "$.Column2.Property1", "Column3": "$.Column2.Property2"}. Type: object (or Expression with resultType object). This property will be retired. Please use mappings property.
collection_reference
<xref:JSON>

The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).
map_complex_values_to_string
<xref:JSON>

Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).
mappings
<xref:JSON>

Column mappings with logical types. Tabular->tabular example: [{"source":{"name":"CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"name":"CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. # pylint: disable=line-too-long Hierarchical->tabular example: [{"source":{"path":"$.CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$.CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. # pylint: disable=line-too-long Type: object (or Expression with resultType object).
type_conversion
<xref:JSON>

Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).
type_conversion_settings
TypeConversionSettings

Type conversion settings.