Show / Hide Table of Contents

Class JsonFormat

The data stored in JSON format.

Inheritance
System.Object
DatasetStorageFormat
JsonFormat
Inherited Members
DatasetStorageFormat.AdditionalProperties
DatasetStorageFormat.Deserializer
DatasetStorageFormat.Serializer
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.JsonFormat/JsonFormatConverter))]
public class JsonFormat : Azure.Analytics.Synapse.Artifacts.Models.DatasetStorageFormat

Constructors

JsonFormat()

Initializes a new instance of JsonFormat.

Declaration
public JsonFormat ();

Properties

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

Declaration
public object EncodingName { get; set; }
Property Value
System.Object

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.

Declaration
public object FilePattern { get; set; }
Property Value
System.Object

JsonNodeReference

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

Declaration
public object JsonNodeReference { get; set; }
Property Value
System.Object

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

Declaration
public object JsonPathDefinition { get; set; }
Property Value
System.Object

NestingSeparator

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

Declaration
public object NestingSeparator { get; set; }
Property Value
System.Object

Back to top Azure SDK for .NET