Configuração

Este guia aborda as variáveis de ambiente e as opções de configuração de aplicações AppKit.

Configuração de deployment do app

Arquivo `app.yaml`

O arquivo app.yaml configura o ambiente de runtime do seu app no Databricks Apps.

Exemplo básico:

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

Especificação do comando

Especifique como iniciar seu app no campo command:

command:
  - node
  - build/index.mjs

Isso executa o build de produção do seu servidor AppKit (criado pelo npm run build).

Vinculando um SQL warehouse

Para usar o Analytics plugin, vincule um SQL warehouse no seu app.yaml:

env:
  - name: DATABRICKS_WAREHOUSE_ID
    valueFrom: sql-warehouse

Isso disponibiliza o ID do warehouse para o seu app em runtime. A diretiva valueFrom: sql-warehouse instrui o Databricks Apps a injetar o ID do warehouse configurado.

Vincular volumes do Unity Catalog (plugin de arquivos)

O plugin de arquivos usa volumes nomeados. Cada chave de volume é mapeada para uma variável de ambiente DATABRICKS_VOLUME_{KEY_UPPERCASE}:

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

Consulte a documentação do plugin Files para obter detalhes.

Para opções avançadas de configuração (autorização, rede, limites de recursos), consulte a documentação Databricks Apps Configuration.

Variáveis de ambiente

Necessárias para o deployment no Databricks Apps

Normalmente são fornecidas pelo runtime do Databricks Apps (o conjunto exato pode variar conforme a plataforma/versão):

Variável	Descrição
`DATABRICKS_HOST`	URL do workspace (ex.: `https://xxx.cloud.databricks.com`)
`DATABRICKS_APP_PORT`	Porta a ser vinculada (padrão: `8000`)
`DATABRICKS_APP_NAME`	Nome do app no Databricks

Necessário para queries SQL (Analytics plugin)

Variável	Descrição	Como definir
`DATABRICKS_WAREHOUSE_ID`	ID do SQL warehouse	No `app.yaml`: `valueFrom: sql-warehouse`

Consulte a seção Configuração de deployment do app acima para mais detalhes sobre como vincular essa variável.

Variáveis opcionais

Variável	Descrição	Padrão
`DATABRICKS_WORKSPACE_ID`	ID do workspace	Obtido automaticamente via API
`NODE_ENV`	`"development"` ou `"production"`	—
`FLASK_RUN_HOST`	Host ao qual vincular	`0.0.0.0`

Telemetria (opcional)

Variável	Descrição
`OTEL_EXPORTER_OTLP_ENDPOINT`	Endpoint do coletor OpenTelemetry
`OTEL_SERVICE_NAME`	Nome do serviço para os traces

Autenticação para desenvolvimento local

No desenvolvimento local, você precisa se autenticar no Databricks. Escolha uma das opções a seguir:

Opção 1: autenticação com a Databricks CLI (recomendada)

Configure a autenticação uma única vez usando a Databricks CLI:

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

Se você usar DEFAULT como nome do perfil, poderá executar o servidor de desenvolvimento diretamente:

npm run dev

Para executar com um perfil específico, defina a variável de ambiente DATABRICKS_CONFIG_PROFILE:

DATABRICKS_CONFIG_PROFILE=my-profile npm run dev

Observação: algumas versões do SDK do Databricks usam DATABRICKS_PROFILE em vez de DATABRICKS_CONFIG_PROFILE.

Opção 2: Variáveis de ambiente

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

Opção 3: arquivo `.env` (carregado automaticamente pelo AppKit)

Crie um arquivo .env na raiz do seu projeto (adicione-o ao .gitignore!):

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

Em seguida, execute:

npm run dev

Configuração avançada

Para configurações avançadas do Databricks Apps (autorização, rede, limites de recursos), consulte a documentação Databricks Apps Configuration.

Veja também

Gerenciamento de apps - Deploy e gerenciamento de apps
Plugins - Opções de configuração de plugins