Aller au contenu principal

groupe de commandesworkspace

remarque

L'utilisation de Databricks CLI est soumise à la licence Databricks et à la politique de confidentialité Databricks, y compris toutes les dispositions relatives aux données d'utilisation.

Le groupe de commandes workspace au sein de la CLI Databricks vous permet de lister, d'importer, d'exporter et de supprimer des fichiers et des dossiers de workspace. Voir Que sont les fichiers de workspace ?.

supprimer le Workspace Databricks

Supprimer un objet de Workspace.

Supprime un objet ou un répertoire (et supprime éventuellement de manière récursive tous les objets du répertoire). Si le chemin n'existe pas, cet appel retourne une erreur RESOURCE_DOES_NOT_EXIST. Si le chemin est un répertoire non vide et que récursif est défini sur false, cet appel retourne une erreur DIRECTORY_NOT_EMPTY.

La suppression d'objets est irréversible et la suppression récursive d'un répertoire n'est pas atomique.

databricks workspace delete PATH [flags]

Arguments

PATH

Le chemin d'accès absolu du notebook ou du répertoire.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--recursive

L'indicateur qui indique s'il faut supprimer l'objet de manière récursive.

Indicateurs globaux

exportation du Workspace Databricks

Exportez un objet Workspace ou le contenu d'un répertoire entier.

Si le chemin n'existe pas, cet appel renvoie une erreur RESOURCE_DOES_NOT_EXIST.

Si les données exportées dépassent la limite de taille, cet appel renvoie MAX_NOTEBOOK_SIZE_EXCEEDED. Actuellement, cette API ne prend pas en charge l'exportation d'une bibliothèque.

databricks workspace export SOURCE_PATH [flags]

Arguments

PATH

Le chemin d'accès absolu de l'objet ou du répertoire. L'exportation d'un répertoire n'est prise en charge que pour les formats DBC, SOURCE et AUTO.

Options

--file string

Chemin sur le système de fichiers local pour enregistrer le fichier exporté.

--format ExportFormat

Ceci spécifie le format du fichier exporté. Valeurs prises en charge : AUTO, DBC, HTML, JUPYTER, RAW, R_MARKDOWN, SOURCE

Indicateurs globaux

databricks workspace export-dir

Exportez un répertoire de manière récursive depuis un Workspace Databricks vers le système de fichiers local.

databricks workspace export-dir SOURCE_PATH TARGET_PATH [flags]

Arguments

SOURCE_PATH

Le chemin du répertoire source dans le Workspace.

TARGET_PATH

Chemin du répertoire cible sur le système de fichiers local.

Options

--overwrite

écraser les fichiers locaux existants

Indicateurs globaux

databricks workspace get-status

Obtenir le statut d'un objet ou d'un répertoire. Si le chemin n’existe pas, cet appel retourne une erreur RESOURCE_DOES_NOT_EXIST.

databricks workspace get-status PATH [flags]

Arguments

PATH

Le chemin d'accès absolu du notebook ou du répertoire.

Options

Indicateurs globaux

databricks workspace import

Importe un objet de workspace (par exemple, un notebook ou un fichier) ou le contenu d'un répertoire entier. Si le chemin existe déjà et que l'écrasement est défini sur false, cet appel renvoie une erreur RESOURCE_ALREADY_EXISTS. Pour importer un répertoire, vous pouvez utiliser soit le format DBC soit le format SOURCE avec le champ de langue non défini. Pour importer un fichier unique en tant que SOURCE, vous devez définir le champ de langue. Les fichiers Zip dans les répertoires ne sont pas pris en charge.

databricks workspace import TARGET_PATH [flags]

Arguments

PATH

Le chemin d'accès absolu de l'objet ou du répertoire. L'importation d'un répertoire n'est prise en charge que pour les formats DBC et SOURCE.

Options

--content string

Le contenu encodé en base64.

--file string

Chemin d'accès du fichier local à importer.

--format ImportFormat

Ceci spécifie le format du fichier à importer. Valeurs prises en charge : AUTO, DBC, HTML, JUPYTER, RAW, R_MARKDOWN, SOURCE

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

--language Language

La langue de l'objet. Valeurs prises en charge : PYTHON, R, SCALA, SQL

--overwrite

L'indicateur qui spécifie s'il faut écraser l'objet existant.

Indicateurs globaux

databricks workspace import-dir

Importez un répertoire de manière récursive depuis le système de fichiers local vers un Workspace Databricks.

Les Notebooks verront leurs extensions supprimées.

databricks workspace import-dir SOURCE_PATH TARGET_PATH [flags]

Arguments

SOURCE_PATH

Le chemin du répertoire source sur le système de fichiers local

TARGET_PATH

Le chemin du répertoire cible dans le Workspace

Options

--overwrite

écraser les fichiers Workspace existants

Indicateurs globaux

Liste des Databricks Workspace

Répertorier le contenu d'un répertoire, ou l'objet si ce n'est pas un répertoire. Si le chemin d'entrée n'existe pas, cet appel retourne une erreur RESOURCE_DOES_NOT_EXIST.

databricks workspace list PATH [flags]

Arguments

PATH

Le chemin d'accès absolu du notebook ou du répertoire.

Options

--notebooks-modified-after int

Timestamp UTC en millisecondes.

Indicateurs globaux

databricks workspace mkdirs

Créez le répertoire spécifié (et les répertoires parents nécessaires s'ils n'existent pas). S'il existe un objet (pas un répertoire) à n'importe quel préfixe du chemin d'entrée, cet appel renvoie une erreur RESOURCE_ALREADY_EXISTS.

Notez que si cette opération échoue, elle a peut-être réussi à créer certains des répertoires parents nécessaires.

databricks workspace mkdirs PATH [flags]

Arguments

PATH

Le chemin absolu du répertoire. Si les répertoires parents n'existent pas, il les créera également. Si le répertoire existe déjà, cette commande ne fera rien et réussira.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks workspace get-permission-levels

Obtenir les niveaux d'autorisation des objets du Workspace.

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

Arguments

WORKSPACE_OBJECT_TYPE

Le type d'objet du Workspace pour lequel obtenir ou gérer les autorisations.

WORKSPACE_OBJECT_ID

L'objet workspace pour lequel obtenir ou gérer les autorisations.

Options

Indicateurs globaux

databricks workspace get-permissions

Obtenir les autorisations d'un objet de Workspace. Les objets Workspace peuvent hériter des permissions de leurs objets parents ou de l'objet racine.

databricks workspace get-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

Le type d'objet du Workspace pour lequel obtenir ou gérer les autorisations.

WORKSPACE_OBJECT_ID

L'objet workspace pour lequel obtenir ou gérer les autorisations.

Options

Indicateurs globaux

databricks workspace set-permissions

Définir les permissions des objets du Workspace.

Définit les autorisations sur un objet, en remplaçant les autorisations existantes si elles existent. Supprime toutes les autorisations directes si aucune n'est spécifiée. Les objets peuvent hériter des autorisations de leurs objets parents ou de l'objet racine.

databricks workspace set-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

Le type d'objet du Workspace pour lequel obtenir ou gérer les autorisations.

WORKSPACE_OBJECT_ID

L'objet workspace pour lequel obtenir ou gérer les autorisations.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

databricks workspace update-permissions

Mettre à jour les autorisations sur un objet du Workspace. Les objets Workspace peuvent hériter des permissions de leurs objets parents ou de l'objet racine.

databricks workspace update-permissions WORKSPACE_OBJECT_TYPE WORKSPACE_OBJECT_ID [flags]

Arguments

WORKSPACE_OBJECT_TYPE

Le type d'objet du Workspace pour lequel obtenir ou gérer les autorisations.

WORKSPACE_OBJECT_ID

L'objet workspace pour lequel obtenir ou gérer les autorisations.

Options

--json JSON

La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.

Indicateurs globaux

Drapeaux globaux

--debug

Activer ou non la journalisation de débogage.

-h OU --help

Afficher l'aide de Databricks CLI ou du groupe de commandes associé ou de la commande associée.

--log-file chaîne

Une chaîne représentant le fichier dans lequel écrire les logs de sortie. Si cet indicateur n'est pas spécifié, la default est d'écrire les logs de sortie dans stderr.

--log-format Format

Le type de format de log, text ou json. La valeur par default est text.

--log-level chaîne

Une chaîne représentant le niveau de format du log. S'il n'est pas spécifié, le niveau de format du log est désactivé.

-o, --output Type

Le type de sortie de commande, text ou json. La valeur par default est text.

-p, --profile chaîne

Nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n'est pas spécifié, alors s'il existe, le profil nommé DEFAULT est utilisé.

--progress-format Format

Le format pour afficher les logs de progression : default, append, inplace ou json

-t, --target chaîne

Le cas échéant, la cible de bundle à utiliser