JsonFormat interface
The data stored in JSON format.
- Extends
Properties
encoding |
The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string). |
file |
File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive. |
json |
The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string). |
json |
The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object). |
nesting |
The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string). |
type | Polymorphic discriminator, which specifies the different types this object can be |
Inherited Properties
deserializer | Deserializer. Type: string (or Expression with resultType string). |
serializer | Serializer. Type: string (or Expression with resultType string). |
Property Details
encodingName
The code page name of the preferred encoding. If not provided, the default value is 'utf-8', unless the byte order mark (BOM) denotes another Unicode encoding. The full list of supported values can be found in the 'Name' column of the table of encodings in the following reference: https://go.microsoft.com/fwlink/?linkid=861078. Type: string (or Expression with resultType string).
encodingName?: any
Property Value
any
filePattern
File pattern of JSON. To be more specific, the way of separating a collection of JSON objects. The default value is 'setOfObjects'. It is case-sensitive.
filePattern?: any
Property Value
any
jsonNodeReference
The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).
jsonNodeReference?: any
Property Value
any
jsonPathDefinition
The JSONPath definition for each column mapping with a customized column name to extract data from JSON file. For fields under root object, start with "$"; for fields inside the array chosen by jsonNodeReference property, start from the array element. Example: {"Column1": "$.Column1Path", "Column2": "Column2PathInArray"}. Type: object (or Expression with resultType object).
jsonPathDefinition?: any
Property Value
any
nestingSeparator
The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).
nestingSeparator?: any
Property Value
any
type
Polymorphic discriminator, which specifies the different types this object can be
type: "JsonFormat"
Property Value
"JsonFormat"
Inherited Property Details
deserializer
Deserializer. Type: string (or Expression with resultType string).
deserializer?: any
Property Value
any
Inherited From DatasetStorageFormat.deserializer
serializer
Serializer. Type: string (or Expression with resultType string).
serializer?: any
Property Value
any
Inherited From DatasetStorageFormat.serializer