groupe de commandeswarehouses
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 warehouses au sein de la CLI Databricks vous permet de gérer les SQL warehouses. Un SQL Warehouse est une ressource de compute qui vous permet d'exécuter des commandes SQL sur des objets de données au sein de Databricks SQL. Voir Se connecter à un SQL warehouse.
databricks warehouses create
Créer un nouveau SQL Warehouse.
databricks warehouses create [flags]
Arguments
Aucun
Options
--auto-stop-mins int
Le nombre de minutes pendant lesquelles un SQL Warehouse doit être inactif (autrement dit, aucune query RUNNING) avant d'être automatiquement arrêté.
--cluster-size string
Taille des clusters alloués pour ce warehouse.
--creator-name string
Nom du créateur du warehouse.
--enable-photon
Configure si le warehouse doit utiliser des clusters optimisés par Photon.
--enable-serverless-compute
Configure si le warehouse doit utiliser le compute Serverless.
--instance-profile-arn string
Obsolète.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--max-num-clusters int
Nombre maximal de clusters que l'autoscaler créera pour gérer les requêtes concurrentes.
--min-num-clusters int
Nombre minimal de clusters disponibles qui seront maintenus pour ce SQL Warehouse.
--name string
Nom logique pour le cluster.
--no-wait
N'attendez pas d'atteindre l'état RUNNING
--spot-instance-policy SpotInstancePolicy
Configurations indiquant si le warehouse doit utiliser des instances spot. Valeurs prises en charge : COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED
--timeout duration
Durée maximale pour atteindre l'état RUNNING (default 20 ms)
--warehouse-type CreateWarehouseRequestWarehouseType
Type de warehouse : PRO ou CLASSIC. Valeurs prises en charge : CLASSIC, PRO, TYPE_UNSPECIFIED
Exemples
L'exemple suivant crée un nouveau SQL Warehouse avec une configuration de base :
databricks warehouses create --name "my-warehouse" --cluster-size "Small" --min-num-clusters 1 --max-num-clusters 10 --auto-stop-mins 60
L'exemple suivant crée un warehouse serverless avec Photon activé :
databricks warehouses create --name "serverless-warehouse" --enable-serverless-compute --enable-photon --warehouse-type PRO
databricks warehouses create-default-warehouse-override
Créer un remplacement de warehouse par défaut pour un utilisateur. Les utilisateurs peuvent créer leur propre remplacement. Les administrateurs peuvent créer des remplacements pour tout utilisateur.
databricks warehouses create-default-warehouse-override DEFAULT_WAREHOUSE_OVERRIDE_ID TYPE [flags]
Arguments
DEFAULT_WAREHOUSE_OVERRIDE_ID
L'ID du remplacement. Utilisez un ID utilisateur numérique ou la chaîne littérale me pour l'utilisateur actuel.
TYPE
Le type de comportement de remplacement. Valeurs prises en charge : CUSTOM, LAST_SELECTED.
Options
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du remplacement du warehouse par default.
--warehouse-id string
L’ID de warehouse spécifique lorsque le type est CUSTOM.
Exemples
L'exemple suivant crée un remplacement de warehouse personnalisé pour l'utilisateur actuel :
databricks warehouses create-default-warehouse-override me CUSTOM --warehouse-id 1234567890abcdef
databricks entrepôts supprimer
Supprimer un SQL Warehouse.
databricks warehouses delete ID [flags]
Arguments
ID
Obligatoire. ID du SQL Warehouse.
Options
Exemples
L'exemple suivant supprime un warehouse avec l'ID spécifié :
databricks warehouses delete 1234567890abcdef
databricks warehouses delete-default-warehouse-override
Supprimer le remplacement du warehouse par default pour un utilisateur. Les utilisateurs peuvent supprimer leur propre remplacement. Les administrateurs peuvent supprimer les remplacements pour n'importe quel utilisateur. Après la suppression, le warehouse default du Workspace est utilisé.
databricks warehouses delete-default-warehouse-override NAME [flags]
Arguments
NAME
Nom de la ressource du warehouse default à supprimer. Format : default-warehouse-overrides/{default_warehouse_override_id}. L'ID peut être un ID utilisateur numérique ou la chaîne de caractères littérale me pour l'utilisateur actuel.
Options
Exemples
L'exemple suivant supprime la dérogation du warehouse par default pour l'utilisateur actuel :
databricks warehouses delete-default-warehouse-override default-warehouse-overrides/me
Modifier les warehouse Databricks
Mettre à jour un warehouse. Met à jour la configuration d'un SQL Warehouse.
databricks warehouses edit ID [flags]
Arguments
ID
Obligatoire. ID du warehouse à configurer.
Options
--auto-stop-mins int
Le nombre de minutes pendant lesquelles un SQL Warehouse doit être inactif (autrement dit, aucune query RUNNING) avant d'être automatiquement arrêté.
--cluster-size string
Taille des clusters alloués pour ce warehouse.
--creator-name string
Nom du créateur du warehouse.
--enable-photon
Configure si le warehouse doit utiliser des clusters optimisés par Photon.
--enable-serverless-compute
Configure si le warehouse doit utiliser le compute Serverless.
--instance-profile-arn string
Obsolète.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--max-num-clusters int
Nombre maximal de clusters que l'autoscaler créera pour gérer les requêtes concurrentes.
--min-num-clusters int
Nombre minimal de clusters disponibles qui seront maintenus pour ce SQL Warehouse.
--name string
Nom logique pour le cluster.
--no-wait
N'attendez pas d'atteindre l'état RUNNING
--spot-instance-policy SpotInstancePolicy
Configurations indiquant si le warehouse doit utiliser des instances spot. Valeurs prises en charge : COST_OPTIMIZED, POLICY_UNSPECIFIED, RELIABILITY_OPTIMIZED
--timeout duration
Durée maximale pour atteindre l'état RUNNING (default 20 ms)
--warehouse-type EditWarehouseRequestWarehouseType
Type de warehouse. Valeurs prises en charge : CLASSIC, PRO, TYPE_UNSPECIFIED
Exemples
L'exemple suivant met à jour un warehouse pour modifier la taille de son cluster et le délai d'arrêt automatique :
databricks warehouses edit 1234567890abcdef --cluster-size "Medium" --auto-stop-mins 30
L'exemple suivant active Photon pour un warehouse existant :
databricks warehouses edit 1234567890abcdef --enable-photon
databricks warehouse get
Obtenez les informations pour un seul SQL warehouse.
databricks warehouses get ID [flags]
Arguments
ID
Obligatoire. ID du SQL Warehouse.
Options
Exemples
L'exemple suivant obtient des informations sur un warehouse avec l'ID spécifié :
databricks warehouses get 1234567890abcdef
Remplacement du warehouse par default de Databricks
Obtenir le remplacement du warehouse par défaut pour un utilisateur. Les utilisateurs peuvent récupérer leur propre remplacement. Les administrateurs peuvent récupérer les remplacements pour tout utilisateur. Si aucun remplacement n'existe, le warehouse default du Workspace est utilisé.
databricks warehouses get-default-warehouse-override NAME [flags]
Arguments
NAME
Le nom de la ressource du remplacement du warehouse default à récupérer. Format : default-warehouse-overrides/{default_warehouse_override_id}. L'ID peut être un ID utilisateur numérique ou la chaîne de caractères littérale me pour l'utilisateur actuel.
Options
Exemples
L'exemple suivant obtient le remplacement du warehouse par default pour l'utilisateur actuel :
databricks warehouses get-default-warehouse-override default-warehouse-overrides/me
databricks warehouses get-workspace-warehouse-config
Obtenez la configuration au niveau du Workspace qui est partagée par tous les SQL Warehouses d'un Workspace.
databricks warehouses get-workspace-warehouse-config [flags]
Arguments
Aucun
Options
Exemples
L'exemple suivant obtient la configuration du warehouse du Workspace :
databricks warehouses get-workspace-warehouse-config
liste des warehouses Databricks
Lister tous les SQL Warehouse pour lesquels un utilisateur dispose de permissions de gestion.
databricks warehouses list [flags]
Arguments
Aucun
Options
--run-as-user-id int
Service Principal qui sera utilisé pour récupérer la liste des warehouse.
Exemples
L'exemple suivant répertorie tous les warehouses :
databricks warehouses list
L'exemple suivant répertorie les warehouses utilisant un Service Principal spécifique :
databricks warehouses list --run-as-user-id 123456789
databricks warehouses list-default-warehouse-overrides
Répertorier tous les remplacements de warehouse par default dans le workspace. Seuls les administrateurs du workspace peuvent répertorier toutes les substitutions.
databricks warehouses list-default-warehouse-overrides [flags]
Options
--page-size int
Le nombre maximum de remplacements à renvoyer.
--page-token string
Un jeton de page reçu d'un appel list-default-warehouse-overrides précédent.
Exemples
L’exemple suivant répertorie tous les remplacements de warehouse par default :
databricks warehouses list-default-warehouse-overrides
databricks warehouses set-workspace-warehouse-config
Définissez la configuration au niveau de l'Workspace qui est partagée par tous les SQL Warehouse d'un Workspace.
databricks warehouses set-workspace-warehouse-config [flags]
Arguments
Aucun
Options
--google-service-account string
GCP uniquement : Compte de service Google utilisé pour transmettre au cluster afin d'accéder à Google Cloud Storage.
--instance-profile-arn string
AWS uniquement : profil d'instance utilisé pour transmettre le rôle IAM au cluster.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--security-policy SetWorkspaceWarehouseConfigRequestSecurityPolicy
Politique de sécurité pour les warehouse. Valeurs prises en charge : DATA_ACCESS_CONTROL, NONE, PASSTHROUGH
Exemples
L'exemple suivant définit la configuration du warehouse du Workspace avec une politique de sécurité :
databricks warehouses set-workspace-warehouse-config --security-policy DATA_ACCESS_CONTROL
start databricks warehouse
start un SQL Warehouse.
databricks warehouses start ID [flags]
Arguments
ID
Obligatoire. ID du SQL Warehouse.
Options
--no-wait
N'attendez pas d'atteindre l'état RUNNING
--timeout duration
Durée maximale pour atteindre l'état RUNNING (default 20 ms)
Exemples
L'exemple suivant start un warehouse avec l'ID spécifié :
databricks warehouses start 1234567890abcdef
L'exemple suivant start un warehouse sans attendre qu'il atteigne l'état RUNNING :
databricks warehouses start 1234567890abcdef --no-wait
Arrêt des warehouse Databricks
Arrêter un SQL Warehouse.
databricks warehouses stop ID [flags]
Arguments
ID
Obligatoire. ID du SQL Warehouse.
Options
--no-wait
N'attendez pas d'atteindre l'état STOPPED
--timeout duration
Durée maximale pour atteindre l'état STOPPED (default 20 ms)
Exemples
L'exemple suivant arrête un warehouse avec l'ID spécifié :
databricks warehouses stop 1234567890abcdef
L'exemple suivant arrête un warehouse sans attendre qu'il atteigne l'état STOPPED :
databricks warehouses stop 1234567890abcdef --no-wait
databricks warehouses update-default-warehouse-override
Mettre à jour un remplacement de default warehouse existant pour un utilisateur. Les utilisateurs peuvent mettre à jour leur propre remplacement. Les administrateurs peuvent mettre à jour les remplacements pour tout utilisateur.
databricks warehouses update-default-warehouse-override NAME UPDATE_MASK TYPE [flags]
Arguments
NAME
Le nom de la Ressource de la substitution du warehouse par default. Format : default-warehouse-overrides/{default_warehouse_override_id}.
UPDATE_MASK
Masque de champ spécifiant les champs à mettre à jour. Utilisez * pour mettre à jour tous les champs. Lorsque --allow-missing est défini, ce champ est ignoré et tous les champs sont appliqués.
TYPE
Le type de comportement de remplacement. Valeurs prises en charge : CUSTOM, LAST_SELECTED.
Options
--allow-missing
S’il est défini et que le remplacement n’est pas trouvé, créez un nouveau remplacement à la place.
--json JSON
La chaîne JSON en ligne ou le @chemin vers le fichier JSON avec le corps de la requête.
--name string
Le nom de la ressource du remplacement du warehouse par default.
--warehouse-id string
L’ID de warehouse spécifique lorsque le type est CUSTOM.
Exemples
L’exemple suivant met à jour le remplacement de l’utilisateur actuel pour un warehouse spécifique :
databricks warehouses update-default-warehouse-override default-warehouse-overrides/me warehouse_id CUSTOM --warehouse-id 1234567890abcdef
databricks warehouses get-permission-levels
Obtenir les niveaux d'autorisation du SQL Warehouse.
databricks warehouses get-permission-levels WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
Le SQL Warehouse pour lequel obtenir ou gérer les autorisations.
Options
Exemples
L'exemple suivant obtient les niveaux d'autorisation pour un warehouse :
databricks warehouses get-permission-levels 1234567890abcdef
databricks warehouses get-permissions
Obtenez les permissions d'un SQL Warehouse. Les SQL Warehouse peuvent hériter des permissions de leur objet racine.
databricks warehouses get-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
Le SQL Warehouse pour lequel obtenir ou gérer les autorisations.
Options
Exemples
L'exemple suivant obtient les permissions pour un warehouse :
databricks warehouses get-permissions 1234567890abcdef
databricks warehouses set-permissions
Définissez les autorisations du SQL Warehouse. 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 leur objet racine.
databricks warehouses set-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
Le SQL Warehouse 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.
Exemples
L'exemple suivant définit les autorisations pour un warehouse à l'aide d'un fichier JSON :
databricks warehouses set-permissions 1234567890abcdef --json @permissions.json
databricks warehouses update-permissions
Mettez à jour les autorisations sur un SQL Warehouse. Les SQL Warehouse peuvent hériter des permissions de leur objet racine.
databricks warehouses update-permissions WAREHOUSE_ID [flags]
Arguments
WAREHOUSE_ID
Le SQL Warehouse 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.
Exemples
L'exemple suivant met à jour les autorisations d'un warehouse à l'aide d'un fichier JSON :
databricks warehouses update-permissions 1234567890abcdef --json @permissions.json
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