Share via

TextFormat Class

  • Reference

The data stored in text format.

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

Inheritance
azure.mgmt.datafactory.models._models_py3.DatasetStorageFormat
TextFormat

Constructor

TextFormat(*, additional_properties: Dict[str, MutableMapping[str, Any]] | None = None, serializer: MutableMapping[str, Any] | None = None, deserializer: MutableMapping[str, Any] | None = None, column_delimiter: MutableMapping[str, Any] | None = None, row_delimiter: MutableMapping[str, Any] | None = None, escape_char: MutableMapping[str, Any] | None = None, quote_char: MutableMapping[str, Any] | None = None, null_value: MutableMapping[str, Any] | None = None, encoding_name: MutableMapping[str, Any] | None = None, treat_empty_as_null: MutableMapping[str, Any] | None = None, skip_line_count: MutableMapping[str, Any] | None = None, first_row_as_header: 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.
serializer
<xref:JSON>

Serializer. Type: string (or Expression with resultType string).
deserializer
<xref:JSON>

Deserializer. Type: string (or Expression with resultType string).
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).
escape_char
<xref:JSON>

The escape character. Type: string (or Expression with resultType string).
quote_char
<xref:JSON>

The quote character. Type: string (or Expression with resultType string).
null_value
<xref:JSON>

The null value string. 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).
treat_empty_as_null
<xref:JSON>

Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).
skip_line_count
<xref:JSON>

The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
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).

Variables

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

Unmatched properties from the message are deserialized to this collection.
type
str

Type of dataset storage format. Required.
serializer
<xref:JSON>

Serializer. Type: string (or Expression with resultType string).
deserializer
<xref:JSON>

Deserializer. Type: string (or Expression with resultType string).
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).
escape_char
<xref:JSON>

The escape character. Type: string (or Expression with resultType string).
quote_char
<xref:JSON>

The quote character. Type: string (or Expression with resultType string).
null_value
<xref:JSON>

The null value string. 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).
treat_empty_as_null
<xref:JSON>

Treat empty column values in the text file as null. The default value is true. Type: boolean (or Expression with resultType boolean).
skip_line_count
<xref:JSON>

The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).
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).