ワークスペースでの開発の概要

このドキュメントでは、Dataform のワークスペースのコンセプトとその機能について説明します。

Dataform では、開発ワークスペースで SQL ワークフロー コードを操作します。開発ワークスペースは、リポジトリの編集可能なコピーです。ワークスペースでは、同じリポジトリで作業している他のユーザーに影響を与えることなく、リポジトリのコンテンツを作成、編集、削除し、変更を commit してリポジトリに push します。

SQL ワークフローは、Dataform コアまたは JavaScript を使用して開発できます。 Dataform は、コードをリアルタイムで SQL クエリにコンパイルします。

開発ワークスペースでは、次のタスクを実行できます。

開発ワークスペースのコンポーネント

Dataform 開発ワークスペースは、次のタブで構成されています。

コード
ファイルの探索、クエリの開発、変更のバージョン管理、BigQuery への実行のトリガーを行うことができる開発環境が含まれています。
コンパイル済みのグラフ
ワークスペースで定義されたコンパイル済み SQL ワークフローを、インタラクティブな有向非巡回グラフ（DAG）として表示します。SQL ワークフローにコンパイル エラーがある場合、タブにはグラフではなくエラー メッセージが表示されます。
実行
ワークスペースでトリガーされたすべての実行のログを表示します。選択した実行のアクションとその詳細を表示することもできます。詳細については、ワークスペースの実行ログを調べるをご覧ください。

コード タブのコンポーネント

開発ワークスペースのコードタブには、SQL ワークフローを開発するための次のコンポーネントが含まれています。

ファイル ペイン
ワークスペースのファイル構造が表示されます。ファイル構造の編集内容は自動的に保存されます。選択したファイルは、開発ペインのタブで開きます。[検索語句を入力] フィールドで、ワークスペース内のファイルまたはディレクトリをパスで検索できます。
バージョン管理ペイン
ワークスペースのバージョン管理ステータスとバージョン管理オプションが表示されます。
開発ペイン
開いているファイルをタブで表示します。編集したファイルに変更を自動保存します。
実行ボタン
コンパイルされた SQL クエリのプレビューを実行します。
[書式] ボタン
Dataform のコアまたは JavaScript コードの書式を設定します。
コンパイル ステータス
ワークスペース内のコードのコンパイル ステータスを表示します。
メタデータペイン
現在編集されているファイルのメタデータを表示します。
コンパイル済みクエリペイン
現在編集されているファイルのクエリを SQL にコンパイルします。 クエリのコンパイルが失敗した場合は、コンパイル エラーが表示されます。 クエリのコンパイルが成功した場合、コンパイルされたクエリが表示され、BigQuery に対するドライランで検証されます。 クエリの検証が失敗した場合は、検証エラーが表示されます。クエリの検証が成功すると、BigQuery に対するクエリの実行に必要なバイト数が表示されます。
実行開始プルダウン
ワークスペース内のワークフロー全体または選択した要素の実行をトリガーするためのオプションが表示されます。

コンパイル済みグラフ タブのコンポーネント

コンパイル済みグラフ タブには、コンパイルされた SQL ワークフローのインタラクティブなグラフが表示されます。このグラフには、SQL ワークフローのすべてのアクションとそれらの関係が表示されます。

ズームインまたはズームアウトできます。また、ドラッグしてグラフ内を移動します。

グラフは、次のプロパティでフィルタできます。

  • Name
  • タグ
  • 種類
    • アサーション
    • 宣言
    • 増分テーブル
    • マテリアライズド ビュー
    • オペレーション
    • Table
    • 不明
    • 表示

複数のフィルタを一度に選択できます。Dataform はそれらを OR 条件で適用します。

グラフ内のアクションをクリックすると、次のペインに詳細が表示されます。

メタデータペイン
選択したアクションの完全な名前、タイプ、依存関係、依存関係を表示します。
クエリペイン
選択したアクションのコンパイル済み SQL クエリを表示します。

ワークスペースでのバージョン管理

ワークスペースでは、Git ベースのバージョン管理を使用してリポジトリを操作します。ワークスペース内のファイルに対して行った編集は、commit 可能な commit されていないローカル変更として開始され、すべてのリポジトリ ユーザーが使用できるようにリポジトリに push されます。

リポジトリがリモートの Git プロバイダに接続されている場合は、ワークスペースからメインの開発ブランチに変更を push します。リポジトリをリモートの Git プロバイダに接続するときに、メインブランチを選択します。 接続されていない Dataform リポジトリでは、変更をデフォルトのブランチに push します。

Dataform リポジトリまたはリモート リポジトリから変更を pull し、開発ワークスペースのローカル変更と統合することもできます。Dataform のバージョン管理の詳細については、コードのバージョン管理をご覧ください。

次のステップ