Share via

CLI do Repos (herdada)

  • Artigo

Importante

Esta documentação foi desativada e pode não estar atualizada.

Essas informações se aplicam às versões herdadas da CLI do Databricks 0.18 e anteriores. O Databricks recomenda que você use a versão 0.205 da CLI do Databricks mais recente ou superior. Consulte O que é a CLI do Databricks?. Para localizar sua versão da CLI do Databricks, execute databricks -v.

Para migrar da CLI do Databricks versão 0.18 ou inferior para a CLI do Databricks versão 0.205 ou superior, consulte migração da CLI do Databricks.

Observação

A CLI de repositórios exige a CLI 0.15.0 ou superior do Databricks.

Execute os subcomandos da CLI de repositórios do Databricks acrescentando-os ao databricks repos. Esses subcomandos chamam a API do Repos.

Para saber mais sobre os repositórios, confira Integração do Git às pastas Git do Databricks.

databricks repos --help

Usage: databricks repos [OPTIONS] COMMAND [ARGS]...

  Utility to interact with the repos API.

Options:
  -v, --version   [VERSION]
  --debug         Debug mode. Shows full stack trace on error.
  --profile TEXT  CLI connection profile to use. The default profile is
                  "DEFAULT".

  -h, --help      Show this message and exit.

Commands:
  create      Creates a repo.
  delete      Deletes a repo.
  get         Lists information about a repo.
  list        Lists all available repos in the workspace.
  update      Updates information about a repo.

Criar um repositório

Para ver a documentação de uso, execute databricks repos create --help.

Uso

databricks repos create --url <url> --provider <provider> --path <path>

Substitua:

  • <url> pela URL do provedor Git necessária para o repositório.

  • <provider> pelo nome do provedor Git necessário, por exemplo, gitHub. Os provedores disponíveis incluem:

    • azureDevOpsServices
    • bitbucketCloud
    • bitbucketServer
    • gitHub
    • gitHubEnterprise
    • gitLab
    • gitLabEnterpriseEdition

    O nome do provedor pode ser especificado como não diferenciando maiúsculas de minúsculas (por exemplo, gitHub e github ambos são válidos).

  • <path> por um caminho opcional para o repositório no workspace do Azure Databricks, por exemplo, /Repos/someone@example.com/my-repo.

Saída de exemplo

{
  "id": 1234567890123456,
  "path": "/Repos/someone@example.com/my-repo",
  "url": "https://github.com/my/my-repo",
  "provider": "gitHub",
  "branch": "master",
  "head_commit_id": "9837ac1f924a5ca56117597c5c79bb02300ff1f4"
}

Listar todos os repositórios disponíveis no workspace

Para ver a documentação de uso, execute databricks repos list --help.

Uso

databricks repos list --path-prefix <path-prefix> --next-page-token <next-page-token>

Substitua:

  • <path-prefix> por um prefixo de caminho opcional para os repositórios no workspace do Azure Databricks, por exemplo, /Repos/someone@example.com/my-repo.
  • <next-page-token> por um token de próxima página opcional fornecido através da execução do comando anteriormente, a fim de obter a próxima página de resultados.

Saída de exemplo

{
  "repos": [
    {
      "id": 1234567890123456,
      "path": "/Repos/someone@example.com/my-repo",
      "url": "https://github.com/my/my-repo",
      "provider": "gitHub",
      "branch": "master",
      "head_commit_id": "9837ac1f924a5ca56117597c5c79bb02300ff1f4"
    },
    {
      "id": 2345678901234567,
      "path": "/Repos/someone@example.com/my-repo-2",
      "url": "https://github.com/my/my-repo-2",
      "provider": "gitHub",
      "branch": "master",
      "head_commit_id": "837ac1f924a5ca56117597c5c79bb02300ff1f4a"
    }
  ]
}

Listar informações sobre um repositório

Para ver a documentação de uso, execute databricks repos get --help.

Uso

databricks repos get --repo-id <repo-id> --path <path>

Substitua:

  • <repo-id> com a ID do repositório, por exemplo, 1234567890123456. Para obter a ID, execute o comando list. --repo-id ou --path é obrigatório.
  • <path> pelo caminho para o repositório no workspace do Azure Databricks, por exemplo, /Repos/someone@example.com/my-repo. Para obter o caminho, execute o comando get ou list. --repo-id ou --path é obrigatório.

Saída de exemplo

{
  "id": 1234567890123456,
  "path": "/Repos/someone@example.com/my-repo",
  "url": "https://github.com/my/my-repo",
  "provider": "gitHub",
  "branch": "master",
  "head_commit_id": "9837ac1f924a5ca56117597c5c79bb02300ff1f4"
}

Atualizar um repositório para a commit mais recente de um branch remoto ou para uma tag

Para ver a documentação de uso, execute databricks repos update --help.

Uso

databricks repos update --repo-id <repo-id> --branch <branch>

Ou:

databricks repos update --repo-id <repo-id> --tag <tag>

Ou:

databricks repos update --path <path> --branch <branch>

Ou:

databricks repos update --path <path> --tag <tag>

Exatamente um de --repo-id ou --path é necessário, e exatamente um de --branch ou --tag é necessário.

--repo-id ou --path identifica a pasta Git do Databricks que deve ser atualizada. --branch ou --tag identifica o commit para atualização ou o novo branch para check-out. Se --branch ou --tag se referir ao branch cujo check-out está sendo feito, as pastas Git do Databricks executarão uma operação de pull para atualizar para commit mais recente para esse branch. Se --branch ou --tag se referir a um branch CUJO check-out não está sendo feito, as pastas Git do Databricks farão check-out do branch especificado.

Substitua:

  • <repo-id> com a ID do repositório, por exemplo, 1234567890123456. Para obter a ID, execute o comando list.
  • <path> pelo caminho para o repositório no workspace do Azure Databricks, por exemplo, /Repos/someone@example.com/my-repo. Para obter o caminho, execute o comando get ou list.
  • <branch> pelo nome do branch no repositório a ser usado, por exemplo, my-branch.
  • <tag> pelo nome do branch no repositório a ser usado, por exemplo, my-tag.

Saída de exemplo

{
  "id": 1234567890123456,
  "path": "/Repos/someone@example.com/my-repo",
  "url": "https://github.com/my/my-repo",
  "provider": "gitHub",
  "branch": "my-branch",
  "head_commit_id": "9837ac1f924a5ca56117597c5c79bb02300ff1f4"
}

Excluir um repositório

Para ver a documentação de uso, execute databricks repos delete --help.

Uso

databricks repos delete --repo-id <repo-id>

Ou:

databricks repos delete --path <path>

Substitua:

  • <repo-id> com a ID do repositório, por exemplo, 1234567890123456. Para obter a ID, execute o comando list. --repo-id ou --path é obrigatório.
  • <path> pelo caminho para o repositório no workspace do Azure Databricks, por exemplo, /Repos/someone@example.com/my-repo. Para obter o caminho, execute o comando get ou list. --repo-id ou --path é obrigatório.

Se obtiver sucesso, nenhuma saída será exibida.