dbt コア に接続する

この記事では、dbtとは何か、dbt Coreのインストール方法、接続方法について解説します。 dbt Cloud と呼ばれる dbt のホスト型バージョンも利用可能です。 詳細については、「dbt Cloudに接続する」を参照してください。

dbtとは何ですか?

dbt (Data Build Tool) は、select ステートメントを記述してデータを変換するための開発環境です。 dbt は、これらの SELECT 文をテーブルとビューに変換します。 dbt は、コードを生の SQL にコンパイルし、Databricks の指定されたデータベースでそのコードを実行します。 dbt は、バージョン管理、ドキュメント化、モジュール性など、協調的なコーディング パターンとベスト プラクティスをサポートします。

dbt はデータを抽出またはロードしません。 DBT は、"読み込み後の変換" アーキテクチャを使用して、変換ステップのみに焦点を当てています。 DBT は、データベースにデータのコピーが既にあることを前提としています。

dbt Core を使用すると、ローカル開発マシン上の任意の IDE で dbt コードを記述し、コマンド ラインから dbt を実行できます。 dbt Core には、dbt コマンドラインインターフェイス (CLI) が含まれています。 dbt CLIは無料で使用でき、オープンソースです。

dbt Core (および dbt Cloud) は、ホストされた Git リポジトリを使用できます。 詳細については、 Web サイトの「 dbtプロジェクトの作成 」および 「既存のプロジェクトの使用 」を参照してください。dbt

インストール要件

dbt Core をインストールする前に、ローカル開発マシンに以下をインストールする必要があります。

  • Python 3.7 以降

  • Python 仮想環境 ( pipenv など) を作成するためのユーティリティ

また、認証には次のいずれかが必要です。

  • (推奨) dbt Core がアカウントの OAuth アプリケーションとして有効になっています。 これはデフォルトで有効になっています。

    (オプション)dbt ログイン用のカスタム IdP については、「 Databricks で SSO を構成する」を参照してください。

  • A 個人用アクセストークン

    自動化されたツール、システム、スクリプト、アプリで認証する場合のセキュリティのベスト プラクティスとして、Databricks では OAuth トークンを使用することをお勧めします。

    個人のアクセス トークン認証を使用する場合、 Databricksでは、ワークスペース ユーザーではなく、サービスプリンシパルに属する個人のアクセス トークンを使用することをお勧めします。 サービスプリンシパルのトークンを作成するには、 「サービスプリンシパルのトークンの管理」を参照してください。

ステップ 1: dbt Databricks アダプターをインストールする

Python 仮想環境を使用すると、他の環境のパッケージ バージョンやコードの依存関係に関係なく、パッケージ バージョンとコードの依存関係がその特定の環境に分離されるため、使用することをお勧めします。これにより、予期しないパッケージ バージョンの不一致やコード依存関係の競合を減らすことができます。

Databricks では、バージョン 1.8.0 以降の dbt-databricks パッケージをお勧めします。

..重要: ローカル開発マシンが次のオペレーティングシステムのいずれかを使用している場合は、最初に追加のステップを完了する必要があります:CentOS、MacOS、Ubuntu、Debian、および Windows。 dbt Labs Web サイトの「 pip を使用して dbt をインストールする 」の「オペレーティング システムに前提条件がありますか」セクションを参照してください。

ステップ 2: dbt プロジェクトを作成し、接続設定を指定してテストする

dbt プロジェクト (dbt を使用するために必要な関連ディレクトリとファイルの集合) を作成します。 次に、Databricks コンピュートSQL ウェアハウス 、またはその両方への接続設定を含む接続 プロファイル を構成します。セキュリティを強化するために、dbt プロジェクトとプロファイルはデフォルトで別々の場所に保存されます。

  1. 仮想環境がアクティブ化されたままの状態で、プロジェクト名を指定して dbt init コマンドを実行します。 このプロシージャ例では、 my_dbt_demoという名前のプロジェクトを作成します。

    dbt init my_dbt_demo
    
  2. databricks データベースまたは spark データベースを選択するように求められたら、 databricksに対応する番号を入力します。

  3. host 値の入力を求められたら、次の操作を行います。

    • コンピュートの場合は、 コンピュートの JDBCODBCDatabricks「詳細オプション」の「 / 」タブから 「サーバーホスト名 」の値を入力します。

    • SQLウェアハウスの場合は、SQLウェアハウスの「 接続の詳細 」タブから 「サーバー・ホスト名 」の値を入力します。

  4. http_path 値の入力を求められたら、次の操作を行います。

    • コンピュートの場合は、 JDBCODBCDatabricksコンピュートの 「詳細オプション」の「 / 」タブから 「HTTP パス 」の値を入力します。

    • SQLウェアハウスの場合は、SQLウェアハウスの「 接続の詳細 」タブから 「HTTPパス 」の値を入力します。

  5. 認証タイプを選択するには、対応する番号を入力します use oauth (推奨) または use access token

  6. 認証の種類として [ use access token ] を選択した場合は、Databricks 個人用アクセストークンの値を入力します。

    自動化されたツール、システム、スクリプト、アプリを使用して認証する場合のセキュリティのベスト プラクティスとして、Databricks ではOAuth トークンを使用することをお勧めします。

    個人のアクセス トークン認証を使用する場合、 Databricksでは、ワークスペース ユーザーではなく、サービスプリンシパルに属する個人のアクセス トークンを使用することをお勧めします。 サービスプリンシパルのトークンを作成するには、 「サービスプリンシパルのトークンの管理」を参照してください。

  7. desired Unity Catalog option 値の入力を求められたら、 use Unity Catalog または not use Unity Catalogに対応する番号を入力します。

  8. Unity Catalogを使用する場合は、プロンプトが表示されたら、 catalog に必要な値を入力します。

  9. プロンプトが表示されたら、 schemathreads に必要な値を入力します。

  10. dbt はエントリを profiles.yml ファイルに書き込みます。 このファイルの場所は、 dbt init コマンドの出力にリストされます。 この場所は、後で dbt debug --config-dir コマンドを実行して一覧表示することもできます。 ここでこのファイルを開いて、その内容を確認および確認できます。

    認証タイプに use oauth を選択した場合は、マシン間 (M2M) またはユーザー間 (U2M) の認証プロファイルを profiles.ymlに追加します。

    以下は、プロファイルaws-oauth-u2mが指定されたprofiles.ymlファイルの例です。targetaws-oauth-u2m を指定すると、U2M プロファイルが dbt で使用されるデフォルトの実行プロファイルとして設定されます。

    my_dbt_demo:
    outputs:
       aws-oauth-u2m:
          catalog: uc_demos
          host: "xxx.cloud.databricks.com"
          http_path: "/sql/1.0/warehouses/9196548d010cf14d"
          schema: databricks_demo
          threads: 1
          type: databricks
          auth_type: oauth
    target: aws-oauth-u2m
    

    Databricks では、シークレットを profiles.yml に直接指定することはお勧めしません。 代わりに、クライアント ID とクライアント シークレットを環境変数として設定します。

  11. my_dbt_demoディレクトリで dbt debug コマンドを実行して、接続の詳細を確認します。

    認証の種類として use oauth を選択した場合は、ID プロバイダーでサインインするように求められます。

    重要

    開始する前に、コンピュートまたは SQLウェアハウスが動作していることを確認します。

    次のような出力が表示されます。

    cd my_dbt_demo
    dbt debug
    
    ...
    Configuration:
      profiles.yml file [OK found and valid]
      dbt_project.yml file [OK found and valid]
    
    Required dependencies:
      - git [OK found]
    
    Connection:
      ...
      Connection test: OK connection ok
    

次のステップ