Aller au contenu principal

Repos CLI (hérité)

important

Cette documentation a été retirée et pourrait ne pas être mise à jour.

Ces informations s'appliquent aux anciennes versions de la CLI Databricks 0.18 et antérieures. Databricks vous recommande d'utiliser plutôt la version 0.205 ou ultérieure de Databricks CLI. Voir CLI Databricks. Pour trouver votre version de la CLI Databricks, exécutez databricks -v.

Pour migrer de Databricks CLI version 0.18 ou inférieure vers Databricks CLI version 0.205 ou supérieure, consultez la migration de Databricks CLI.

remarque

Le CLI Repos nécessite Databricks CLI 0.15.0 ou une version supérieure.

Vous exécutez les sous-commandes de l'interface CLI des repos Databricks en les ajoutant à databricks repos. Ces sous-commandes appellent l'API Repos.

Pour plus d'informations sur les référentiels Git, consultez les dossiers Git de Databricks.

Bash
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.

Créer un référentiel

Pour afficher la documentation d'utilisation, exécutez databricks repos create --help.

Utilisation

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

Remplacer :

  • <url> avec l'URL du fournisseur Git requis vers le repo.

  • <provider> avec le nom du fournisseur Git requis, par exemple gitHub. Les fournisseurs disponibles sont les suivants :

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

    Le nom du fournisseur peut être spécifié comme insensible à la casse (par exemple, gitHub et github sont tous deux valides).

  • <path> avec un chemin d'accès facultatif au référentiel dans le Workspace Databricks, par exemple /Repos/someone@example.com/my-repo.

Exemple de sortie

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

Lister tous les dépôts disponibles dans le Workspace

Pour afficher la documentation d'utilisation, exécutez databricks repos list --help.

Utilisation

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

Remplacer :

  • <path-prefix> avec un préfixe de chemin d'accès facultatif vers les repos dans le workspace Databricks, par exemple /Repos/someone@example.com/my-repo.
  • <next-page-token> avec un jeton de page suivante facultatif fourni en exécutant la commande précédemment, pour obtenir la page de résultats suivante.

Exemple de sortie

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

Lister les informations sur un référentiel

Pour afficher la documentation d'utilisation, exécutez databricks repos get --help.

Utilisation

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

Remplacer :

  • <repo-id> avec l'ID du référentiel, par exemple 1234567890123456. Pour obtenir l'ID, exécutez la commande list. --repo-id ou --path est requis.
  • <path> avec le chemin d'accès au repo dans le Workspace Databricks, par exemple /Repos/someone@example.com/my-repo. Pour obtenir le chemin, exécutez la commande get ou list. --repo-id ou --path est requis.

Exemple de sortie

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

Mettre à jour un dépôt vers le commit le plus récent d'une branch distante ou vers un tag

Pour afficher la documentation d'utilisation, exécutez databricks repos update --help.

Utilisation

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

Ou :

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

Ou :

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

Ou :

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

Exactement l'un de --repo-id ou --path est requis, et exactement l'un de --branch ou --tag est requis.

--repo-id ou --path identifie le dossier Git Databricks qui doit être mis à jour. --branch ou --tag identifie le commit à mettre à jour ou la nouvelle branch à extraire. Si --branch ou --tag fait référence à la branch actuellement extraite, les dossiers Git Databricks effectuent une opération de tirage (pull) pour se mettre à jour avec le dernier commit de cette branch. Si --branch ou --tag fait référence à une branch qui n'est pas actuellement extraite, les dossiers Git Databricks extraient la branch spécifiée.

Remplacer :

  • <repo-id> avec l'ID du référentiel, par exemple 1234567890123456. Pour obtenir l'ID, exécutez la commande list.
  • <path> avec le chemin d'accès au repo dans le Workspace Databricks, par exemple /Repos/someone@example.com/my-repo. Pour obtenir le chemin, exécutez la commande get ou list.
  • <branch> avec le nom de la Branch dans le dépôt à utiliser, par exemple my-branch.
  • <tag> avec le nom de la Branch dans le dépôt à utiliser, par exemple my-tag.

Exemple de sortie

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

Supprimer un repository

Pour afficher la documentation d'utilisation, exécutez databricks repos delete --help.

Utilisation

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

Ou :

Bash
databricks repos delete --path <path>

Remplacer :

  • <repo-id> avec l'ID du référentiel, par exemple 1234567890123456. Pour obtenir l'ID, exécutez la commande list. --repo-id ou --path est requis.
  • <path> avec le chemin d'accès au repo dans le Workspace Databricks, par exemple /Repos/someone@example.com/my-repo. Pour obtenir le chemin, exécutez la commande get ou list. --repo-id ou --path est requis.

En cas de succès, aucune sortie n'est affichée.