DelimitedTextDataset Class

Delimited text dataset.

All required parameters must be populated in order to send to Azure.

Inheritance

azure.synapse.artifacts.models._models_py3.Dataset

DelimitedTextDataset

Constructor

DelimitedTextDataset(*, linked_service_name: azure.synapse.artifacts.models._models_py3.LinkedServiceReference, additional_properties: Optional[Dict[str, object]] = None, description: Optional[str] = None, structure: Optional[object] = None, schema: Optional[object] = None, parameters: Optional[Dict[str, azure.synapse.artifacts.models._models_py3.ParameterSpecification]] = None, annotations: Optional[List[object]] = None, folder: Optional[azure.synapse.artifacts.models._models_py3.DatasetFolder] = None, location: Optional[azure.synapse.artifacts.models._models_py3.DatasetLocation] = None, column_delimiter: Optional[object] = None, row_delimiter: Optional[object] = None, encoding_name: Optional[object] = None, compression_codec: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DelimitedTextCompressionCodec]] = None, compression_level: Optional[Union[str, azure.synapse.artifacts.models._artifacts_client_enums.DatasetCompressionLevel]] = None, quote_char: Optional[object] = None, escape_char: Optional[object] = None, first_row_as_header: Optional[object] = None, null_value: Optional[object] = None, **kwargs)

Parameters

additional_properties

dict[str, object]

Required

Unmatched properties from the message are deserialized to this collection.

type

str

Required

Required. Type of dataset.Constant filled by server.

description

str

Required

Dataset description.

structure

object

Required

Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement.

schema

object

Required

Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement.

linked_service_name

LinkedServiceReference

Required

Required. Linked service reference.

parameters

dict[str, ParameterSpecification]

Required

Parameters for dataset.

annotations

list[object]

Required

List of tags that can be used for describing the Dataset.

folder

DatasetFolder

Required

The folder that this Dataset is in. If not specified, Dataset will appear at the root level.

location

DatasetLocation

Required

The location of the delimited text storage.

column_delimiter

object

Required

The column delimiter. Type: string (or Expression with resultType string).

row_delimiter

object

Required

The row delimiter. Type: string (or Expression with resultType string).

encoding_name

object

Required

The code page name of the preferred encoding. If miss, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string).

compression_codec

str or DelimitedTextCompressionCodec

Required

Possible values include: "bzip2", "gzip", "deflate", "zipDeflate", "snappy", "lz4".

compression_level

str or DatasetCompressionLevel

Required

The data compression method used for DelimitedText. Possible values include: "Optimal", "Fastest".

quote_char

object

Required

The quote character. Type: string (or Expression with resultType string).

escape_char

object

Required

The escape character. Type: string (or Expression with resultType string).

first_row_as_header

object

Required

When used as input, treat the first row of data as headers. When used as output,write the headers into the output as the first row of data. The default value is false. Type: boolean (or Expression with resultType boolean).

null_value

object

Required

The null value string. Type: string (or Expression with resultType string).