Repos CLI (レガシ)

  • [アーティクル]

重要

このドキュメントは廃止され、更新されない可能性があります。

この情報は、レガシ Databricks CLI バージョン 0.18 以前に適用されます。 Databricks では、代わりにバージョン 0.205 以降の新しい Databricks CLI を使うことをお勧めします。 「Databricks CLI について」を参照してください。 お使いの Databricks CLI のバージョンを確認するには、databricks -v を実行してください。

Databricks CLI バージョン 0.18 以前から Databricks CLI バージョン 0.205 以降に移行する場合は、「Databricks CLI の移行」を参照してください。

Note

Repos CLI には、Databricks CLI 0.15.0 以上が必要です。

Databricks repos CLI サブコマンドを実行するには、それらを databricks repos に追加します。 これらのサブコマンドは 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 など) に置き換えます。 パスを取得するには、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 など) に置き換えます。 パスを取得するには、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 など) に置き換えます。 パスを取得するには、get または list コマンドを実行します。 --repo-id または --path が必須です。

成功した場合、出力は表示されません。