Início rápido

Pré-requisitos

Databricks CLI v1.0.0+ com um perfil autenticado
psql (cliente PostgreSQL), caso use databricks psql. Como alternativa, use generate-database-credential com qualquer cliente PostgreSQL.
Workspace com acesso ao Lakebase Postgres habilitado

Caminho do template

Explore os templates abaixo, escolha um para o seu caso de uso e copie-o para o seu assistente de programação com IA. Cada um inclui o recurso Criar um projeto Lakebase, que orienta a criação do projeto e a coleta dos valores de conexão.

Template	Ideal para
App com Lakebase	Apps CRUD com armazenamento persistente
App de chat com IA	IA conversacional com histórico de chat
Análise de dados operacionais	Sincronização bidirecional entre Lakebase Postgres e Unity Catalog

Personalize seu app

Depois de implantar um app com Lakebase Postgres, considere as seguintes personalizações:

Adicionar tabelas: siga o template Lakebase Data Persistence para definir esquemas, gerar tipos e criar rotas CRUD.
Adicionar memória ao agente: use o template Lakebase Agent Memory para persistir as conversas de chat do seu agente.
Usar feature branches: crie branches isoladas para desenvolvimento e testes. A seção Desenvolvimento: Feature branches traz os comandos da CLI.
Sincronizar dados com o Unity Catalog: use o Lakebase Change Data Feed (CDF) para replicar tabelas do Lakebase Postgres no Delta, ou as Sync Tables para disponibilizar dados do Unity Catalog por meio dele.
Implantar fora do Databricks: use o template Lakebase Off-Platform para apps hospedados na AWS, Vercel, Netlify e outros.

Caminho manual

Quando você cria a estrutura do projeto sem um template, o databricks apps init gera um projeto AppKit funcional. Antes, você precisa de um projeto Lakebase. Crie um:

databricks postgres create-project <project-id>

O ID passa a ser o nome do recurso do projeto (projects/<project-id>). Para uma configuração guiada, incluindo branches e valores de conexão, consulte o template Criar um projeto Lakebase ou a agent skill databricks-lakebase.

Interativo (recomendado para desenvolvimento local): execute sem flags.

databricks apps init

A CLI solicita o nome do seu app e, em seguida, lista os plugins (recursos) disponíveis. Selecione Lakebase e ela guiará você na escolha de um projeto Lakebase existente, de uma branch e de um banco de dados.

Modo não interativo (para scripts e CI): passe --name e os campos --set obrigatórios de cada recurso de plugin selecionado. O valor de database deve ser o caminho completo do recurso, obtido com databricks postgres list-databases projects/<project-id>/branches/<branch-id> -o json (use o campo 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>

Em seguida, faça primeiro o deploy para criar os schemas e depois execute localmente:

cd my-app
databricks apps deploy

tip

Execute databricks apps deploy antes de npm run dev. A implantação configura uma identidade gerenciada (o service principal do app) que cria o schema do banco de dados na primeira inicialização. Se você rodar npm run dev primeiro, o schema será criado com suas credenciais pessoais e, quando você implantar depois, a identidade gerenciada do app não conseguirá acessá-lo. Veja mais detalhes em Configuração local.

npm install && npm run dev

Próximos passos

Para conhecer o fluxo de trabalho de desenvolvimento local, as feature branches e a API completa do plugin, consulte Desenvolvimento com Lakebase Postgres.