Démarrage rapide

Prérequis

Databricks CLI v1.0.0+ avec un profil authentifié
psql (client PostgreSQL) si vous utilisez databricks psql. Vous pouvez également utiliser generate-database-credential avec n'importe quel client PostgreSQL.
Un workspace avec l'accès à Lakebase Postgres activé

Chemin des modèles

Parcourez les modèles ci-dessous, choisissez celui qui correspond à votre cas d'usage et copiez-le dans votre assistant de codage IA. Chacun inclut la ressource Create a Lakebase Project, qui guide la création du projet et la collecte des valeurs de connexion.

Modèle	Idéal pour
App with Lakebase	Applications CRUD avec stockage persistant
AI Chat App	IA conversationnelle avec historique des conversations
Operational Data Analytics	Synchronisation bidirectionnelle entre Lakebase Postgres et Unity Catalog

Personnaliser votre application

Après avoir déployé une application adossée à Lakebase Postgres, envisagez les personnalisations suivantes :

Ajouter des tables : suivez le modèle Lakebase Data Persistence pour définir des schémas, générer des types et créer des routes CRUD.
Ajouter une mémoire d'agent : utilisez le modèle Lakebase Agent Memory pour conserver les conversations de votre agent.
Utiliser des branches de fonctionnalités : créez des branches isolées pour le développement et les tests. La section Développement : branches de fonctionnalités répertorie les commandes CLI.
Synchroniser des données depuis/vers Unity Catalog : utilisez Lakebase Change Data Feed (CDF) pour répliquer les tables Lakebase Postgres dans Delta, ou Sync Tables pour exposer les données d'Unity Catalog via Lakebase.
Déployer en dehors de Databricks : utilisez le modèle Lakebase Off-Platform pour les applications hébergées sur AWS, Vercel, Netlify et d'autres plateformes.

Parcours manuel

Lorsque vous générez un projet sans modèle, databricks apps init produit un projet AppKit fonctionnel. Vous devez d'abord disposer d'un projet Lakebase. Créez-en un :

databricks postgres create-project <project-id>

L'identifiant devient le nom de ressource du projet (projects/<project-id>). Pour une configuration guidée incluant les branches et les valeurs de connexion, consultez le modèle Create a Lakebase Project ou la compétence d'agent databricks-lakebase.

Interactif (recommandé pour le développement local) : exécutez la commande sans options.

databricks apps init

La CLI vous demande le nom de votre application, puis affiche la liste des plugins (fonctionnalités) disponibles. Sélectionnez Lakebase : elle vous guide ensuite dans le choix d'un projet Lakebase, d'une branch et d'une base de données existants.

Mode non interactif (pour les scripts et la CI) : passez --name ainsi que les champs --set requis pour chaque fonctionnalité de plugin sélectionnée. La valeur database doit être le chemin de ressource complet, récupéré via databricks postgres list-databases projects/<project-id>/branches/<branch-id> -o json (utilisez le champ 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>

Déployez ensuite une première fois pour créer les schémas, puis exécutez l'application en local :

cd my-app
databricks apps deploy

tip

Exécutez databricks apps deploy avant npm run dev. Le déploiement met en place une identité gérée (le service principal de l'application) qui crée le schéma de base de données au premier démarrage. Si vous lancez npm run dev en premier, le schéma sera créé avec vos identifiants personnels et, lors du déploiement ultérieur, l'identité gérée de l'application ne pourra pas y accéder. La page Configuration locale détaille ce point.

npm install && npm run dev

Et ensuite

Pour le workflow de développement local, les branches de fonctionnalités et l'API complète du plugin, consultez Développement avec Lakebase Postgres.