Class ExcelDataset

Excel dataset.

Inheritance
System.Object
Dataset
ExcelDataset
Inherited Members
Namespace: System.Dynamic.ExpandoObject
Assembly: Azure.Analytics.Synapse.Artifacts.dll
Syntax
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.ExcelDataset/ExcelDatasetConverter))]
public class ExcelDataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset

Constructors

ExcelDataset(LinkedServiceReference)

Initializes a new instance of ExcelDataset.

Declaration
public ExcelDataset (Azure.Analytics.Synapse.Artifacts.Models.LinkedServiceReference linkedServiceName);
Parameters
LinkedServiceReference linkedServiceName

Linked service reference.
Exceptions
System.ArgumentNullException

linkedServiceName is null.

Properties

Compression

The data compression method used for the json dataset.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.DatasetCompression Compression { get; set; }
Property Value
DatasetCompression

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

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

Location

The location of the excel storage. Please note DatasetLocation is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include AmazonS3Location, AzureBlobFSLocation, AzureBlobStorageLocation, AzureDataLakeStoreLocation, AzureFileStorageLocation, FileServerLocation, FtpServerLocation, GoogleCloudStorageLocation, HdfsLocation, HttpServerLocation, LakeHouseLocation and SftpLocation.

Declaration
public Azure.Analytics.Synapse.Artifacts.Models.DatasetLocation Location { get; set; }
Property Value
DatasetLocation

NullValue

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

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

Range

The partial data of one sheet. Type: string (or Expression with resultType string).

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

SheetIndex

The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer).

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

SheetName

The sheet name of excel file. Type: string (or Expression with resultType string).

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