Package com.azure.analytics.synapse.artifacts.models

Class TabularTranslator

  • public final class TabularTranslator
extends CopyTranslator
    A copy activity tabular translator.

    • Constructor Detail

      • TabularTranslator

        public TabularTranslator()

    • Method Detail

      • getColumnMappings

        public Object getColumnMappings()
        Get the columnMappings property: 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.
        Returns:
        the columnMappings value.

      • setColumnMappings

        public TabularTranslator setColumnMappings​(Object columnMappings)
        Set the columnMappings property: 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.
        Parameters:
        columnMappings - the columnMappings value to set.
        Returns:
        the TabularTranslator object itself.

      • getSchemaMapping

        public Object getSchemaMapping()
        Get the schemaMapping property: 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.
        Returns:
        the schemaMapping value.

      • setSchemaMapping

        public TabularTranslator setSchemaMapping​(Object schemaMapping)
        Set the schemaMapping property: 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.
        Parameters:
        schemaMapping - the schemaMapping value to set.
        Returns:
        the TabularTranslator object itself.

      • getCollectionReference

        public Object getCollectionReference()
        Get the collectionReference property: The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).
        Returns:
        the collectionReference value.

      • setCollectionReference

        public TabularTranslator setCollectionReference​(Object collectionReference)
        Set the collectionReference property: The JSON Path of the Nested Array that is going to do cross-apply. Type: object (or Expression with resultType object).
        Parameters:
        collectionReference - the collectionReference value to set.
        Returns:
        the TabularTranslator object itself.

      • getMapComplexValuesToString

        public Object getMapComplexValuesToString()
        Get the mapComplexValuesToString property: Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).
        Returns:
        the mapComplexValuesToString value.

      • setMapComplexValuesToString

        public TabularTranslator setMapComplexValuesToString​(Object mapComplexValuesToString)
        Set the mapComplexValuesToString property: Whether to map complex (array and object) values to simple strings in json format. Type: boolean (or Expression with resultType boolean).
        Parameters:
        mapComplexValuesToString - the mapComplexValuesToString value to set.
        Returns:
        the TabularTranslator object itself.

      • getMappings

        public Object getMappings()
        Get the mappings property: 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"}}]. Hierarchical->tabular example: [{"source":{"path":"$.CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$.CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. Type: object (or Expression with resultType object).
        Returns:
        the mappings value.

      • setMappings

        public TabularTranslator setMappings​(Object mappings)
        Set the mappings property: 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"}}]. Hierarchical->tabular example: [{"source":{"path":"$.CustomerName","type":"String"},"sink":{"name":"ClientName","type":"String"}},{"source":{"path":"$.CustomerAddress","type":"String"},"sink":{"name":"ClientAddress","type":"String"}}]. Type: object (or Expression with resultType object).
        Parameters:
        mappings - the mappings value to set.
        Returns:
        the TabularTranslator object itself.

      • getTypeConversion

        public Object getTypeConversion()
        Get the typeConversion property: Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).
        Returns:
        the typeConversion value.

      • setTypeConversion

        public TabularTranslator setTypeConversion​(Object typeConversion)
        Set the typeConversion property: Whether to enable the advanced type conversion feature in the Copy activity. Type: boolean (or Expression with resultType boolean).
        Parameters:
        typeConversion - the typeConversion value to set.
        Returns:
        the TabularTranslator object itself.

      • getTypeConversionSettings

        public TypeConversionSettings getTypeConversionSettings()
        Get the typeConversionSettings property: Type conversion settings.
        Returns:
        the typeConversionSettings value.

      • setTypeConversionSettings

        public TabularTranslator setTypeConversionSettings​(TypeConversionSettings typeConversionSettings)
        Set the typeConversionSettings property: Type conversion settings.
        Parameters:
        typeConversionSettings - the typeConversionSettings value to set.
        Returns:
        the TabularTranslator object itself.