メインコンテンツまでスキップ
に最終更新

JavaScript 用 Databricks SDK

備考

ベータ版

JavaScript用Databricks SDKはベータ版です。ベータ期間中、Databricksは、コードが依存する各Databricks SDK for JavaScriptパッケージの特定のバージョンへの依存関係をピン留めすることをお勧めします。たとえば、プロジェクトのpackage.jsonファイルで。

GitHub の Databricks SDKs for JavaScript リポジトリで問題を報告してください。

JavaScript 用 Databricks SDK を使用して、Databricks の操作を自動化し、開発を加速します。これらの SDK は、Databricks REST API の型付きクライアントを提供します。それぞれが API ごとに個別の npmパッケージを持つ、*モジュラーアーキテクチャ*を採用しています@databricks/sdk-postgres (例:)。使用する APIs に応じたパッケージのみをインストールしてください。

このページは、Databricks SDKs for JavaScriptのREADMEとexamplesを補足するものです。

要件​

Databricks SDK for JavaScript を使用するには、開発マシンが次の要件を満たしている必要があります。

使い始める​

  1. 必要な API ごとにパッケージをインストールしてください。各Databricks APIは、@databricks/sdk-<api>という名前の別のパッケージとして公開されています。たとえば、Postgresを操作するには、Node.jsプロジェクトのルートから以下のコマンドを実行します。

    Bash
    npm install @databricks/sdk-postgres

  2. まだ構成されていない場合は、Databricks の 認証用に開発マシンを設定します。

  3. パッケージのバージョン管理されたサブパスからクライアントをインポートし、その後 API を呼び出します。以下の TypeScript の例は、認証で説明されているデフォルトの認証を使用して、Postgres プロジェクトを一覧表示します。リストメソッドは、イテレーション時に結果を透過的にページングする Iter バリアントを公開しています：

    TypeScript
    import { PostgresClient } from '@databricks/sdk-postgres/v1';

    const client = new PostgresClient({});

    for await (const project of client.listProjectsIter({})) {
      console.log(project.name);
    }

ページネーション、長時間実行される操作、エラー処理、および認証戦略を含む、より多くの実行可能な例については、GitHub の Databricks SDK for JavaScript リポジトリにある examples フォルダーを参照してください。

認証する​

デフォルトでは、クライアントはホストと資格情報を含む構成を、Databricks 構成プロファイル (~/.databrickscfg) および DATABRICKS_* 環境変数から読み取ります。これらが設定されていれば、コードで資格情報を渡す必要はありません。たとえば、次のようになります。

TypeScript
import { PostgresClient } from '@databricks/sdk-postgres/v1';

// Resolves the host and credentials from the DEFAULT profile and DATABRICKS_* environment variables.
const client = new PostgresClient({});

資格情報を明示的に設定するには、@databricks/sdk-auth/credentials からヘルパーをインポートし、credentials として渡します。以下の例では、Databricks 個人用アクセストークン認証を設定します。

TypeScript
import { PostgresClient } from '@databricks/sdk-postgres/v1';
import { newPatCredentials } from '@databricks/sdk-auth/credentials';

const client = new PostgresClient({
  host: 'https://my-company.databricks.com',
  credentials: newPatCredentials(MY_PAT_ENV_VAR),
});

@databricks/sdk-auth パッケージは、ユーザーマシン間 (U2M) OAuth 用の newU2mCredentials、マシン間 (M2M) OAuth 用の newM2mCredentials、およびデフォルトの資格情報チェーンを含む追加の資格情報プロバイダーを提供します。Databricks 認証の情報の詳細については、「Databricks 統合認証」を参照してください。

パッケージ​

各 Databricks API は、@databricks/sdk-<api> という名前の個別のパッケージとして公開されています。パッケージのバージョン管理されたサブパスからそのクライアントをインポートします。例えば、@databricks/sdk-postgres/v1 は PostgresClient をエクスポートします。

利用可能なAPIパッケージの完全なリストについては、Databricks SDKs for JavaScriptのREADMEにあるPackagesを参照してください。

共有パッケージ​

3 つのパッケージはすべての API クライアントで共有され、直接インポートする部分を提供します。

パッケージ

説明

@databricks/sdk-core

HTTP クライアント、構成プロファイルの解決、ログ、API エラーの種類（ApiError）。

@databricks/sdk-auth

認証情報プロバイダー（newPatCredentials、newU2mCredentials、newM2mCredentials）およびデフォルトの認証情報チェーン。

@databricks/sdk-options

クライアントと呼び出しに渡されるオプションの種類（ClientOptions、CallOptions）。

その他のリソース​

このページの見出し