預覽 SQL 查詢

本文件說明如何在向 BigQuery 執行查詢前，在 Dataform 工作區中預覽 SQL 查詢的輸出內容。

關於 Dataform 中的查詢預覽

使用 Dataform 核心在 SQLX 或 JavaScript 檔案中開發查詢時，Dataform 會即時將查詢編譯為 SQL。如要先測試編譯的 SQL 查詢輸出內容，再將查詢執行至 BigQuery，您可以在 Dataform 工作區中執行查詢的預覽畫面。

執行查詢預覽時，Dataform 會在 BigQuery 中執行工作，在暫時性目的地資料表中執行已編譯的查詢，並在工作區中顯示查詢結果。您可以在觸發執行作業將資料表發布至 BigQuery 之前，檢查查詢的輸出內容。系統會在 24 小時內自動刪除包含預覽查詢的臨時資料表。如要進一步瞭解 BigQuery 工作，請參閱「管理工作」。

在 Dataform 中執行查詢預覽功能會產生 BigQuery 的帳單費用。如要進一步瞭解 BigQuery 的定價方式，請參閱「BigQuery 定價」一文。

在查詢預覽期間，Dataform 會使用您的使用者憑證，在 BigQuery 中執行工作。不過，在工作流程執行期間，Dataform 會使用您的服務帳戶憑證，在 BigQuery 中建立或更新資產。

Dataform 會在工作區的「Query results」面板中，顯示在目前瀏覽器工作階段中預覽的所有查詢結果。在「查詢結果」面板中，您可以查看目前瀏覽器工作階段中預覽的每個查詢的下列資訊：

  • 工作資訊
    • BigQuery 工作 ID
    • 使用者執行預覽畫面
    • 工作執行位置，取自工作流程設定檔
    • BigQuery 工作建立、開始和結束時間
    • BigQuery 工作的持續時間
    • 處理的位元組數
    • 在 BigQuery 中計費的位元組
    • 工作優先順序
    • 在查詢中使用舊版 SQL
    • 查詢的臨時目的地資料表
  • 查詢結果
  • 查詢輸出的 JSON 表示法

此外，您可以在「查詢結果」面板中前往每個預覽查詢的來源檔案，並前往 BigQuery Studio 查看預覽工作。

事前準備

  1. 在 Google Cloud 控制台中，前往「Dataform」頁面。

    前往「Dataform」頁面

  2. 選取或建立存放區。

  3. 選取或建立開發工作區。

  4. 建立 SQL 查詢，例如建立資料表。

必要的角色

如要取得預覽查詢所需的權限，請要求管理員為您授予專案的下列 IAM 角色：

  • Dataform 編輯器 (roles/dataform.editor) - 工作區
  • BigQuery 工作使用者 (roles/bigquery.jobUser) - 專案

如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

您或許還可透過自訂角色或其他預先定義的角色取得必要權限。

預覽查詢

如要在執行前檢查 Dataform 中的查詢結果，請在工作區中執行查詢預覽畫面。如果目前編輯的檔案包含多個查詢，請選取要預覽的查詢。一次只能預覽一個查詢。

對於含有斷言的表格，執行預覽的運作方式稍有不同。詳情請參閱「使用斷言預覽資料表」。

如要在 Dataform 工作區中預覽 SQL 查詢並查看查詢結果，請按照下列步驟操作：

  1. 在「檔案」窗格中展開 definitions/。
  2. 選取 SQLX 或 JavaScript 檔案。
  3. 按一下「執行」。
    1. 如果檔案包含多個查詢，請在下拉式選單中選取要預覽的查詢。
  4. 在「查詢結果」面板中檢查預覽結果。
    1. 如要查看工作詳細資料，請選取「Job information」分頁標籤。
    2. 如要檢查查詢結果，請選取「結果」分頁。
    3. 如要查看查詢的 JSON 輸出內容，請選取「JSON」JSON分頁標籤。
    4. 如要在 SQL 工作區中查看預覽工作，請依序按一下 「更多」選單 >「在 SQL 工作區中查看工作」。

預覽含有斷言的表格

在含有斷言的 SQLX 資料表定義檔案中，您可以預覽資料表建立查詢和定義的斷言查詢。

Dataform 會將資料表定義查詢視為預設查詢。如要預覽建立資料表的查詢，請在工作區中按一下「執行」。如要預覽斷言查詢，請在「Run」按鈕旁的下拉式選單中選取該查詢。一次只能預覽一個查詢。

如要在 Dataform 工作區中，使用斷言預覽資料表定義檔中的查詢，請按照下列步驟操作：

  1. 在「檔案」窗格中展開 definitions/。
  2. 選取含有斷言的資料表定義檔案。
  3. 執行預覽：
    • 如要預覽資料表建立查詢，請按一下「執行」。
    • 如要預覽斷言查詢，請按一下「Run」旁的下拉式圖示，然後選取要預覽的查詢。
  4. 在「查詢結果」面板中檢查預覽結果。
    1. 如要查看工作詳細資料，請選取「Job information」分頁標籤。
    2. 如要檢查查詢結果，請選取「結果」分頁。
    3. 如要查看查詢的 JSON 輸出內容，請選取「JSON」JSON分頁標籤。
    4. 如要在 SQL 工作區中查看預覽工作，請依序按一下 「更多」選單 >「在 SQL 工作區中查看工作」。

後續步驟