Compartilhar via


Grupo de comandos workspace

Note

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

O workspace grupo de comandos dentro da CLI do Databricks permite que você liste, importe, exporte e exclua arquivos e pastas do workspace. Veja o que são arquivos de workspace?.

exclusão de workspace do databricks

Excluir um objeto da área de trabalho.

Exclui um objeto ou um diretório (e, opcionalmente, exclui todos os objetos no diretório). Se o caminho não existir, essa chamada retornará um erro RESOURCE_DOES_NOT_EXIST. Se o caminho for um diretório não vazio e o recursivo for definido como false, essa chamada retornará um erro DIRECTORY_NOT_EMPTY.

A exclusão de objeto não pode ser desfeita e excluir um diretório recursivamente não é atômica.

databricks workspace delete PATH [flags]

Arguments

PATH

    O caminho absoluto do notebook ou diretório.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--recursive

    O sinalizador que especifica se o objeto será excluído recursivamente.

Sinalizadores globais

exportação de workspace do databricks

Exportar um objeto de workspace ou o conteúdo de um diretório inteiro.

Se o caminho não existir, essa chamada retornará um erro RESOURCE_DOES_NOT_EXIST.

Se os dados exportados excederem o limite de tamanho, essa chamada retornará MAX_NOTEBOOK_SIZE_EXCEEDED. Atualmente, essa API não dá suporte à exportação de uma biblioteca.

databricks workspace export SOURCE_PATH [flags]

Arguments

PATH

    O caminho absoluto do objeto ou diretório. A exportação de um diretório só tem suporte para o formato DBC, SOURCE e AUTO.

Opções

--file string

    Caminho no sistema de arquivos local no qual salvar o arquivo exportado.

--format ExportFormat

    Isso especifica o formato do arquivo exportado. Valores com suporte: AUTO, , DBC, HTML, JUPYTER, RAW, , , R_MARKDOWNSOURCE

Sinalizadores globais

exportação de diretório do workspace do databricks

Exporte um diretório recursivamente de um workspace do Databricks para o sistema de arquivos local.

databricks workspace export-dir SOURCE_PATH TARGET_PATH [flags]

Arguments

SOURCE_PATH

    O caminho do diretório de origem no workspace

TARGET_PATH

    O caminho do diretório de destino no sistema de arquivos local

Opções

--overwrite

    substituir arquivos locais existentes

Sinalizadores globais

obter-status do workspace do databricks

Obtenha o status de um objeto ou diretório. Se o caminho não existir, essa chamada retornará um erro RESOURCE_DOES_NOT_EXIST.

databricks workspace get-status PATH [flags]

Arguments

PATH

    O caminho absoluto do notebook ou diretório.

Opções

Sinalizadores globais

Importação do Workspace do Databricks

Importa um objeto de workspace (por exemplo, um notebook ou arquivo) ou o conteúdo de um diretório inteiro. Se o caminho já existir e a substituição estiver definida como false, essa chamada retornará um erro RESOURCE_ALREADY_EXISTS. Para importar um diretório, você pode usar o DBC formato ou o SOURCE formato com o campo de idioma não definido. Para importar um único arquivo como SOURCE, você deve definir o campo de idioma. Não há suporte para arquivos zip em diretórios.

databricks workspace import TARGET_PATH [flags]

Arguments

PATH

    O caminho absoluto do objeto ou diretório. A importação de um diretório só é suportada para os formatos DBC e SOURCE.

Opções

--content string

    O conteúdo codificado em base64.

--file string

    Caminho do arquivo local a ser importado

--format ImportFormat

    Isso especifica o formato do arquivo a ser importado. Valores com suporte: AUTO, , DBC, HTML, JUPYTER, RAW, , , R_MARKDOWNSOURCE

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

--language Language

    O idioma do objeto. Valores com suporte: PYTHON, R, SCALA, SQL

--overwrite

    O sinalizador que especifica se o objeto existente deve ser substituído.

Sinalizadores globais

importação de diretório do workspace do databricks

Importe um diretório recursivamente do sistema de arquivos local para um workspace do Databricks.

Os notebooks terão suas extensões removidas.

databricks workspace import-dir SOURCE_PATH TARGET_PATH [flags]

Arguments

SOURCE_PATH

    O caminho do diretório de origem no sistema de arquivos local

TARGET_PATH

    O caminho do diretório de destino no workspace

Opções

--overwrite

    substituir arquivos de workspace existentes

Sinalizadores globais

lista do workspace do databricks

Liste o conteúdo de um diretório ou o objeto se ele não for um diretório. Se o caminho de entrada não existir, essa chamada retornará um erro RESOURCE_DOES_NOT_EXIST.

databricks workspace list PATH [flags]

Arguments

PATH

    O caminho absoluto do notebook ou diretório.

Opções

--notebooks-modified-after int

    Carimbo UTC em milissegundos.

Sinalizadores globais

mkdirs do workspace do databricks

Cria o diretório especificado (e os diretórios pais necessários, se eles não existirem). Se houver um objeto (não um diretório) em qualquer prefixo do caminho de entrada, essa chamada retornará um erro RESOURCE_ALREADY_EXISTS.

Observe que, se essa operação falhar, é possível que alguns dos diretórios pai necessários tenham sido criados.

databricks workspace mkdirs PATH [flags]

Arguments

PATH

    O caminho absoluto do diretório. Se os diretórios pai não existirem, ele também os criará. Se o diretório já existir, esse comando não fará nada e terá êxito.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

workspace do databricks get-permission-levels

Obter níveis de permissão do objeto do espaço de trabalho.

databricks workspace get-permission-levels WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

    O tipo de objeto do workspace para o qual obter ou gerenciar permissões.

WORKSPACE_OBJECT_ID

    O objeto de workspace para o qual obter ou gerenciar permissões.

Opções

Sinalizadores globais

workspace do databricks get-permissions

Obtenha as permissões de um objeto de ambiente de trabalho. Objetos de workspace podem herdar permissões de seus objetos pai ou objeto raiz.

databricks workspace get-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

    O tipo de objeto do workspace para o qual obter ou gerenciar permissões.

WORKSPACE_OBJECT_ID

    O objeto de workspace para o qual obter ou gerenciar permissões.

Opções

Sinalizadores globais

workspace do databricks set-permissions

Defina permissões de objeto no espaço de trabalho.

Define permissões em um objeto, substituindo as permissões existentes se elas existirem. Excluirá todas as permissões diretas se nenhuma for especificada. Os objetos podem herdar permissões de seus objetos pai ou objeto raiz.

databricks workspace set-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

    O tipo de objeto do workspace para o qual obter ou gerenciar permissões.

WORKSPACE_OBJECT_ID

    O objeto de workspace para o qual obter ou gerenciar permissões.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

atualização de permissões do workspace do Databricks

Atualize as permissões em um objeto de workspace. Objetos de workspace podem herdar permissões de seus objetos pai ou objeto raiz.

databricks workspace update-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

    O tipo de objeto do workspace para o qual obter ou gerenciar permissões.

WORKSPACE_OBJECT_ID

    O objeto de workspace para o qual obter ou gerenciar permissões.

Opções

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação.

Sinalizadores globais

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

    Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.

--log-file corda

    Uma cadeia de caracteres que representa o arquivo para o qual gravar logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desabilitado.

-o, --output tipo

    O tipo de saída de comando, text ou json. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo ~/.databrickscfg para usar ao executar o comando. Se esse sinalizador não for especificado, se existir, o perfil nomeado DEFAULT será usado.

--progress-format formato

    O formato para exibir logs de progresso: default, append, inplace ou json

-t, --target corda

    Se aplicável, o destino do pacote a ser usado