Tables - Load Table
テーブルの読み込み操作を開始し、応答の場所ヘッダーに操作状態 URL を返します。
Note
この API はプレビュー リリースの一部であり、評価と開発のみを目的として提供されます。 フィードバックに基づいて変更される可能性があり、運用環境での使用はお勧めしません。
この API は、実行時間の長い操作 (LRO)をサポートします。
Permissions
レイクハウスアイテムに権限を書き込みます。
必要な委任されたスコープ
Lakehouse.ReadWrite.All
Microsoft Entra でサポートされている ID
この API では、このセクションに記載されている Microsoft ID がサポートされています。
| Identity | Support |
|---|---|
| User | Yes |
| サービス プリンシパルとマネージド ID | Yes |
Interface
POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/lakehouses/{lakehouseId}/tables/{tableName}/load
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
lakehouse
|
path | True |
string (uuid) |
レイクハウス項目 ID。 |
|
table
|
path | True |
string pattern: ^(?=[0-9]*[a-zA-Z_])[a-zA-Z0-9_]{1,256}$ |
テーブル名。 |
|
workspace
|
path | True |
string (uuid) |
ワークスペース ID。 |
要求本文
| 名前 | 必須 | 型 | 説明 |
|---|---|---|---|
| pathType | True |
ファイルまたはフォルダー |
|
| 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 |
テーブルの読み込み操作モード。上書きまたは追加します。 追加のモードの種類は、時間の経過と同時に追加される場合があります。 |
||
| recursive |
boolean |
フォルダーからテーブルを読み込むときに、データ ファイルを再帰的に検索するかどうかを示します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 202 Accepted |
要求が受け入れられ、テーブルの読み込み操作が進行中です。 ヘッダー
|
|
| Other Status Codes |
一般的なエラー コード:
|
例
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": ","
}
}
応答のサンプル
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 形式オプション。 |
|
Error |
エラー関連のリソース詳細オブジェクト。 |
|
Error |
エラー応答。 |
|
Error |
エラー応答の詳細。 |
|
Load |
テーブルの読み込み操作要求を表します。 |
|
Mode |
テーブルの読み込み操作モード。上書きまたは追加します。 追加のモードの種類は、時間の経過と同時に追加される場合があります。 |
| Parquet |
Parquet ファイルの書式オプション。 |
|
Path |
ファイルまたはフォルダー |
Csv
CSV ファイルの CSV 形式オプション。
| 名前 | 型 | 説明 |
|---|---|---|
| delimiter |
string pattern: ^[^\(\)\[\]\{\}'""]{0,8}$ |
CSV ファイルの区切り記号。 |
| format | string: |
データ ファイル形式の名前。 追加のファイル形式の種類は、時間の経過と伴って追加される場合があります。 |
| header |
boolean |
このプロパティは、CSV データ ファイルにヘッダー行が含まれているかどうかを示します。 |
ErrorRelatedResource
エラー関連のリソース詳細オブジェクト。
| 名前 | 型 | 説明 |
|---|---|---|
| resourceId |
string |
エラーに関係するリソース ID。 |
| resourceType |
string |
エラーに関係するリソースの種類。 |
ErrorResponse
エラー応答。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| moreDetails |
その他のエラーの詳細の一覧。 |
|
| relatedResource |
エラー関連のリソースの詳細。 |
|
| requestId |
string |
エラーに関連付けられている要求の ID。 |
ErrorResponseDetails
エラー応答の詳細。
| 名前 | 型 | 説明 |
|---|---|---|
| errorCode |
string |
エラー状態に関する情報を提供し、サービスとそのユーザー間の標準化された通信を可能にする特定の識別子。 |
| message |
string |
エラーの人間が判読できる表現。 |
| relatedResource |
エラー関連のリソースの詳細。 |
LoadTableRequest
テーブルの読み込み操作要求を表します。
| 名前 | 型 | 説明 |
|---|---|---|
| fileExtension |
string pattern: ^[a-zA-Z0-9_-]{1,16}$ |
データ ファイルのファイル拡張子。 |
| formatOptions | FileFormatOptions: |
データ ファイル形式のオプションの抽象型。 |
| mode |
テーブルの読み込み操作モード。上書きまたは追加します。 追加のモードの種類は、時間の経過と同時に追加される場合があります。 |
|
| pathType |
ファイルまたはフォルダー |
|
| recursive |
boolean |
フォルダーからテーブルを読み込むときに、データ ファイルを再帰的に検索するかどうかを示します。 |
| relativePath |
string pattern: ^Files(\/[\p{L}\w]{1}([ \p{L}\w\.-]*[\p{L}\w\.-]{1})*)*$ |
データ ファイルまたはフォルダーの相対パス。 |
ModeType
テーブルの読み込み操作モード。上書きまたは追加します。 追加のモードの種類は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| Overwrite |
上書きモードでテーブルを読み込みます。 |
| Append |
追加モードでテーブルを読み込みます。 |
Parquet
Parquet ファイルの書式オプション。
| 名前 | 型 | 説明 |
|---|---|---|
| format | string: |
データ ファイル形式の名前。 追加のファイル形式の種類は、時間の経過と伴って追加される場合があります。 |
PathType
ファイルまたはフォルダー relativePathの種類。 追加の PathType 型は、時間の経過と同時に追加される場合があります。
| 値 | 説明 |
|---|---|
| File |
ファイルからテーブルを読み込みます。 |
| Folder |
フォルダーからテーブルを読み込みます。 |