本文件說明如何在 Dataform 中執行下列操作:
事前準備
在 Google Cloud 控制台中,前往「Dataform」頁面。
選取或建立存放區。
選取或建立開發工作區。
選用:如要覆寫發布設定中的預設 Google Cloud 專案,請授予 Dataform 服務帳戶存取權,以便存取您要使用的專案。
必要的角色
如要取得完成本文件中任務所需的權限,請要求管理員授予您存放區的 Dataform 管理員 (roles/dataform.admin
) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
如要在啟用嚴格 act-as 模式時更新 Dataform 存放區版本設定的版本,您必須對使用此版本設定的工作流程設定中的每個服務帳戶擁有 iam.serviceAccounts.actAs
權限。此權限適用於「服務帳戶使用者」(roles/iam.serviceAccountUser
) 角色。
Dataform 中的程式碼生命週期簡介
本節說明 Dataform 中的程式碼生命週期,以及在 Dataform 中設定編譯和執行作業的方式。
Dataform 程式碼生命週期包含下列階段:
- 開發
- 您會在 Dataform 工作區中開發工作流程。
- 編譯
Dataform 會即時將工作區中的工作流程程式碼編譯為 SQL,並建立工作區的編譯結果,讓您在 BigQuery 中執行。Dataform 會使用您在工作流程設定檔中定義的設定,建立編譯結果。
Dataform 編譯作業是密封的,可確保編譯作業的一致性,也就是說,相同的程式碼每次都會編譯為相同的 SQL 編譯結果。Dataform 會在無法存取網際網路的沙箱環境中編譯程式碼。編譯期間不會執行其他動作,例如呼叫外部 API。
- 執行
在工作流程叫用中,Dataform 會在 BigQuery 中執行工作區編譯結果。
如要依據需求調整 Dataform 程式碼生命週期,您可以設定編譯結果,影響 Dataform 執行工作流程的位置和方式。接著,您可以手動觸發或排程執行,以影響 Dataform 執行整個工作流程或其所選元素的時間。
設定 Dataform 編譯方式
根據預設,Dataform 會使用工作流程設定檔中的設定,建立編譯結果。您可以使用編譯覆寫值覆寫預設設定,建立自訂的編譯結果。接著,您可以手動觸發自訂編譯結果的執行作業,或安排執行作業。
Dataform 提供下列選項,可用於設定編譯結果:
- 工作區編譯覆寫設定
- 您可以設定編譯覆寫設定,套用至存放區中的所有工作區。您可以使用工作區編譯覆寫功能建立獨立的開發環境。
- 版本設定
- 您可以建立版本設定,設定範本,以便建立 Dataform 存放區的編譯結果。接著,您可以建立工作流程設定,排定所選發布版本設定中建立的編譯結果執行作業。
- Dataform API 編譯覆寫值
- 您可以在終端機中傳遞 Dataform API 要求,藉此使用編譯覆寫值建立及執行單一編譯結果。
建立工作區編譯覆寫設定
您可以使用工作區編譯覆寫設定,為 Dataform 存放區中的所有工作區建立編譯覆寫設定。您可以為每個存放區建立一個工作區編譯覆寫設定。
在含有工作區編譯覆寫設定的存放區中,如果您手動觸發工作區中的執行作業,Dataform 會將這些覆寫設定套用至工作區的編譯結果。
您可以設定下列工作區編譯覆寫設定:
- Google Cloud Dataform 執行工作區內容的專案
- 資料表前置字串
- 結構定義後置字串
您可以使用工作區編譯覆寫功能,透過動態編譯覆寫功能在 BigQuery 中隔離工作區編譯結果,藉此建立獨立的開發環境。動態資料表前置字串和結構定義字尾編譯覆寫值包含 ${workspaceName}
變數。在工作區中觸發執行作業時,Dataform 會將 ${workspaceName}
變數替換為目前工作區的名稱,並建立工作區專屬的編譯覆寫。
請注意,您無法排定使用工作區編譯覆寫設定建立的編譯結果執行作業。
建立版本設定
您可以使用版本設定,設定範本的設定,以便建立存放區的編譯結果。
在版本設定中,您可以設定工作流程設定、編譯變數,以及整個存放區建立編譯結果的頻率的編譯覆寫設定。
在版本設定中,您可以設定下列編譯覆寫值:
- Google Cloud 專案
- 資料表前置字串
- 結構定義後置字串
- 編譯變數的值
您可以在 Dataform 存放區中建立多個版本設定,每個設定對應至開發生命週期的各個階段,以便建立隔離的存放區編譯結果。
接著,您可以建立工作流程設定,安排執行在所選版本設定中建立的編譯結果。
您也可以手動觸發所選版本設定的編譯結果執行作業。
使用 Dataform API 編譯覆寫值設定單一編譯結果
在終端機中傳遞 Dataform API 要求,即可為單一編譯結果設定編譯覆寫值。
在 compilationResults.create
要求中,您可以建立 Dataform 工作區或指定 Git 提交的單一編譯結果。
在 compilationResults.create
要求的 CodeCompilationConfig
物件中,您可以為編譯要求設定編譯覆寫值。
您可以設定下列 Dataform API 編譯覆寫值:
- Google Cloud 專案
- 資料表前置字串
- 結構定義後置字串
- 編譯變數的值
請注意,Dataform API 編譯覆寫值只會套用至單一編譯結果和單一執行作業。您無法使用這些指令碼來排定 Dataform 執行作業。
您可以在 workflowInvocations.create
要求中執行編譯結果。
設定 Dataform 執行作業的方式
Dataform 提供下列執行設定選項:
- 在工作區中手動執行
- 您可以在 Dataform 工作區中,在任何排程之外手動觸發即時執行工作流程。您可以在工作流程中執行所選動作。
- 工作流程設定
- 您可以排定執行在所選版本設定中建立的編譯結果。您可以選取要執行的工作流程動作,並設定執行的頻率和時區。
在工作區中觸發即時執行作業
在 Dataform 工作區中,您可以手動觸發工作區中的工作流程立即執行作業,不受任何排程限制。
您可以在工作區中手動執行下列工作流程元素:
如果存放區包含工作區編譯覆寫值,您可以查看 Dataform 會將哪些編譯覆寫值套用至工作區編譯結果。
建立工作流程設定
您可以使用工作流程設定,根據所選版本設定排定編譯結果的執行時程。您可以在 Dataform 存放區中建立多個工作流程設定。
您可以在工作流程設定中設定下列執行設定:
- 已套用編譯版本設定。
- 選取要執行的工作流程動作。
- 執行作業的時間表和時區。
您可以選取要執行的下列工作流程動作:
- 所有動作
- 所選動作
- 含有所選標記的動作
接著,在排定執行工作流程設定期間,Dataform 會將您從套用編譯結果中選取的動作部署至 BigQuery。
您可以透過 Dataform 版本設定和工作流程設定,在 Dataform 中設定編譯作業並排定執行時程,而無須依賴其他服務。
生命週期資源的到期日
Dataform 會在特定時間範圍內儲存編譯結果和工作流程叫用作業。
工作流程叫用作業的到期時間
工作流程叫用會在 90 天後或您手動刪除時失效。
在工作流程設定中,您可以查看由設定建立的最新工作流程叫用清單。當工作流程設定建立的工作流程叫用作業到期時,Dataform 會從最近叫用作業清單中移除該工作流程叫用作業。
編譯結果到期
編譯結果的到期日取決於這些結果是在開發工作區、版本設定,還是透過工作流程叫用所建立。
在 Dataform 工作區中開發工作流程時,Dataform 會即時將程式碼編譯為編譯結果,以提供查詢驗證。以這種方式建立的編譯結果會在 24 小時後失效。
在發布設定中,最新的編譯結果會成為即時編譯結果。新的編譯結果會取代目前的即時編譯結果。Dataform 會保留即時編譯結果,直到新的編譯結果取代為止。已取代的編譯結果最多會在 24 小時後失效。
Dataform 會在版本設定的「Details」頁面中,從過去編譯結果清單中移除已過期的編譯結果。
Dataform 會在工作流程叫用期間 (工作流程叫用到期或刪除前) 保留工作流程叫用所建立的編譯結果,最長可達 24 小時。
建立工作區編譯覆寫設定
以下各節將說明如何建立工作區編譯覆寫值,以便在 BigQuery 中隔離透過 Dataform 工作區建立的資料表和檢視畫面。您可以使用工作區編譯覆寫功能,建立獨立的 Dataform 開發環境。
在 Dataform 工作區中開發工作流程程式碼時,Dataform 會即時編譯工作區中的程式碼,以便建立工作區的編譯結果。Dataform 會使用工作流程設定檔中定義的設定,建立工作區編譯結果。接著,當您在工作區中觸發執行作業時,Dataform 會在 BigQuery 中執行工作區編譯結果。
如要針對存放區中的所有工作區,覆寫工作流程設定中的預設設定,您可以建立工作區編譯覆寫設定。
透過工作區編譯覆寫設定,您可以為存放區中的所有工作區覆寫下列設定:
- 專案
- Dataform 執行工作區編譯結果的 Google Cloud 專案,在
workflow_settings.yaml
中設為defaultProject
,或在dataform.json
中設為defaultDatabase
。 - 資料表前置字串
- 在存放區中所有工作區的所有資料表名稱中新增自訂前置字串。
- 結構定義後置字串
- 附加至資料表結構定義的自訂字尾。在
workflow_settings.yaml
中設為defaultDataset
、在dataform.json
中設為defaultSchema
,或是在資料表的config
區塊中設為schema
參數。
如要建立獨立的開發環境,您可以使用獨特的編譯覆寫功能隔離工作區。您可以使用 ${workspaceName}
變數,動態修改資料表前置字串和結構定義後置字串的編譯覆寫值。
在工作區中手動觸發執行作業時,${workspaceName}
變數會將工作區名稱插入工作區編譯覆寫值。
將 ${workspaceName}
設為資料表前置字串時,Dataform 會將工作區名稱加入工作區中所有資料表的名稱。執行後,您可以在 BigQuery 中找出資料表的來源工作區。
將 ${workspaceName}
設為結構定義後置字串時,Dataform 會將工作區名稱附加至 defaultSchema
,建立專屬於工作區的自訂結構定義。執行後,您可以在 BigQuery 中找到專屬架構中從特定工作區執行的所有資料表。
動態工作區編譯覆寫設定範例
以下範例顯示動態工作區編譯覆寫值套用至存放區的情況,該存放區包含以在該存放區中工作的開發人員命名的工作區:Sasha
和 Kai
。
本例中工作區編譯覆寫設定的目標,是為 Sasha 和 Kai 建立獨立的開發環境。
workflow_settings.yaml
中設定了下列預設設定:
defaultProject
:analytics
defaultDataset
:dataform
下列工作區編譯覆寫設定會為存放區中的每個工作區建立動態資料表前置字串和結構定義後置字串:
- Google Cloud 專案 ID:
analytics_dev
- 資料表前置字串:
${workspaceName}
- 結構定義後置字串:
${workspaceName}
當 Sasha 在 Sasha
工作區中手動觸發執行作業時,Dataform 會使用下列設定執行內容:
- Google Cloud project:
analytics_dev
- 結構定義:
dataform_sasha
- 表格名稱:
sasha_name
,例如sasha_orders
當 Kai 在 Kai
工作區中手動觸發執行作業時,Dataform 會使用下列設定執行內容:
- Google Cloud project:
analytics_dev
- 結構定義:
dataform_kai
- 資料表名稱:
kai_name
,例如kai_orders
建立工作區編譯覆寫設定
如要建立 Dataform 工作區編譯覆寫值,請按照下列步驟操作:
- 在儲存庫中前往「設定」。
- 按一下 [編輯]。
- 在「Workspace compilation overrides」窗格中的「Google Cloud Project ID」欄位中,輸入專案 ID。
- 在「Table prefix」(資料表前置字串) 欄位中,輸入所有資料表名稱的前置字串。
- 選用步驟:如要為每個工作區建立專屬的動態資料表前置字串,請輸入
${workspaceName}
做為資料表前置字串。
- 選用步驟:如要為每個工作區建立專屬的動態資料表前置字串,請輸入
- 在「Schema suffix」欄位中,輸入要附加至已建立資料表或檢視表結構定義的字尾。
- 選用步驟:如要為每個工作區建立專屬的動態結構定義字尾,請輸入
${workspaceName}
做為資料表字尾。
- 選用步驟:如要為每個工作區建立專屬的動態結構定義字尾,請輸入
- 按一下 [儲存]。
Dataform 會將工作區編譯覆寫設定套用到存放區中的所有工作區。
編輯工作區編譯覆寫設定
如要編輯 Dataform 工作區編譯覆寫設定,請按照下列步驟操作:
- 在儲存庫中前往「設定」。
- 按一下 [編輯]。
- 編輯工作區編譯覆寫值,然後按一下「儲存」。
刪除工作區編譯覆寫設定
如要刪除 Dataform 工作區編譯覆寫值,請按照下列步驟操作:
- 在儲存庫中前往「設定」。
- 按一下 [編輯]。
- 在「Workspace compilation overrides」窗格中,按一下「Clear all」,然後點選「Save」。
使用 Dataform API 設定編譯覆寫值
本節說明如何使用 Dataform API 建立及執行含有編譯覆寫值的編譯結果。
關於 Dataform API 編譯覆寫
為了執行工作流程,Dataform 會將程式碼編譯為 SQL,以便建立編譯結果。接著,在工作流程叫用期間,Dataform 會在 BigQuery 中執行編譯結果。
根據預設,Dataform 會使用工作流程設定檔中的設定建立編譯結果。如要區隔在開發生命週期不同階段執行的資料,您可以使用編譯覆寫功能覆寫預設設定。
您可以在終端機中傳遞 Dataform API 要求,藉此建立及執行單一編譯結果,並套用編譯覆寫值。您可以建立工作區或所選 Git 提交的編譯結果。
如要建立含有編譯覆寫值的編譯結果,您必須提出 Dataform API compilationResults.create
要求。在要求中,您需要指定來源,該來源應為工作區或 Git 提交,以便 Dataform 編譯成編譯結果。您可以在 compilationResults.create
要求的 CodeCompilationConfig
物件中,設定編譯覆寫值。
接著,您可以在 Dataform API workflowInvocations.create
要求中執行已建立的編譯結果。
您可以使用 Dataform API 設定下列編譯覆寫值:
- Google Cloud project
- Dataform 執行編譯結果的專案,在
workflow_settings.yaml
檔案中設為defaultProject
屬性,或在dataform.json
檔案中設為defaultDatabase
屬性。 - 資料表前置字串
- 在編譯結果中,新增至所有資料表名稱的自訂前置字串。
- 結構定義後置字串
- 在
workflow_settings.yaml
檔案的defaultDataset
屬性、dataform.json
檔案的defaultSchema
屬性,或資料表config
區塊的schema
參數中定義的資料表結構定義中,附加的自訂後置字串。 - 編譯變數的值
- 要用於編譯結果的編譯變數值。您可以使用編譯變數來條件式執行資料表。
除了 Dataform API 編譯覆寫值 (只能用於一個編譯結果),您也可以在 Google Cloud 控制台中設定工作區編譯覆寫值。
如要瞭解在 Dataform 中設定編譯覆寫值的其他方法,請參閱「程式碼生命週期簡介」。
設定編譯結果來源
如要提出 Dataform API compilationResults.create
要求,您必須指定編譯結果的來源。
您可以在 compilationResults.create
要求中,將 Dataform 工作區或 Git 分支、Git 標記或 Git 修訂版本 SHA 設為來源。
將工作區設為編譯結果來源
在
compilationResults.create
要求中,使用所選 Dataform 工作區的路徑填入workspace
屬性,格式如下:{ "workspace": "projects/PROJECT_NAME/locations/LOCATION/repositories/REPOSITORY_NAME/workspaces/WORKSPACE_NAME" }
更改下列內容:
- PROJECT_NAME: Google Cloud 專案名稱。
- LOCATION:Dataform 存放區的位置,可在工作流程設定中設定。
- REPOSITORY_NAME:Dataform 存放區的名稱。
- WORKSPACE_NAME:Dataform 工作區的名稱。
以下程式碼範例顯示 compilationResults.create
要求中的 workspace
屬性,已設為名為 "sales-test"
的工作區:
{
"workspace": "projects/analytics/locations/europe-west4/repositories/sales/workspaces/sales-test"
}
將 Git 提交項目設為編譯結果來源
在
compilationResults.create
要求中,使用所選 Git 分支版本、標記或修訂版本 SHA 填入gitCommitish
屬性,格式如下:{ "gitCommitish": "GIT_COMMITISH" }
將 GIT_COMMITISH 替換成所選的 Git 分支、Git 標記或 Git 修訂版本 SHA,以便取得編譯結果。
以下程式碼範例顯示 compilationResults.create
要求中的 gitCommitish
屬性已設為 "staging"
:
{
"gitCommitish": "staging"
}
覆寫預設專案
如要在 Google Cloud 專案中建立與開發專案不同的暫存或實際工作環境資料表,您可以在 Dataform API compilationResults.create
要求的 CodeCompilationConfig
物件中傳遞不同的專案 ID。
在 compilationResults.create
要求中傳遞個別的預設專案 ID 會覆寫工作流程設定檔中設定的預設專案 ID,但不會覆寫個別資料表中設定的專案 ID。
如要覆寫預設專案 ID,請將
defaultDatabase
屬性設為CodeCompilationConfig
物件中所選專案 ID,格式如下:{ "codeCompilationConfig": { "defaultDatabase": "PROJECT_NAME" } }
將 PROJECT_NAME 替換為您要為編譯結果設定的專案 ID。
新增資料表前置字串
如要快速從編譯結果中識別資料表,您可以為編譯結果中的所有資料表名稱加上前置字元,方法是透過 Dataform API compilationResults.create
要求中的 CodeCompilationConfig
物件傳遞資料表前置字元。
如要新增表格前置字串,請使用下列格式,在
CodeCompilationConfig
物件中設定tablePrefix
屬性:{ "codeCompilationConfig": { "tablePrefix": "PREFIX", } }
將 PREFIX 替換為要附加的前置字串,例如
staging
。舉例來說,如果資料表名稱為
table_name
,Dataform 會建立名稱為staging_table_name
的資料表。
附加結構定義後置字串
如要區隔開發、測試和實際工作環境資料,您可以在編譯結果中為架構附加字尾,方法是透過 Dataform API compilationResults.create
要求中的 CodeCompilationConfig
物件傳遞架構字尾。
如要附加結構定義後置字串,請使用下列格式在
CodeCompilationConfig
物件中設定schemaSuffix
屬性:{ "codeCompilationConfig": { "schemaSuffix": "SUFFIX", } }
將 SUFFIX 替換為要附加的後置字串,例如
_staging
。舉例來說,如果
workflow_settings.yaml
檔案中的defaultDataset
屬性設為dataform
,Dataform 就會在dataform_staging
結構定義中建立資料表。
使用編譯變數有條件地執行所選檔案
如要只在特定執行設定中執行所選表格,您可以為執行設定建立編譯變數,然後在 Dataform API compilationResults.create
要求的 CodeCompilationConfig
物件中傳遞其值。
如要使用 Dataform API 在特定執行設定中依條件執行資料表,請按照下列步驟操作:
- 建立編譯變數並新增至所選資料表。
請按照下列格式,在 Dataform API 編譯要求的
codeCompilationConfig
區塊中設定 YOUR_VARIABLE 和 VALUE 鍵/值組合:{ "codeCompilationConfig": { "vars": { "YOUR_VARIABLE": "VALUE" } } }
將 YOUR_VARIABLE 替換為變數名稱,例如
executionSetting
。將 VALUE 替換為這個編譯結果的變數值,以符合所選資料表中設定的
when
條件。
以下程式碼範例顯示傳遞至 Dataform API 編譯要求的 executionSetting
變數:
{
"gitCommitish": "staging",
"codeCompilationConfig": {
"vars": {
"executionSetting": "staging"
}
}
}
使用編譯覆寫設定執行編譯結果
- 如要執行
compilationResults.create
要求建立的編譯結果,請在workflowInvocations.create
要求中傳遞compilationResults.create
要求傳回的編譯結果 ID。
下列程式碼範例顯示在 workflowInvocations.create
要求中傳遞的編譯結果 ID:
{
"compilationResult": "projects/my-project-name/locations/europe-west4/repositories/my-repository-name/compilationResults/7646b4ed-ac8e-447f-93cf-63c43249ff11"
}
建立版本設定
以下各節將說明如何在 Dataform 中建立發布設定,以便設定編譯設定範本,並依時程執行。您可以使用版本設定來設定執行環境,例如測試和正式環境。
為了在 BigQuery 中執行工作流程,Dataform 會將 SQL 工作流程程式碼編譯為編譯結果。在 Dataform 工作區中開發工作流程時,系統會自動執行這項程序。
您可以透過版本設定自訂編譯結果。您可以使用這些設定建立執行環境,例如測試環境。
版本設定
在版本設定中,您可以設定工作流程設定的編譯覆寫值、設定編譯變數,以及設定建立編譯結果的頻率。
Dataform 版本設定包含下列編譯設定:
- 版本設定
- 版本 ID、編譯結果的 Git 修訂版本,以及建立編譯結果的頻率。頻率為選用設定。如果已設定,最小頻率為 1 小時。
- 編譯覆寫設定
- 覆寫 工作流程設定中定義的Google Cloud 專案、資料表前置字串、結構定義後置字串和編譯變數。
發布版本設定的運作方式
Dataform 會在指定的頻率或您觸發編譯時,從版本設定建立編譯結果。頻率為選用設定,不必建立發布設定。如有設定,最小頻率為 1 小時。您可以在「版本設定詳細資料」頁面上手動觸發編譯作業,或是使用 Dataform API releaseConfigs
方法觸發編譯作業。
在編譯期間,Dataform 會從存放區的指定 Git 提交項目中提取程式碼。接著,Dataform 會使用套用的編譯覆寫值 (如有) 編譯程式碼,並建立編譯結果。為發布設定建立的最新編譯結果即為即時編譯結果。
您可以在工作流程設定中,根據版本設定排定編譯結果的執行作業。您也可以在沒有排程的情況下執行所選發布設定。在執行工作流程設定期間,Dataform 會執行所選版本設定的即時編譯結果。
建立版本設定
如要建立 Dataform 版本設定,請按照下列步驟操作:
- 在儲存庫中,前往「發布內容與排程」。
- 在「版本設定」部分中,按一下「建立」。
在「Create release configuration」窗格中,設定版本設定。
在「Release ID」欄位中,輸入發布版本設定的專屬 ID。
ID 只能包含數字、英文字母、連字號和底線。
在「Git commitish」欄位中,輸入發布版本的 Git 分支或 Git 修訂版本 SHA。
在未連結至遠端存放區的 Dataform 存放區中,這個值一律為
main
。選用:在「頻率」欄位中,選取建立匯集結果的頻率。
如果已設定,則最小頻率為 1 小時。
如要停用自動發布功能,請將「頻率」欄位留空。
選用步驟:在「Compilation overrides」部分中,設定編譯設定。
- 在「Google Cloud Project ID」欄位中,輸入要儲存編譯結果的Google Cloud 專案 ID。
- 在「Schema suffix」欄位中輸入要附加至在工作流程設定中設定的結構定義的後置字串。
- 在「Table prefix」(資料表前置字串) 欄位中,輸入所有資料表名稱的前置字串。
選用步驟:在「Compilation variables」部分中設定編譯變數。
- 按一下「新增變數」。
- 在「Key」欄位中輸入編譯變數。
- 在「Value」欄位中,輸入編譯變數的值。
- 如要新增其他編譯變數,請按一下「新增變數」。
點選「建立」。
如果您覆寫預設專案,請確認您的 Dataform 服務帳戶有權存取在發布設定中設定的專案。
舉例來說,下列版本設定會在每小時從 main
分支建立 production
編譯結果,且不會覆寫任何編譯作業:
- 版本 ID:
production
- Git commitish:
main
- 頻率:每小時
- 未設定任何編譯覆寫設定
查看版本設定的詳細資料
您可以查看版本設定的下列詳細資料:
- 版本設定
- Git 修訂版本
- 最新的編譯結果時間戳記
- Cron 排程
- 編譯覆寫設定
- 編譯變數
- 即時編譯結果
- 建立時間戳記
- Git 修訂版本
- 修訂版本 SHA
- 過去的編譯結果
如要查看版本設定的詳細資料,請按照下列步驟操作:
- 在儲存庫中,前往「發布內容與排程」。
- 選取發布版本設定。
- 在「版本設定詳細資料」頁面中,檢查版本設定的詳細資料。
「排定的編譯作業結果」表格會顯示版本設定自動建立的過去編譯結果。
「手動/API 編譯結果」表格會顯示儲存庫中最新 1000 筆編譯結果中,手動建立或透過 Dataform API 呼叫所產生的編譯結果。
手動觸發編譯
如要手動建立所選版本設定的編譯結果,請按照下列步驟操作:
- 在儲存庫中,前往「發布內容與排程」。
- 選取發布版本設定。
- 在「Release configuration details」(版本設定詳細資料) 頁面中,按一下「New compilation」(新增編譯)。
如果您使用的是 UI,新編譯的結果會自動發布至版本設定。如果您使用的是 API,則必須透過發布設定建立新的編譯結果,然後更新發布設定,以便使用這個新值設定 releaseCompilationResult
欄位。
手動編譯結果會顯示在「發布設定詳細資料」頁面上的「手動/API 編譯結果」表格中。
觸發版本設定的執行作業
如要觸發 BigQuery 中所選版本設定的即時編譯結果,請按照下列步驟操作:
- 在儲存庫中,前往「發布內容與排程」。
- 在「Release configurations」部分中,按一下「Start execution」。
- 在「執行手動工作流程」窗格中的「版本設定」清單中,選取版本設定。
- 選取要執行的工作流程動作:
- 如要執行整個工作流程,請按一下「所有動作」。
- 如要執行工作流程中所選動作,請按一下「動作選項」,然後選取動作。
- 如要執行選取的代碼動作,請按一下「選取代碼」,然後選取代碼。
- 選用步驟:如要執行所選動作或代碼及其依附元件,請選取「Include dependencies」選項。
- 選用步驟:如要執行所選動作或代碼及其依附元件,請選取「Include dependents」選項。
選用:如要從頭重新建構所有資料表,請選取「Run with full refresh」選項。
如果沒有這個選項,Dataform 會更新增量資料表,但不會從頭重新建構。
按一下「Start execution」(開始執行)。
編輯版本設定
如要編輯版本設定,請按照下列步驟操作:
- 在儲存庫中,前往「發布內容與排程」。
- 在要編輯的發布設定中,按一下 「More」選單,然後點選「Edit」。
- 在「Edit release configuration」窗格中編輯版本設定,然後按一下「Save」。
刪除版本設定
如要刪除版本設定,請按照下列步驟操作:
- 在儲存庫中,前往「發布內容與排程」。
- 在要刪除的發布設定中,按一下 「More」選單,然後點選「Delete」。
- 在「Delete release configuration」對話方塊中,按一下「Delete」。
後續步驟
- 如要瞭解 Dataform 中程式碼生命週期的最佳做法,請參閱「管理程式碼生命週期」。
- 如要瞭解如何在工作區中手動觸發執行作業,請參閱「觸發執行作業」。
- 如要瞭解如何建立工作流程設定,請參閱「使用工作流程設定安排執行時間」。
- 如要進一步瞭解 Dataform API,請參閱 Dataform API。