Dataform 開発ワークスペースを作成する

このドキュメントでは、次の方法について説明します。

新しいリポジトリに開発ワークスペースを初めて作成する場合、Dataform は、Dataform の動作に必要な一連の構成ファイルを使用して開発ワークスペースを初期化するように求められます。

初期化された開発ワークスペースには、次のディレクトリとファイルが含まれています。

  • definitions/: Dataform コアまたは JavaScript のアセット定義用のディレクトリ。

  • includes/: リポジトリ全体で再利用できるスクリプトと変数用の空のディレクトリ。

  • dataform.json: アセットを公開する Google Cloud プロジェクト ID と BigQuery スキーマを含むデフォルトの Dataform 構成ファイル。デフォルト設定をオーバーライドしてニーズに合わせてカスタマイズできますが、Dataform の使用を開始するために必要なわけではありません。

  • package.json: 最新バージョンの @dataform/core を含むデフォルトの Dataform 依存関係構成ファイル。このファイルを使用して、パッケージをインポートできます。

  • definitions/sample.sqlx: 使い始める際に役立つ SQLX サンプル ファイル。

始める前に

まだ作成していない場合は、Dataform リポジトリを作成します。

必要なロール

開発ワークスペースの作成、初期化、削除に必要な権限を取得するには、ワークスペースに対する Dataform 編集者 （roles/dataform.editor）IAM ロールの付与を管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

Dataform 開発ワークスペースを作成する

新しい Dataform 開発ワークスペースを作成する手順は次のとおりです。

  1. Google Cloud コンソールの [Dataform] ページに移動します。

    Dataform に移動

  2. 新しい開発ワークスペースを作成するリポジトリを選択します。

  3. リポジトリ ページで、[開発ワークスペースを作成] をクリックします。

  4. [開発ワークスペースを作成] ウィンドウで、次の操作を行います。

    1. [ワークスペース ID] フィールドに、開発ワークスペースの一意の ID を入力します。

      ID には数字、英字、ハイフン、アンダースコアのみを使用できます。

    2. [作成] をクリックします。

Dataform リポジトリで最初の開発ワークスペースを初期化する

Dataform 開発ワークスペースを初期化するには、次の手順に沿って操作します。

  1. Google Cloud コンソールの [Dataform] ページに移動します。

    Dataform に移動

  2. 空のワークスペースを初期化するリポジトリを選択します。

  3. [開発ワークスペース] タブで、初期化する空のワークスペースの名前をクリックします。

  4. 開発ワークスペース ページで、[ワークスペースを初期化] をクリックします。

Dataform 開発ワークスペースを削除する

Dataform 開発ワークスペースの作成に伴う費用は発生しません。ただし、開発ワークスペースを削除する場合は、次の手順に沿って操作します。

  1. [Dataform] ページで、削除するワークスペースを含むリポジトリをクリックします。

  2. commit されていない変更が削除されないようにするには、変更を commit して Git リポジトリに push します。

  3. [開発ワークスペース] タブで、削除する開発ワークスペースを選択し、[選択したワークスペースを削除] をクリックします。

    一度に複数のワークスペースを削除できます。

  4. [削除] をクリックして確定します。

次のステップ