ExcelDataset Class
Excel dataset.
All required parameters must be populated in order to send to server.
Constructor
ExcelDataset(*, 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, sheet_name: MutableMapping[str, Any] | None = None, sheet_index: MutableMapping[str, Any] | None = None, range: MutableMapping[str, Any] | None = None, first_row_as_header: MutableMapping[str, Any] | None = None, compression: _models.DatasetCompression | None = None, null_value: MutableMapping[str, Any] | None = None, **kwargs: Any)Keyword-Only Parameters
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. Default value: None
|
|
description
|
Dataset description. Default value: None
|
|
structure
|
<xref:JSON>
Columns that define the structure of the dataset. Type: array (or Expression with resultType array), itemType: DatasetDataElement. Default value: None
|
|
schema
|
<xref:JSON>
Columns that define the physical type schema of the dataset. Type: array (or Expression with resultType array), itemType: DatasetSchemaDataElement. Default value: None
|
|
linked_service_name
|
Linked service reference. Required. |
|
parameters
|
Parameters for dataset. Default value: None
|
|
annotations
|
list[<xref:JSON>]
List of tags that can be used for describing the Dataset. Default value: None
|
|
folder
|
The folder that this Dataset is in. If not specified, Dataset will appear at the root level. Default value: None
|
|
location
|
The location of the excel storage. Default value: None
|
|
sheet_name
|
<xref:JSON>
The sheet name of excel file. Type: string (or Expression with resultType string). Default value: None
|
|
sheet_index
|
<xref:JSON>
The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer). Default value: None
|
|
range
|
<xref:JSON>
The partial data of one sheet. Type: string (or Expression with resultType string). Default value: None
|
|
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). Default value: None
|
|
compression
|
The data compression method used for the json dataset. Default value: None
|
|
null_value
|
<xref:JSON>
The null value string. Type: string (or Expression with resultType string). Default value: None
|
Variables
| Name | Description |
|---|---|
|
additional_properties
|
Unmatched properties from the message are deserialized to this collection. |
|
type
|
Type of dataset. Required. |
|
description
|
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 excel storage. |
|
sheet_name
|
<xref:JSON>
The sheet name of excel file. Type: string (or Expression with resultType string). |
|
sheet_index
|
<xref:JSON>
The sheet index of excel file and default value is 0. Type: integer (or Expression with resultType integer). |
|
range
|
<xref:JSON>
The partial data of one sheet. 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). |
|
compression
|
The data compression method used for the json dataset. |
|
null_value
|
<xref:JSON>
The null value string. Type: string (or Expression with resultType string). |
