表優化器 API - AWS Glue

本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。

表優化器 API

資料表最佳化工具API說明如何啟用壓縮以改善讀取效能。 AWS Glue API

資料類型

TableOptimizer 結構

包含與資料表相關聯之最佳化工具的相關詳細資料。

欄位
  • type-UTF -8 字符串(有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。目前唯一有效的值為:compaction

  • configurationTableOptimizerConfiguration 物件。

    建立或更新資料表最佳化工具時,會指定的 TableOptimizerConfiguration 物件。

  • lastRunTableOptimizerRun 物件。

    表示上次執行之資料表最佳化工具的 TableOptimizerRun 物件。

TableOptimizerConfiguration 結構

包含資料表最佳化工具組態的相關詳細資料。您會在建立或更新資料表最佳化工具時傳遞此組態。

欄位
  • roleArn— UTF -8 個字串,長度不小於 1 或超過 512 個位元組,符合Single-line string pattern.

    呼叫者傳遞的角色,可提供服務權限,以代表呼叫者更新與最佳化工具相關聯的資源。

  • enabled – 布林值。

    無論資料表最佳化是否已啟用。

TableOptimizerRun 結構

包含資料表最佳化工具執行的詳細資料。

欄位
  • eventType-UTF -8 字符串(有效值:starting="STARTING"completed="COMPLETED"| failed="FAILED" | |in_progress="IN_PROGRESS")。

    表示資料表最佳化工具執行狀態的事件類型。

  • startTimestamp – 時間戳記。

    表示 Lake Formation 內的壓縮任務開始時的 Epoch 時間戳記。

  • endTimestamp – 時間戳記。

    表示壓縮任務結束時的 Epoch 時間戳記。

  • metricsRunMetrics 物件。

    包含最佳化工具執行之指標的 RunMetrics 物件。

  • error— UTF -8 個字符串。

    最佳化工具執行期間發生的錯誤。

BatchGetTableOptimizerEntry 結構

表示要在 BatchGetTableOptimizer 操作中擷取的資料表最佳化工具。

欄位
  • catalogId – 目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern

    資料表的目錄 ID。

  • databaseName-UTF -8 個字符串,至少 1 個字節長。

    資料表所在目錄的資料庫的名稱。

  • tableName-UTF -8 個字符串,至少 1 個字節長。

    資料表的名稱。

  • type-UTF -8 字符串(有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。

BatchTableOptimizer 結構

包含 BatchGetTableOptimizer 操作傳回之其中一個資料表最佳化工具的詳細資料。

欄位
  • catalogId – 目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern

    資料表的目錄 ID。

  • databaseName-UTF -8 個字符串,至少 1 個字節長。

    資料表所在目錄的資料庫的名稱。

  • tableName-UTF -8 個字符串,至少 1 個字節長。

    資料表的名稱。

  • tableOptimizerTableOptimizer 物件。

    包含組態和上次執行之資料表最佳化工具相關詳細資料的 TableOptimizer 物件。

BatchGetTableOptimizerError 結構

包含 BatchGetTableOptimizer 操作傳回的錯誤清單中之其中一個錯誤的相關詳細資料。

欄位
  • errorErrorDetail 物件。

    包含與錯誤相關之程式碼和訊息詳細資料的 ErrorDetail 物件。

  • catalogId – 目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern

    資料表的目錄 ID。

  • databaseName-UTF -8 個字符串,至少 1 個字節長。

    資料表所在目錄的資料庫的名稱。

  • tableName-UTF -8 個字符串,至少 1 個字節長。

    資料表的名稱。

  • type-UTF -8 字符串(有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。

RunMetrics 結構

最佳化工具執行的指標。

欄位
  • NumberOfBytesCompacted— UTF -8 個字符串。

    壓縮任務執行移除的位元組數。

  • NumberOfFilesCompacted— UTF -8 個字符串。

    壓縮任務執行移除檔案數。

  • NumberOfDpus— UTF -8 個字符串。

    工作所耗用的DPU時數。

  • JobDurationInHour— UTF -8 個字符串。

    任務的持續時間 (以小時為單位)。

作業

GetTableOptimizer 行動(Python:獲取表優化器)

傳回與指定資料表相關聯之所有最佳化工具的組態。

請求
  • CatalogId必要:目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • Type必要:UTF-8 字串 (有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。

回應
  • CatalogId – 目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName— UTF -8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName— UTF -8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • TableOptimizerTableOptimizer 物件。

    與指定資料表相關聯的最佳化工具。

錯誤
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

BatchGetTableOptimizer 行動(Python:批處理表優化器)

傳回指定資料表最佳化工具的組態。

請求
  • Entries必要:一個 BatchGetTableOptimizerEntry 物件。

    指定要擷取之資料表最佳化工具的 BatchGetTableOptimizerEntry 物件清單。

回應
錯誤
  • InternalServiceException

ListTableOptimizerRuns 行動(Python:列表優化器運行)

列出先前針對特定資料表之最佳化工具執行的歷史記錄。

請求
  • CatalogId必要:目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • Type必要:UTF-8 字串 (有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。目前唯一有效的值為:compaction

  • MaxResults – 數字 (整數)。

    每次呼叫時最佳化工具執行的傳回數上限。

  • NextToken— UTF -8 個字符串。

    接續符記,如果這是接續呼叫。

回應
  • CatalogId – 目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName— UTF -8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName— UTF -8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • NextToken— UTF -8 個字符串。

    用於將傳回的最佳化工具執行清單分頁的持續權杖,如果清單的目前區段不是最後區段則會傳回。

  • TableOptimizerRuns – 一個 TableOptimizerRun 物件陣列。

    與資料表相關聯的最佳化工具執行清單。

錯誤
  • EntityNotFoundException

  • AccessDeniedException

  • InvalidInputException

  • InternalServiceException

CreateTableOptimizer 行動(Python:創建表格優化器)

針對特定函數建立新的資料表。compaction 為目前唯一支援的最佳化工具類型。

請求
  • CatalogId必要:目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • Type必要:UTF-8 字串 (有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。目前唯一有效的值為:compaction

  • TableOptimizerConfiguration必要:TableOptimizerConfiguration 物件。

    表示資料表最佳化工具組態的 TableOptimizerConfiguration 物件。

回應
  • 無回應參數。

錯誤
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • AlreadyExistsException

  • InternalServiceException

DeleteTableOptimizer 行動(Python:刪除表格優化器)

針對資料表刪除最佳化工具和所有相關的中繼資料。系統將不會再針對該資料表執行最佳化。

請求
  • CatalogId必要:目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • Type必要:UTF-8 字串 (有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。

回應
  • 無回應參數。

錯誤
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException

UpdateTableOptimizer 行動(Python:更新表優化器)

針對現有的資料表最佳化工具更新組態。

請求
  • CatalogId必要:目錄 ID 字串,長度不可小於 1 個位元組,也不可以超過 255 個位元組,需符合 Single-line string pattern

    資料表的目錄 ID。

  • DatabaseName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表所在目錄的資料庫的名稱。

  • TableName必要:UTF-8 個字串,長度不小於 1 或超過 255 個位元組,符合Single-line string pattern.

    資料表的名稱。

  • Type必要:UTF-8 字串 (有效值:compaction="COMPACTION")。

    資料表最佳化工具類型。目前唯一有效的值為:compaction

  • TableOptimizerConfiguration必要:TableOptimizerConfiguration 物件。

    表示資料表最佳化工具組態的 TableOptimizerConfiguration 物件。

回應
  • 無回應參數。

錯誤
  • EntityNotFoundException

  • InvalidInputException

  • AccessDeniedException

  • InternalServiceException