groupe de commandesexternal-metadata
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-metadata au sein de l'CLI Databricks contient des commandes pour enregistrer et gérer les métadonnées sur les systèmes externes au sein de Unity Catalog.
databricks external-metadata create-external-metadata
Créez un nouvel objet de métadonnées externe dans le métastore parent si l'appelant est un administrateur de métastore ou dispose du privilège CREATE_EXTERNAL_METADATA . Accorde BROWSE à tous les utilisateurs du compte lors de la création par default.
databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]
Arguments
NAME
Nom de l’objet de métadonnées externes.
SYSTEM_TYPE
Type de système externe. Valeurs prises en charge : AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, TERADATA, WORKDAY.
ENTITY_TYPE
Type d'entité au sein du système externe.
Options
--description string
Description textuelle libre fournie par l'utilisateur.
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
--owner string
Propriétaire de l'objet de métadonnées externes.
--url string
URL associée à l'objet de métadonnées externe.
Exemples
L'exemple suivant crée un objet de métadonnées externes pour une table Snowflake :
databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"
L'exemple suivant crée un objet de métadonnées externe à l'aide de JSON :
databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'
L'exemple suivant crée un objet de métadonnées externe à l'aide d'un fichier JSON :
databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json
databricks external-metadata delete-external-metadata
Supprimez l'objet de métadonnées externe qui correspond au nom fourni. L'appelant doit être un administrateur de métastore, le propriétaire de l'objet de métadonnées externe, ou un utilisateur qui dispose du privilège **MANAGE**.
databricks external-metadata delete-external-metadata NAME [flags]
Arguments
NAME
Nom de l'objet de métadonnées externes à supprimer.
Options
Exemples
L'exemple suivant supprime un objet de métadonnées externes :
databricks external-metadata delete-external-metadata my_snowflake_table
databricks external-metadata get-external-metadata
Obtenez l'objet de métadonnées externe spécifié dans un métastore. L'appelant doit être un administrateur de métastore, le propriétaire de l'objet de métadonnées externe, ou un utilisateur qui dispose du privilège BROWSE .
databricks external-metadata get-external-metadata NAME [flags]
Arguments
NAME
Nom de l'objet de métadonnées externes à obtenir.
Options
Exemples
L'exemple suivant obtient un objet de métadonnées externe :
databricks external-metadata get-external-metadata my_snowflake_table
databricks external-metadata list-external-metadata
Lister les objets de métadonnées externes dans le metastore. Si l'appelant est l'administrateur du métastore, tous les objets de métadonnées externes seront récupérés. Sinon, seuls les objets de métadonnées externes pour lesquels l’appelant dispose d’un droit de NAVIGATION seront récupérés. Il n'y a aucune garantie d'un ordre spécifique des éléments dans le tableau.
databricks external-metadata list-external-metadata [flags]
Options
--page-size int
Nombre maximal d'objets de métadonnées externes à renvoyer par page.
--page-token string
Jeton pour récupérer la page suivante de résultats.
Exemples
L'exemple suivant liste tous les objets de métadonnées externes :
databricks external-metadata list-external-metadata
L'exemple suivant liste les objets de métadonnées externes avec pagination :
databricks external-metadata list-external-metadata --page-size 10
databricks external-metadata update-external-metadata
Mettez à jour l'objet de métadonnées externe qui correspond au nom fourni. L'appelant ne peut mettre à jour que le propriétaire ou d'autres champs de métadonnées dans une seule requête. L'appelant doit être un administrateur du métastore, le propriétaire de l'objet de métadonnées externe, ou un utilisateur disposant du privilège MODIFY . Si l'appelant met à jour le propriétaire, il doit également disposer du privilège MANAGE .
databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]
Arguments
NAME
Nom de l’objet de métadonnées externes.
UPDATE_MASK
Le masque de champ doit être une chaîne unique, avec plusieurs champs séparés par des virgules (sans espaces). Le chemin de champ est relatif à l’objet ressource, en utilisant un point (.) pour naviguer dans les sous-champs (par exemple, author.given_name). La spécification d’éléments dans des champs de séquence ou de carte n’est pas autorisée, car seul le champ de collection entier peut être spécifié. Les noms de champs doivent correspondre exactement aux noms des champs de ressource.
Un masque de champ astérisque (*) indique un remplacement complet. Il est recommandé de toujours lister explicitement les champs mis à jour et d'éviter l'utilisation de caractères génériques, car cela peut entraîner des résultats inattendus si l'API change à l'avenir.
SYSTEM_TYPE
Type de système externe. Valeurs prises en charge : AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, TERADATA, WORKDAY.
ENTITY_TYPE
Type d'entité au sein du système externe.
Options
--description string
Description textuelle libre fournie par l'utilisateur.
--json JSON
La chaîne JSON en ligne ou le @path vers le fichier JSON avec le corps de la requête
--owner string
Propriétaire de l'objet de métadonnées externes.
--url string
URL associée à l'objet de métadonnées externe.
Exemples
L'exemple suivant met à jour la description d'un objet de métadonnées externe :
databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"
L’exemple suivant met à jour le propriétaire d’un objet de métadonnées externe :
databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"
L'exemple suivant met à jour un objet de métadonnées externes à l'aide de JSON :
databricks external-metadata update-external-metadata my_snowflake_table "description,url" SNOWFLAKE TABLE --json '{"description": "Latest sales data", "url": "https://example.snowflakecomputing.com/table/sales_v2"}'
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