JsonFormat Class

The data stored in JSON format.

Constructor

JsonFormat(*args: Any, **kwargs: Any)

Variables

Name	Description
serializer	any Serializer. Type: string (or Expression with resultType string).
deserializer	any Deserializer. Type: string (or Expression with resultType string).
file_pattern	any 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.
nesting_separator	any The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).
encoding_name	any 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).
json_node_reference	any The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).
json_path_definition	any 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).
type	str Type of dataset storage format. Required. Default value is "JsonFormat".

Attributes

encoding_name

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).

encoding_name: Any | None

file_pattern

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.

file_pattern: Any | None

json_node_reference

string (or Expression with resultType string).

json_node_reference: Any | None

json_path_definition

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).

json_path_definition: Any | None

nesting_separator

string (or Expression with resultType string).

nesting_separator: Any | None

type

Type of dataset storage format. Required. Default value is "JsonFormat".

type: Literal['JsonFormat']