Tables - Load Table
Note
This API is in preview.
Starts a load table operation and returns the operation status URL in the response location header.
This API supports long running operations (LRO).
Permissions
Write permission to the lakehouse item.
Required Delegated Scopes
Lakehouse.ReadWrite.All
Microsoft Entra supported identities
This API supports the Microsoft identities listed in this section.
Identity | Support |
---|---|
User | Yes |
Service principal and Managed identities | Yes |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables/{tableName}/load
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
lakehouse
|
path | True |
string uuid |
The lakehouse item ID. |
table
|
path | True |
string |
The table name. Regex pattern: |
workspace
|
path | True |
string uuid |
The workspace ID. |
Request Body
Name | Required | Type | Description |
---|---|---|---|
pathType | True |
The type of |
|
relativePath | True |
string |
The relative path of the data file or folder. |
fileExtension |
string |
The file extension of the data file. |
|
formatOptions | FileFormatOptions: |
Abstract type of data file format options. |
|
mode |
The load table operation mode, overwrite or append. Additional mode types may be added over time. |
||
recursive |
boolean |
Indicates whether to search data files recursively or not, when loading a table from a folder. |
Responses
Name | Type | Description |
---|---|---|
202 Accepted |
Request accepted, load table operation is in progress. Headers
|
|
Other Status Codes |
Common error codes:
|
Examples
Load table operation Example
Sample request
POST https://api.fabric.microsoft.com/v1/workspaces/f089354e-8366-4e18-aea3-4cb4a3a50b48/lakehouses/41ce06d1-d81b-4ea0-bc6d-2ce3dd2f8e87/tables/abc123/load
{
"relativePath": "Files/abc/abc123.csv",
"pathType": "File",
"mode": "Overwrite",
"recursive": false,
"formatOptions": {
"format": "Csv",
"header": true,
"delimiter": ","
}
}
Sample response
Location: https://api.fabric.microsoft.com/v1/operations/abcdef00-9d7e-469a-abf1-fca847a0ea69
x-ms-operation-id: abcdef00-9d7e-469a-abf1-fca847a0ea69
Retry-After: 30
Definitions
Name | Description |
---|---|
Csv |
CSV format options for CSV files. |
Error |
The error related resource details object. |
Error |
The error response. |
Error |
The error response details. |
Load |
Represents a load table operation request. |
Mode |
The load table operation mode, overwrite or append. Additional mode types may be added over time. |
Parquet |
Format options for Parquet files. |
Path |
The type of |
Csv
CSV format options for CSV files.
Name | Type | Description |
---|---|---|
delimiter |
string |
The delimiter of CSV file. |
format | string: |
Data file format name. Additional file format types may be added over time. |
header |
boolean |
This property indicates whether the CSV data file contains a header line or not. |
ErrorRelatedResource
The error related resource details object.
Name | Type | Description |
---|---|---|
resourceId |
string |
The resource ID that's involved in the error. |
resourceType |
string |
The type of the resource that's involved in the error. |
ErrorResponse
The error response.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
moreDetails |
List of additional error details. |
|
relatedResource |
The error related resource details. |
|
requestId |
string |
ID of the request associated with the error. |
ErrorResponseDetails
The error response details.
Name | Type | Description |
---|---|---|
errorCode |
string |
A specific identifier that provides information about an error condition, allowing for standardized communication between our service and its users. |
message |
string |
A human readable representation of the error. |
relatedResource |
The error related resource details. |
LoadTableRequest
Represents a load table operation request.
Name | Type | Description |
---|---|---|
fileExtension |
string |
The file extension of the data file. |
formatOptions | FileFormatOptions: |
Abstract type of data file format options. |
mode |
The load table operation mode, overwrite or append. Additional mode types may be added over time. |
|
pathType |
The type of |
|
recursive |
boolean |
Indicates whether to search data files recursively or not, when loading a table from a folder. |
relativePath |
string |
The relative path of the data file or folder. |
ModeType
The load table operation mode, overwrite or append. Additional mode types may be added over time.
Name | Type | Description |
---|---|---|
Append |
string |
load table in append mode. |
Overwrite |
string |
load table in overwrite mode. |
Parquet
Format options for Parquet files.
Name | Type | Description |
---|---|---|
format | string: |
Data file format name. Additional file format types may be added over time. |
PathType
The type of relativePath
, either file or folder. Additional PathType
types may be added over time.
Name | Type | Description |
---|---|---|
File |
string |
load table from file. |
Folder |
string |
load table from folder. |