Share via


JsonFormat Class

Definition

The data stored in JSON format.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.JsonFormat+JsonFormatConverter))]
public class JsonFormat : Azure.Analytics.Synapse.Artifacts.Models.DatasetStorageFormat
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.JsonFormat+JsonFormatConverter))>]
type JsonFormat = class
    inherit DatasetStorageFormat
Public Class JsonFormat
Inherits DatasetStorageFormat
Inheritance
Attributes

Constructors

JsonFormat()

Initializes a new instance of JsonFormat.

Properties

AdditionalProperties

Additional Properties.

(Inherited from DatasetStorageFormat)
Deserializer

Deserializer. Type: string (or Expression with resultType string).

(Inherited from DatasetStorageFormat)
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).

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.

JsonNodeReference

The JSONPath of the JSON array element to be flattened. Example: "$.ArrayPath". Type: string (or Expression with resultType string).

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

NestingSeparator

The character used to separate nesting levels. Default value is '.' (dot). Type: string (or Expression with resultType string).

Serializer

Serializer. Type: string (or Expression with resultType string).

(Inherited from DatasetStorageFormat)

Applies to