Repos CLI（旧）

  • 项目

重要

本文档已过时，将来可能不会更新。

此信息适用于旧版 Databricks CLI 0.18 及更低版本。 Databricks 建议改用较新的 Databricks CLI 0.205 或更高版本。 请参阅什么是 Databricks CLI？。 若要查找你的 Databricks CLI 的版本，请运行 databricks -v。

要从 Databricks CLI 版本 0.18 或更低版本迁移到 Databricks CLI 版本 0.205 或更高版本，请参阅 Databricks CLI 迁移。

注意

Repos CLI 需要 Databricks CLI 0.15.0 或更高版本。

可将 Databricks Repos CLI 子命令追加到 databricks repos 后面来运行这些子命令。 这些子命令调用存储库 API。

有关存储库的详细信息，请参阅 Git 与 Databricks Git 文件夹的集成。

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.

创建存储库

若要显示使用情况文档，请运行 databricks repos create --help。

使用情况

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

将：

  • <url> 替换为所需的 Git 提供程序存储库的 URL。

  • <provider> 替换为所需的 Git 提供程序的名称，如 gitHub。 可用的提供程序包括：

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

    例如，提供程序的名称可以指定为不区分大小写（例如，gitHub 和 github 都有效）。

  • <path> 替换为 Azure Databricks 工作区中存储库的可选路径，如 /Repos/someone@example.com/my-repo。

示例输出

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

列出工作区中所有可用的存储库

若要显示使用情况文档，请运行 databricks repos list --help。

使用情况

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

将：

  • <path-prefix> 替换为 Azure Databricks 工作区中存储库的可选路径前缀，如 /Repos/someone@example.com/my-repo。
  • <next-page-token> 替换为之前运行命令时提供的可选下一页令牌，以获取下一页结果。

示例输出

{
  "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"
    }
  ]
}

列出存储库的相关信息

若要显示使用情况文档，请运行 databricks repos get --help。

使用情况

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

将：

  • <repo-id> 替换为存储库的 ID，如 1234567890123456。 要获取此 ID，请运行 list 命令。 需要 --repo-id 或 --path。
  • <path> 替换为 Azure Databricks 工作区中存储库的路径，如 /Repos/someone@example.com/my-repo。 要获取此 ID，请运行 get 或 list 命令。 需要 --repo-id 或 --path。

示例输出

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

将存储库更新到某个远程分支的最新提交或更新到某个标记

若要显示使用情况文档，请运行 databricks repos update --help。

使用情况

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

或：

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

或：

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

或：

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

正好需要 --repo-id 或 --path 中的一个，并且正好需要 --branch 或 --tag 中的一个。

--repo-id 或 --path 标识应更新的 Databricks Git 文件夹。 --branch 或 --tag 标识要更新到的提交或要签出的新分支。如果 --branch 或 --tag 引用当前已签出的分支，Databricks Git 文件夹将执行拉取操作以更新到该分支的最新提交。 如果 --branch 或 --tag 引用当前未签出的分支，Databricks Git 文件夹将签出指定的分支。

将：

  • <repo-id> 替换为存储库的 ID，如 1234567890123456。 要获取此 ID，请运行 list 命令。
  • <path> 替换为 Azure Databricks 工作区中存储库的路径，如 /Repos/someone@example.com/my-repo。 要获取此 ID，请运行 get 或 list 命令。
  • <branch> 替换为要使用的存储库中分支的名称，如 my-branch。
  • <tag> 替换为要使用的存储库中分支的名称，如 my-tag。

示例输出

{
  "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"
}

删除存储库

若要显示使用情况文档，请运行 databricks repos delete --help。

使用情况

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

或：

databricks repos delete --path <path>

将：

  • <repo-id> 替换为存储库的 ID，如 1234567890123456。 要获取此 ID，请运行 list 命令。 需要 --repo-id 或 --path。
  • <path> 替换为 Azure Databricks 工作区中存储库的路径，如 /Repos/someone@example.com/my-repo。 要获取此 ID，请运行 get 或 list 命令。 需要 --repo-id 或 --path。

如果成功，则不显示任何输出。