ExcelDataset Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Excel dataset.
[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.ExcelDataset+ExcelDatasetConverter))]
public class ExcelDataset : Azure.Analytics.Synapse.Artifacts.Models.Dataset[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.ExcelDataset+ExcelDatasetConverter))>]
type ExcelDataset = class
inherit DatasetPublic Class ExcelDataset
Inherits Dataset- Inheritance
- Attributes
Constructors
| ExcelDataset(LinkedServiceReference) |
Initializes a new instance of ExcelDataset. |
Properties
| AdditionalProperties |
Additional Properties. (Inherited from Dataset) |
| Annotations |
List of tags that can be used for describing the Dataset. (Inherited from Dataset) |
| Compression |
The data compression method used for the json dataset. |
| Description |
Dataset description. (Inherited from Dataset) |
| 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). |
| Folder |
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. (Inherited from Dataset) |
| LinkedServiceName |
Linked service reference. (Inherited from Dataset) |
| 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. |
| NullValue |
The null value string. Type: string (or Expression with resultType string). |
| Parameters |
Parameters for dataset. (Inherited from Dataset) |
| Range |
The partial data of one sheet. Type: string (or Expression with resultType string). |
| Schema |
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. (Inherited from Dataset) |
| SheetIndex |
The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer). |
| SheetName |
The sheet name of excel file. Type: string (or Expression with resultType string). |
| Structure |
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. (Inherited from Dataset) |
