Aller au contenu principal

groupe de commandesexternal-locations

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 external-locations au sein de la CLI Databricks contient des commandes pour créer et gérer des emplacements externes pour Unity Catalog. Voir Qu'est-ce que les volumes Unity Catalog ?.

databricks external-locations create

Créer une nouvelle entrée d'emplacement externe dans le metastore. L’appelant doit être un administrateur du metastore ou disposer du privilège CREATE_EXTERNAL_LOCATION sur le metastore et les informations d’identification de stockage associées.

databricks external-locations create NAME URL CREDENTIAL_NAME [flags]

Arguments

NAME

Nom de l'emplacement externe.

URL

URL du chemin d'accès de l'emplacement externe.

CREDENTIAL_NAME

Nom de l'identifiant de stockage utilisé avec cet emplacement.

Options

--comment string

Description textuelle libre fournie par l'utilisateur.

--enable-file-events

Indique si les événements de fichier doivent être activés sur cet emplacement externe.

--fallback

Indique si le mode fallback est activé pour cet emplacement externe.

--json JSON

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

--read-only

Indique si l'emplacement externe est en lecture seule.

--skip-validation

Ignore la validation de l'identifiant de stockage associé à l'emplacement externe.

Indicateurs globaux

Exemples

L'exemple suivant crée un emplacement externe avec un commentaire :

Bash
databricks external-locations create my-external-location s3://my-bucket/path my-credential --comment "External location for data lake"

L'exemple suivant crée un emplacement externe en lecture seule :

Bash
databricks external-locations create my-external-location s3://my-bucket/path my-credential --read-only

databricks external-locations supprimer

Supprimez l'emplacement externe spécifié du métastore. L'appelant doit être le propriétaire de l'emplacement externe.

databricks external-locations delete NAME [flags]

Arguments

NAME

Nom de l'emplacement externe.

Options

--force

Forcer la suppression même s'il existe des tables externes ou des montages dépendants.

Indicateurs globaux

Exemples

L'exemple suivant supprime un emplacement externe nommé my-external-location:

Bash
databricks external-locations delete my-external-location

L'exemple suivant supprime de force un emplacement externe, même s'il existe des dépendances :

Bash
databricks external-locations delete my-external-location --force

databricks external-locations get

Obtenir un emplacement externe du métastore. L’appelant doit être un administrateur du métastore, le propriétaire de l’emplacement externe ou un utilisateur disposant d’un privilège sur l’emplacement externe.

databricks external-locations get NAME [flags]

Arguments

NAME

Nom de l'emplacement externe.

Options

--include-browse

S'il faut inclure des emplacements externes dans la réponse pour lesquels le principal peut uniquement accéder à des métadonnées sélectives.

Indicateurs globaux

Exemples

L’exemple suivant obtient des informations sur un emplacement externe nommé my-external-location:

Bash
databricks external-locations get my-external-location

L'exemple suivant obtient des informations, y compris les métadonnées de navigation :

Bash
databricks external-locations get my-external-location --include-browse

databricks liste des emplacements externes

Lister les emplacements externes du metastore. L'appelant doit être un administrateur du métastore, le propriétaire de l'emplacement externe, ou un utilisateur qui dispose de certains privilèges sur l'emplacement externe. L’ordre des éléments dans le tableau n’est pas garanti.

databricks external-locations list [flags]

Options

--include-browse

S'il faut inclure des emplacements externes dans la réponse pour lesquels le principal peut uniquement accéder à des métadonnées sélectives.

--include-unbound

S'il faut inclure les emplacements externes non liés au workspace.

--max-results int

Nombre maximal d'emplacements externes à renvoyer.

--page-token string

Jeton de pagination opaque pour aller à la page suivante basé sur la query précédente.

Indicateurs globaux

Exemples

L'exemple suivant liste tous les emplacements externes :

Bash
databricks external-locations list

L'exemple suivant répertorie les emplacements externes avec un maximum de 10 résultats :

Bash
databricks external-locations list --max-results 10

Mise à jour des emplacements externes Databricks

Mettre à jour un emplacement externe dans le métastore. L'appelant doit être le propriétaire de l'emplacement externe, ou un administrateur du métastore. Dans le second cas, l'administrateur peut uniquement mettre à jour le nom de l'emplacement externe.

databricks external-locations update NAME [flags]

Arguments

NAME

Nom de l'emplacement externe.

Options

--comment string

Description textuelle libre fournie par l'utilisateur.

--credential-name string

Nom de l'identifiant de stockage utilisé avec cet emplacement.

--enable-file-events

Indique si les événements de fichier doivent être activés sur cet emplacement externe.

--fallback

Indique si le mode fallback est activé pour cet emplacement externe.

--force

Forcer la mise à jour même si le changement d'URL invalide les tables externes dépendantes ou les montages.

--isolation-mode IsolationMode

Valeurs prises en charge : ISOLATION_MODE_ISOLATED, ISOLATION_MODE_OPEN

--json JSON

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

--new-name string

Nouveau nom pour l'emplacement externe.

--owner string

Le propriétaire de l'emplacement externe.

--read-only

Indique si l'emplacement externe est en lecture seule.

--skip-validation

Ignore la validation de l'identifiant de stockage associé à l'emplacement externe.

--url string

URL du chemin d'accès de l'emplacement externe.

Indicateurs globaux

Exemples

L'exemple suivant renomme un emplacement externe :

Bash
databricks external-locations update my-external-location --new-name my-renamed-location

L’exemple suivant modifie le propriétaire d’un emplacement externe :

Bash
databricks external-locations update my-external-location --owner someone@example.com

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

Le nom du profil dans le fichier ~/.databrickscfg à utiliser pour exécuter la commande. Si cet indicateur n’est pas spécifié, si le profil nommé DEFAULT existe, il 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