Referência de configuração

Esta página fornece uma referência para as chaves compatíveis com a configuração de Pacotes de Automação Declarativa (anteriormente conhecidos como Pacotes de Ativos do Databricks) (YAML). Consulte O que são Pacotes de Automação Declarativa?.

Para obter exemplos completos de pacotes, consulte Exemplos de configuração de pacotes e o repositório GitHub de exemplos de pacotes.

artefatos

Type: Map

Especifica os artefatos a serem criados automaticamente durante as implantações de pacotes, que podem ser usados posteriormente na execução do pacote. Cada key é o nome do artefato e o valor é um mapa que define as configurações de construção do artefato.

dica

Você pode definir, combinar e substituir as configurações de artefatos em pacotes, conforme descrito em Substituir com configurações de destino.

YAML

artifacts:
  <artifact-name>:
    <artifact-field-name>: <artifact-field-value>

Chave	Tipo	Descrição
build	String	Um conjunto opcional de comandos de construção para execução local antes da implantação. Para compilações Python wheel , a CLI Databricks assume que pode encontrar uma instalação local do pacote Python wheel para executar compilações e executa o comando python setup.py bdist_wheel por default durante cada implantação de pacote. Especifique vários comandos de compilação em linhas separadas.
dynamic_version	Booleana	Indica se a versão do pacote (wheel) deve ser corrigida dinamicamente com base no carimbo de data/hora do arquivo whl. Se isso for definido como true, o novo código poderá ser implantado sem ter que atualizar a versão em setup.py ou pyproject.toml. Esta configuração só é válida quando type está definido como whl. Adicionado na versão 0.245.0 da CLI do Databricks.
executable	String	O tipo executável. Os valores válidos são bash, sh e cmd.
files	Sequência	O caminho relativo ou absoluto para os arquivos de artefatos criados. Veja artefatos. nome .files.
git	Mapa	Para um artefato tgz, tire um snapshot dessa referência (ref) do Git em vez da árvore de trabalho. Exclusivo mútuo com build. Consulte artifacts. name .git. Adicionado na versão 1.15.0 da CLI do Databricks
include	Sequência	Para um artefato tgz, subcaminhos de path a serem compactados, relativos a ele; vazio compacta todo o path. .gitignore é respeitado; as inclusões/exclusões de sincronização em todo o pacote não se aplicam. As entradas de arquivo são nomeadas em relação a path. Mutuamente exclusivo com build. Adicionado na versão 1.15.0 da CLI do Databricks
path	String	O caminho local do diretório onde o artefato está localizado. Os caminhos são relativos à localização do arquivo de configuração do pacote. Para compilações Python wheel , é o caminho para o arquivo setup.py do arquivo Python wheel . Se path não estiver incluído, a CLI Databricks tentará encontrar o arquivo setup.py do arquivo Python wheel na raiz do pacote.
type	String	O tipo do artefato. Os valores válidos são whl, jar e tgz. Obrigatório se o artefato for uma Python wheel. Esta configuração não precisa ser especificada para criar outros artefatos.

Chave	Tipo	Descrição
build	String	Um conjunto opcional de comandos de construção para execução local antes da implantação. Para compilações Python wheel , a CLI Databricks assume que pode encontrar uma instalação local do pacote Python wheel para executar compilações e executa o comando python setup.py bdist_wheel por default durante cada implantação de pacote. Especifique vários comandos de compilação em linhas separadas.
dynamic_version	Booleana	Indica se a versão do pacote (wheel) deve ser corrigida dinamicamente com base no carimbo de data/hora do arquivo whl. Se isso for definido como true, o novo código poderá ser implantado sem ter que atualizar a versão em setup.py ou pyproject.toml. Esta configuração só é válida quando type está definido como whl. Adicionado na versão 0.245.0 da CLI do Databricks.
executable	String	O tipo executável. Os valores válidos são bash, sh e cmd.
files	Sequência	O caminho relativo ou absoluto para os arquivos de artefatos criados. Veja artefatos. nome .files.
git	Mapa	Para um artefato tgz, tire um snapshot dessa referência (ref) do Git em vez da árvore de trabalho. Exclusivo mútuo com build. Consulte artifacts. name .git. Adicionado na versão 1.15.0 da CLI do Databricks
include	Sequência	Para um artefato tgz, subcaminhos de path a serem compactados, relativos a ele; vazio compacta todo o path. .gitignore é respeitado; as inclusões/exclusões de sincronização em todo o pacote não se aplicam. As entradas de arquivo são nomeadas em relação a path. Mutuamente exclusivo com build. Adicionado na versão 1.15.0 da CLI do Databricks
path	String	O caminho local do diretório onde o artefato está localizado. Os caminhos são relativos à localização do arquivo de configuração do pacote. Para compilações Python wheel , é o caminho para o arquivo setup.py do arquivo Python wheel . Se path não estiver incluído, a CLI Databricks tentará encontrar o arquivo setup.py do arquivo Python wheel na raiz do pacote.
type	String	O tipo do artefato. Os valores válidos são whl, jar e tgz. Obrigatório se o artefato for uma Python wheel. Esta configuração não precisa ser especificada para criar outros artefatos.

Exemplos

A seguinte configuração cria um Python wheel usando Poetry:

YAML

artifacts:
  default:
    type: whl
    build: poetry build
    path: .

A seguinte configuração executa testes e cria um pacote wheel. Para um tutorial completo de criação de pacotes que usa artifacts para construir um wheel, consulte Criar um arquivo Python wheel usando pacotes de automação declarativa.

YAML

artifacts:
  default:
    type: whl
    build: |-
      # run tests
      python -m pytest tests/ -v

      # build the actual artifact
      python setup.py bdist_wheel

    path: .

Para um exemplo de configuração que cria um arquivo JAR e o carrega no Unity Catalog, consulte Bundle that upload a JAR file to Unity Catalog.

artefatos.nome .arquivos

Type: Sequence

O caminho relativo ou absoluto para os arquivos do artefato compilado. Use source para especificar os artefatos construídos. Os caminhos são relativos à localização do arquivo de configuração do pacote.

Chave	Tipo	Descrição
source	String	Obrigatório. O arquivo de origem do artefato.

Chave	Tipo	Descrição
source	String	Obrigatório. O arquivo de origem do artefato.

artifacts. name .git

Type: Map

Para um artefato tgz, tire um snapshot desta referência do git em vez da árvore de trabalho. Exclusivo mútuo com build.

Adicionado na versão 1.15.0 da CLI do Databricks

Chave	Tipo	Descrição
branch	String	A branch do git para gerar o snapshot. Adicionado na versão 1.15.0 da CLI do Databricks
commit	String	O commit do git para gerar o snapshot. Tem precedência sobre branch quando ambos estão definidos. Adicionado na versão 1.15.0 da CLI do Databricks

Chave	Tipo	Descrição
branch	String	A branch do git para gerar o snapshot. Adicionado na versão 1.15.0 da CLI do Databricks
commit	String	O commit do git para gerar o snapshot. Tem precedência sobre branch quando ambos estão definidos. Adicionado na versão 1.15.0 da CLI do Databricks

pacote

Type: Map

Os atributos do pacote quando implantado nesse destino.

Um arquivo de configuração de pacote deve conter apenas um mapeamento de nível superior bundle .

Esse mapeamento de bundle deve conter um mapeamento de name que especifica um nome programático (ou lógico) para o pacote. O exemplo a seguir declara um pacote com o nome programático (ou lógico) hello-bundle.

YAML

bundle:
  name: hello-bundle

Um mapeamento bundle também pode ser filho de um ou mais dos alvos no mapeamento de alvos de nível superior. Cada um desses mapeamentos filhos bundle especifica quaisquer substituições nãodefault no nível de destino.

Chave	Tipo	Descrição
cluster_id	String	O ID de um cluster a ser usado para executar o pacote. Essa key permite especificar o ID de um cluster para usar como substituto para clusters definidos em outras partes do arquivo de configuração do pacote. Para obter informações sobre como recuperar o ID de um cluster, consulte URL e ID do recurso de computação. A substituição cluster_id destina-se apenas a cenários de desenvolvimento e só é suportada para o destino que tem seu mapeamento mode definido como development. Para obter mais informações sobre o mapeamento target , consulte targets.
compute_id	String	Obsoleto. O ID do site compute a ser usado para executar o pacote.
databricks_cli_version	String	A versão da CLI do Databricks a ser usada para o pacote. Consulte bundle.databricks_cli_version.
deployment	Mapa	A definição da implantação do pacote. Para obter informações sobre os atributos compatíveis, consulte os modos de implantação dos Pacotes de Automação Declarativa. Consulte bundle.deployment.
engine	String	O mecanismo de implantação a ser utilizado. Os valores válidos são terraform e direct. O valor default é direct. Esta configuração tem prioridade sobre a variável de ambiente DATABRICKS_BUNDLE_ENGINE . Para obter informações sobre o mecanismo de implantação direta, consulte Migrar para o mecanismo de implantação direta. Adicionado na versão 0.295.0 da CLI do Databricks.
git	Mapa	Os detalhes do controle de versão Git associados ao seu pacote. Para obter informações sobre os atributos suportados, consulte o git.
name	String	O nome do pacote.
uuid	String	Reservado. Um UUID (Universally Unique Identifier, identificador universal exclusivo) para o pacote que o identifica exclusivamente nos sistemas internos da Databricks. Isso é gerado quando um projeto de pacote é inicializado usando um padrão Databricks (usando o comando databricks bundle init). Adicionado na versão 0.236.0 da CLI do Databricks.

Chave	Tipo	Descrição
cluster_id	String	O ID de um cluster a ser usado para executar o pacote. Essa key permite especificar o ID de um cluster para usar como substituto para clusters definidos em outras partes do arquivo de configuração do pacote. Para obter informações sobre como recuperar o ID de um cluster, consulte URL e ID do recurso de computação. A substituição cluster_id destina-se apenas a cenários de desenvolvimento e só é suportada para o destino que tem seu mapeamento mode definido como development. Para obter mais informações sobre o mapeamento target , consulte targets.
compute_id	String	Obsoleto. O ID do site compute a ser usado para executar o pacote.
databricks_cli_version	String	A versão da CLI do Databricks a ser usada para o pacote. Consulte bundle.databricks_cli_version.
deployment	Mapa	A definição da implantação do pacote. Para obter informações sobre os atributos compatíveis, consulte os modos de implantação dos Pacotes de Automação Declarativa. Consulte bundle.deployment.
engine	String	O mecanismo de implantação a ser utilizado. Os valores válidos são terraform e direct. O valor default é direct. Esta configuração tem prioridade sobre a variável de ambiente DATABRICKS_BUNDLE_ENGINE . Para obter informações sobre o mecanismo de implantação direta, consulte Migrar para o mecanismo de implantação direta. Adicionado na versão 0.295.0 da CLI do Databricks.
git	Mapa	Os detalhes do controle de versão Git associados ao seu pacote. Para obter informações sobre os atributos suportados, consulte o git.
name	String	O nome do pacote.
uuid	String	Reservado. Um UUID (Universally Unique Identifier, identificador universal exclusivo) para o pacote que o identifica exclusivamente nos sistemas internos da Databricks. Isso é gerado quando um projeto de pacote é inicializado usando um padrão Databricks (usando o comando databricks bundle init). Adicionado na versão 0.236.0 da CLI do Databricks.