通过

Tables - Load Table

服务:
Lakehouse
API 版本:
v1

启动加载表作，并在响应位置标头中返回作状态 URL。

Note

此 API 是预览版的一部分，仅用于评估和开发目的。 它可能会根据反馈进行更改，不建议将其用于生产。

此 API 支持 长时间运行的作（LRO）。

Permissions

对 Lakehouse 项的写入权限。

所需的委派范围

Lakehouse.ReadWrite.All

Microsoft Entra 支持的标识

此 API 支持本节中列出的Microsoft 标识。

Identity Support
User Yes
服务主体和托管标识 Yes

Interface

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables/{tableName}/load

URI 参数

名称 在 必需 类型 说明
lakehouseId
 path True

string (uuid)

Lakehouse 项 ID。
tableName
 path True

string

pattern: ^(?=[0-9]*[a-zA-Z_])[a-zA-Z0-9_]{1,256}$

表名称。
workspaceId
 path True

string (uuid)

工作区 ID。

请求正文

名称 必需 类型 说明
pathType True

PathType

文件或文件夹的类型 relativePath。 可能会随着时间的推移添加其他 PathType 类型。
relativePath True

string

pattern: ^Files(\/[\p{L}\w]{1}([ \p{L}\w\.-]*[\p{L}\w\.-]{1})*)*$

数据文件或文件夹的相对路径。
fileExtension

string

pattern: ^[a-zA-Z0-9_-]{1,16}$

数据文件的文件扩展名。
formatOptions FileFormatOptions:

数据文件格式选项的抽象类型。
mode

ModeType

加载表作模式，覆盖或追加。 可能会随着时间的推移添加其他模式类型。
recursive

boolean

指示从文件夹中加载表时是否以递归方式搜索数据文件。

响应

名称 类型 说明
202 Accepted

请求已接受，加载表作正在进行中。

标头

  • Location: string
  • x-ms-operation-id: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

常见错误代码：

  • UnknownError - 发生错误。

示例

Load table operation Example

示例请求

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": ","
  }
}

示例响应

状态代码:
202 
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

定义

名称 说明
Csv

CSV 文件的 CSV 格式选项。
ErrorRelatedResource

与错误相关的资源详细信息对象。
ErrorResponse

错误响应。
ErrorResponseDetails

错误响应详细信息。
LoadTableRequest

表示加载表作请求。
ModeType

加载表作模式，覆盖或追加。 可能会随着时间的推移添加其他模式类型。
Parquet

Parquet 文件的格式选项。
PathType

文件或文件夹的类型 relativePath。 可能会随着时间的推移添加其他 PathType 类型。

Csv

Object

CSV 文件的 CSV 格式选项。

名称 类型 说明
delimiter

string

pattern: ^[^\(\)\[\]\{\}'""]{0,8}$

CSV 文件的分隔符。
format string:

Csv

数据文件格式名称。 可能会随着时间的推移添加其他文件格式类型。
header

boolean

此属性指示 CSV 数据文件是否包含标头行。

ErrorRelatedResource

Object

与错误相关的资源详细信息对象。

名称 类型 说明
resourceId

string

错误中涉及的资源 ID。
resourceType

string

错误中涉及的资源的类型。

ErrorResponse

Object

错误响应。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
moreDetails

ErrorResponseDetails[]

其他错误详细信息的列表。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。
requestId

string

与错误关联的请求的 ID。

ErrorResponseDetails

Object

错误响应详细信息。

名称 类型 说明
errorCode

string

提供有关错误条件的信息的特定标识符，允许服务与其用户之间的标准化通信。
message

string

错误的人工可读表示形式。
relatedResource

ErrorRelatedResource

与错误相关的资源详细信息。

LoadTableRequest

Object

表示加载表作请求。

名称 类型 说明
fileExtension

string

pattern: ^[a-zA-Z0-9_-]{1,16}$

数据文件的文件扩展名。
formatOptions FileFormatOptions:

数据文件格式选项的抽象类型。
mode

ModeType

加载表作模式，覆盖或追加。 可能会随着时间的推移添加其他模式类型。
pathType

PathType

文件或文件夹的类型 relativePath。 可能会随着时间的推移添加其他 PathType 类型。
recursive

boolean

指示从文件夹中加载表时是否以递归方式搜索数据文件。
relativePath

string

pattern: ^Files(\/[\p{L}\w]{1}([ \p{L}\w\.-]*[\p{L}\w\.-]{1})*)*$

数据文件或文件夹的相对路径。

ModeType

枚举

加载表作模式，覆盖或追加。 可能会随着时间的推移添加其他模式类型。

值 说明
Overwrite

以覆盖模式加载表。
Append

在追加模式下加载表。

Parquet

Object

Parquet 文件的格式选项。

名称 类型 说明
format string:

Parquet

数据文件格式名称。 可能会随着时间的推移添加其他文件格式类型。

PathType

枚举

文件或文件夹的类型 relativePath。 可能会随着时间的推移添加其他 PathType 类型。

值 说明
File

从文件加载表。
Folder

从文件夹中加载表。