設定

設定

このガイドでは、AppKit アプリケーションの環境変数と設定オプションについて説明します。

アプリのデプロイ設定

app.yaml ファイル

app.yaml ファイルでは、Databricks Apps で動作するアプリの runtime 環境を設定します。

基本的な例:

command:
  - node
  - build/index.mjs
env:
  - name: DATABRICKS_WAREHOUSE_ID
    valueFrom: sql-warehouse

コマンドの指定

アプリの起動方法を command フィールドで指定します。

command:
  - node
  - build/index.mjs

これは、AppKit サーバーの本番ビルド (npm run build で作成されたもの) を実行します。

SQL warehouse のバインド

Analytics プラグインを使用するには、app.yaml で SQL warehouse をバインドします。

env:
  - name: DATABRICKS_WAREHOUSE_ID
    valueFrom: sql-warehouse

これにより、runtime にアプリから warehouse ID を参照できるようになります。valueFrom: sql-warehouse ディレクティブは、設定された warehouse ID を注入するよう Databricks Apps に指示します。

Unity Catalog ボリュームのバインド (files プラグイン)

files プラグインは名前付きボリュームを使用します。各ボリュームキーは環境変数 DATABRICKS_VOLUME_{KEY_UPPERCASE} にマッピングされます。

env:
  - name: DATABRICKS_VOLUME_UPLOADS
    valueFrom: volume
  - name: DATABRICKS_VOLUME_EXPORTS
    valueFrom: volume

詳細については、Files plugin のドキュメントを参照してください。

高度な設定オプション (認可、ネットワーク、リソース制限) については、Databricks Apps Configuration のドキュメントを参照してください。

環境変数

Databricks Apps へのデプロイに必須

これらは通常、Databricks Apps の runtime から提供されます (具体的な変数はプラットフォームやバージョンによって異なる場合があります) :

変数説明
DATABRICKS_HOSTワークスペース URL (例: https://xxx.cloud.databricks.com)
DATABRICKS_APP_PORTバインドするポート (デフォルト: 8000)
DATABRICKS_APP_NAMEDatabricks 上のアプリ名

SQL クエリに必須 (Analytics プラグイン)

変数説明設定方法
DATABRICKS_WAREHOUSE_IDSQL warehouse IDapp.yaml で valueFrom: sql-warehouse を指定

この変数をバインドする方法の詳細は、上記の アプリのデプロイ設定 セクションを参照してください。

オプションの変数

変数説明デフォルト
DATABRICKS_WORKSPACE_IDワークスペース IDAPI から自動取得
NODE_ENV"development" または "production"—
FLASK_RUN_HOSTバインドするホスト0.0.0.0

テレメトリー (任意)

変数説明
OTEL_EXPORTER_OTLP_ENDPOINTOpenTelemetry コレクターの endpoint
OTEL_SERVICE_NAMEトレースに使用するサービス名

ローカル開発での認証

ローカル開発では、Databricks への認証が必要です。次のいずれかの方法を選択してください。

方法 1: Databricks CLI による認証 (推奨)

Databricks CLI を使って、認証を一度だけ設定します。

databricks auth login --host [host] --profile [profile-name]

プロファイル名に DEFAULT を使用している場合は、開発サーバーをそのまま起動できます。

npm run dev

特定のプロファイルで実行するには、DATABRICKS_CONFIG_PROFILE 環境変数を設定します。

DATABRICKS_CONFIG_PROFILE=my-profile npm run dev

注意: Databricks SDK のバージョンによっては、DATABRICKS_CONFIG_PROFILE ではなく DATABRICKS_PROFILE を使用します。

オプション2: 環境変数

export DATABRICKS_HOST="https://xxx.cloud.databricks.com"
export DATABRICKS_TOKEN="dapi..."
export DATABRICKS_WAREHOUSE_ID="abc123..."
npm run dev

方法 3: .env ファイル (AppKit が自動で読み込み)

プロジェクトのルートに .env ファイルを作成します (.gitignore への追加を忘れずに) :

DATABRICKS_HOST=https://xxx.cloud.databricks.com
DATABRICKS_TOKEN=dapi...
DATABRICKS_WAREHOUSE_ID=abc123...

次に、以下を実行します。

npm run dev

高度な設定

Databricks Apps の高度な設定 (認可、ネットワーク、リソース制限) については、Databricks Apps Configuration のドキュメントを参照してください。

関連項目

Databricks Developer Hub

次のエージェント型アプリを数分でリリースする準備はできていますか？

ドキュメントを読む