開発環境を作成する
このクイックスタートでは、各デベロッパーが独自の開発環境で作業できるように、Dataform で個々の開発環境を作成する手順について説明します。
- Dataform リポジトリの作成
- Dataform に BigQuery へのアクセス権を付与します。
-
Dataform によってリポジトリ内のすべてのワークスペースに適用されるコンパイルのオーバーライドを構成し、ワークスペースを分離された開発環境に変換します。
準備
- Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
-
Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。
-
BigQuery and Dataform API を有効にします。
-
Google Cloud Console の [プロジェクト セレクタ] ページで、Google Cloud プロジェクトを選択または作成します。
-
BigQuery and Dataform API を有効にします。
必要なロール
このチュートリアルのすべてのタスクに必要な権限を取得するには、次の IAM ロールを付与するよう管理者に依頼してください。
-
リポジトリの Dataform 管理者(
roles/dataform.admin
) -
ワークスペースと workflowInvocations に対する Dataform 編集者(
roles/dataform.editor
)
ロールの付与の詳細については、アクセスの管理をご覧ください。
Dataform リポジトリの作成
Google Cloud コンソールの [Dataform] ページに移動します。
[リポジトリを作成] をクリックします。
[リポジトリの作成] ページで、次の操作を行います。
[リポジトリ ID] フィールドに「
quickstart-dev
」と入力します。[リージョン] リストで
europe-west4
を選択します。[作成] をクリックします。
[完了] をクリックします。
Dataform に BigQuery へのアクセス権を付与する
BigQuery でワークフローを実行するには、Dataform サービス アカウントに次のロールが必要です。
- Dataform が読み取りと書き込みの両方のアクセス権を必要とするプロジェクトに対する BigQuery データ編集者。 通常は、Dataform リポジトリをホストするプロジェクトが含まれます。
- Dataform が読み取り専用アクセス権を必要とするプロジェクトに対する BigQuery データ閲覧者。
- Dataform リポジトリをホストするプロジェクトに対する BigQuery ジョブユーザー。
これらのロールを付与するには、次の手順に沿って操作します。
Google Cloud コンソールの [IAM] ページに移動します。
[Add(追加)] をクリックします。
[新しいプリンシパル] フィールドに、Dataform サービス アカウント ID を入力します。
[ロールを選択] プルダウン リストで、[BigQuery ジョブユーザー] ロールを選択します。
[別のロールを追加] をクリックし、[ロールを選択] プルダウン リストで [BigQuery データ編集者] ロールを選択します。
[別のロールを追加] をクリックし、[ロールを選択] プルダウン リストで [BigQuery データ閲覧者] ロールを選択します。
[保存] をクリックします。
ワークスペース コンパイルのオーバーライドを構成する
Dataform ワークスペースのコンパイル オーバーライドを使用して分離された開発環境を作成する手順は次のとおりです。
Google Cloud コンソールの [Dataform] ページに移動します。
[
quickstart-dev
] をクリックします。[設定]、[編集] の順にクリックします。
[ワークスペースのコンパイルのオーバーライド] ペインで、[スキーマ サフィックス] フィールドに「
${workspaceName}
」と入力します。ワークスペースで実行をトリガーすると、Dataform はワークスペースの名前を
dataform.json
に設定されたデフォルトのスキーマに接尾辞として追加します。このクイックスタートではデフォルトの Dataform 設定を使用し、dataform
デフォルト スキーマを使用します。[保存] をクリックします。
Dataform は、リポジトリ内のすべてのワークスペースにワークスペース コンパイル オーバーライドを適用します。
この構成では、ワークスペースで SQL ワークフローを手動で実行すると、Dataform はこれをワークスペースのコンパイル オーバーライドで実行します。この結果、Dataform は BigQuery の dataform_workspaceName
スキーマで SQL ワークフローを実行し、ワークスペースを隔離された開発環境に変換します。
たとえば、sasha
ワークスペースで手動で実行をトリガーすると、Dataform は BigQuery の dataform_sasha
スキーマで SQL ワークフローを実行します。
SQL ワークフローをワークスペースのコンパイル オーバーライドなしで実行し、かつ、開発環境にワークスペースのコンパイル オーバーライドを保持するには、他の実行環境(staging
や production
など)を構成するリリース構成を作成します。
クリーンアップ
このページで使用したリソースについて、Google Cloud アカウントに課金されないようにするには、次の手順を行います。
BigQuery で作成したデータセットを削除する
BigQuery アセットの料金が発生しないようにするには、dataform
で始まる名前(dataform-sasha
など)のデータセットを削除します。
Google Cloud コンソールで [BigQuery] ページに移動します。
[エクスプローラ] パネルでプロジェクトを開いて、データセットを選択します。
[アクション] メニューをクリックして、[削除] を選択します。
[データセットを削除する] ダイアログで、フィールドに「
delete
」と入力してから、[削除] をクリックします。
Dataform リポジトリの削除
Dataform リポジトリの作成に伴う費用は発生しません。ただし、リポジトリとそのすべてのコンテンツを削除するには、次の手順を行います。
Google Cloud コンソールの [Dataform] ページに移動します。
quickstart-dev
で、 [その他] メニューをクリックし、[削除] を選択します。- [リポジトリの削除] ウィンドウで、リポジトリの名前を入力して削除を確定します。
[削除] をクリックして確定します。
次のステップ
Dataform のコード ライフサイクルの詳細については、Dataform のコード ライフサイクルの概要をご覧ください。
Dataform のコード ライフサイクルのベスト プラクティスの詳細については、コード ライフサイクルの管理をご覧ください。
Dataform でのワークスペースのコンパイル オーバーライドの詳細については、ワークスペースのコンパイル オーバーライドの作成をご覧ください。
Dataform で本番環境実行のスケジュールを設定する方法については、本番環境実行のスケジュールをご覧ください。