クイックスタート

前提条件

Databricks CLI v1.0.0+（認証済みプロファイルが設定されていること）
databricks psql を使用する場合は psql（PostgreSQL クライアント）。または、任意の PostgreSQL クライアントと generate-database-credential を組み合わせて使用することもできます。
Lakebase Postgres へのアクセスが有効になっているワークスペース

テンプレートパス

以下のテンプレートを確認し、ユースケースに合ったものを選んで、AI コーディングアシスタントに貼り付けてください。各テンプレートには Create a Lakebase Project リソースが含まれており、プロジェクトの作成から接続情報の取得までを順を追って説明します。

テンプレート	適したユースケース
App with Lakebase	永続ストレージを備えた CRUD アプリ
AI Chat App	チャット履歴を伴う対話型 AI
Operational Data Analytics	Lakebase Postgres と Unity Catalog 間の双方向同期

アプリをカスタマイズする

Lakebase Postgres をバックエンドとするアプリをデプロイしたら、次のカスタマイズを検討してください。

テーブルを追加する: Lakebase Data Persistence テンプレートに従って、スキーマの定義、型の生成、CRUD ルートの作成を行います。
エージェントメモリを追加する: Lakebase Agent Memory テンプレートを使用して、エージェントのチャット会話を永続化します。
フィーチャーブランチを使う: 開発やテスト用に分離された branch を作成します。CLI コマンドについては開発: フィーチャーブランチのセクションを参照してください。
Unity Catalog との間でデータを同期する: Lakebase Change Data Feed (CDF) を使用して Lakebase Postgres のテーブルを Delta に複製する、または Sync Tables を使用して Unity Catalog のデータを Lakebase 経由で提供します。
Databricks の外部にデプロイする: AWS、Vercel、Netlify などでホストするアプリには、Lakebase Off-Platform テンプレートを使用します。

手動での手順

templateを使わずにscaffoldした場合、databricks apps init が動作するAppKitプロジェクトを生成します。その前にLakebaseプロジェクトが必要です。次のコマンドで作成します。

databricks postgres create-project <project-id>

このIDがプロジェクトのリソース名 (projects/<project-id>) になります。branchや接続情報の設定を含むガイド付きセットアップについては、Create a Lakebase Project templateまたは databricks-lakebase エージェントスキルを参照してください。

インタラクティブ (ローカル開発で推奨) : フラグを付けずに実行します。

databricks apps init

CLI はアプリ名の入力を求めた後、利用可能なプラグイン (機能) を一覧表示します。Lakebase を選択すると、既存の Lakebase プロジェクト、branch、データベースの選択手順が順に案内されます。

非対話モード (スクリプトや CI 向け) : --name と、選択した各プラグイン機能に必要な --set フィールドを指定します。database の値にはリソースの完全なパスを指定する必要があります。パスは databricks postgres list-databases projects/<project-id>/branches/<branch-id> -o json で取得できます (name フィールドの値を使用します) :

databricks apps init --name my-app --features lakebase \
  --set lakebase.postgres.project=projects/<project-id> \
  --set lakebase.postgres.branch=projects/<project-id>/branches/<branch-id> \
  --set lakebase.postgres.database=projects/<project-id>/branches/<branch-id>/databases/<database-id>

次に、先にデプロイしてスキーマを作成してから、ローカルで実行します。

cd my-app
databricks apps deploy

tip

npm run dev の前に databricks apps deploy を実行してください。デプロイを行うとマネージドID (アプリのサービスプリンシパル) が設定され、初回起動時にこのIDがデータベーススキーマを作成します。先に npm run dev を実行すると、スキーマがご自身の個人資格情報で作成されてしまい、後からデプロイしてもアプリのマネージドIDからアクセスできなくなります。詳しくはローカルセットアップを参照してください。

npm install && npm run dev

次のステップ

ローカル開発のワークフロー、フィーチャーブランチ、プラグイン API の詳細については、Lakebase Postgres 開発を参照してください。