TextFormat Class

Definition

The data stored in text format.

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

Constructors

TextFormat()

Initializes a new instance of TextFormat.

Properties

ColumnDelimiter

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

Deserializer

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

(Inherited from DatasetStorageFormat)
EncodingName

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

EscapeChar

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

FirstRowAsHeader

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

Item[String]

Gets or sets the element with the specified key.

(Inherited from DatasetStorageFormat)
Keys

Gets an ICollection<T> containing the keys of the IDictionary<TKey,TValue>.

(Inherited from DatasetStorageFormat)
NullValue

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

QuoteChar

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

RowDelimiter

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

Serializer

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

(Inherited from DatasetStorageFormat)
SkipLineCount

The number of lines/rows to be skipped when parsing text files. The default value is 0. Type: integer (or Expression with resultType integer).

TreatEmptyAsNull

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

Values

Gets an ICollection<T> containing the values in the IDictionary<TKey,TValue>.

(Inherited from DatasetStorageFormat)

Methods

Add(String, Object)

Adds an element with the provided key and value to the IDictionary<TKey,TValue>.

(Inherited from DatasetStorageFormat)
ContainsKey(String)

Determines whether the IDictionary<TKey,TValue> contains an element with the specified key.

(Inherited from DatasetStorageFormat)
GetEnumerator()

Returns an enumerator that iterates through the collection.

(Inherited from DatasetStorageFormat)
Remove(String)

Removes the element with the specified key from the IDictionary<TKey,TValue>.

(Inherited from DatasetStorageFormat)
TryGetValue(String, Object)

Gets the value associated with the specified key.

(Inherited from DatasetStorageFormat)

Explicit Interface Implementations

ICollection<KeyValuePair<String,Object>>.Add(KeyValuePair<String,Object>)

Adds an item to the ICollection<T>.

(Inherited from DatasetStorageFormat)
ICollection<KeyValuePair<String,Object>>.Clear()

Removes all items from the ICollection<T>.

(Inherited from DatasetStorageFormat)
ICollection<KeyValuePair<String,Object>>.Contains(KeyValuePair<String,Object>)

Determines whether the ICollection<T> contains a specific value.

(Inherited from DatasetStorageFormat)
ICollection<KeyValuePair<String,Object>>.CopyTo(KeyValuePair<String,Object>[], Int32)

Copies the elements of the ICollection<T> to an Array, starting at a particular Array index.

(Inherited from DatasetStorageFormat)
ICollection<KeyValuePair<String,Object>>.Count

Gets the number of elements contained in the ICollection<T>.

(Inherited from DatasetStorageFormat)
ICollection<KeyValuePair<String,Object>>.IsReadOnly

Gets a value indicating whether the ICollection<T> is read-only.

(Inherited from DatasetStorageFormat)
ICollection<KeyValuePair<String,Object>>.Remove(KeyValuePair<String,Object>)

Removes the first occurrence of a specific object from the ICollection<T>.

(Inherited from DatasetStorageFormat)
IEnumerable.GetEnumerator()

Returns an enumerator that iterates through a collection.

(Inherited from DatasetStorageFormat)

Extension Methods

GetValueOrAdd<TKey,TValue>(IDictionary<TKey,TValue>, TKey, Func<TKey,TValue>)

Gets or adds the value associated with specified key.

GetValueOrDefault<TKey,TValue>(IDictionary<TKey,TValue>, TKey, TValue)

Gets the value associated with specified key.

Applies to