DelimitedTextDataset Class

Delimited text dataset.

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

Inheritance
azure.mgmt.datafactory.models._models_py3.Dataset
DelimitedTextDataset

Constructor

DelimitedTextDataset(*, linked_service_name: _models.LinkedServiceReference, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, description: str | None = None, structure: MutableMapping[str, Any] | None = None, schema: MutableMapping[str, Any] | None = None, parameters: Dict[str, _models.ParameterSpecification] | None = None, annotations: List[MutableMapping[str, Any]] | None = None, folder: _models.DatasetFolder | None = None, location: _models.DatasetLocation | None = None, column_delimiter: MutableMapping[str, Any] | None = None, row_delimiter: MutableMapping[str, Any] | None = None, encoding_name: MutableMapping[str, Any] | None = None, compression_codec: MutableMapping[str, Any] | None = None, compression_level: MutableMapping[str, Any] | None = None, quote_char: MutableMapping[str, Any] | None = None, escape_char: MutableMapping[str, Any] | None = None, first_row_as_header: MutableMapping[str, Any] | None = None, null_value: MutableMapping[str, Any] | None = None, **kwargs: Any)

Keyword-Only Parameters

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

description
str

Dataset description.

structure
<xref:JSON>

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

schema
<xref:JSON>

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

linked_service_name

Linked service reference. Required.

parameters

Parameters for dataset.

annotations
list[<xref:JSON>]

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

folder

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

location

The location of the delimited text storage.

column_delimiter
<xref:JSON>

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

row_delimiter
<xref:JSON>

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

encoding_name
<xref:JSON>

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
<xref:JSON>

The data compressionCodec. Type: string (or Expression with resultType string).

compression_level
<xref:JSON>

The data compression method used for DelimitedText.

quote_char
<xref:JSON>

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

escape_char
<xref:JSON>

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

first_row_as_header
<xref:JSON>

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
<xref:JSON>

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

Variables

Name Description
additional_properties
dict[str, <xref:JSON>]

Unmatched properties from the message are deserialized to this collection.

type
str

Type of dataset. Required.

description
str

Dataset description.

structure
<xref:JSON>

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

schema
<xref:JSON>

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

linked_service_name

Linked service reference. Required.

parameters

Parameters for dataset.

annotations
list[<xref:JSON>]

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

folder

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

location

The location of the delimited text storage.

column_delimiter
<xref:JSON>

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

row_delimiter
<xref:JSON>

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

encoding_name
<xref:JSON>

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
<xref:JSON>

The data compressionCodec. Type: string (or Expression with resultType string).

compression_level
<xref:JSON>

The data compression method used for DelimitedText.

quote_char
<xref:JSON>

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

escape_char
<xref:JSON>

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

first_row_as_header
<xref:JSON>

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
<xref:JSON>

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