external-metadata groupe de commande

Note

Ces informations s’appliquent à Databricks CLI versions 0.205 et ultérieures. L’interface CLI Databricks est en préversion publique.

L’utilisation de l’interface CLI Databricks est soumise à la licence Databricks et à la notification de confidentialité Databricks, y compris les dispositions relatives aux données d’utilisation.

Le external-metadata groupe de commandes dans l’interface CLI Databricks contient des commandes permettant d’inscrire et de gérer les métadonnées sur les systèmes externes dans le catalogue Unity.

databricks external-metadata create-external-metadata

Créez un objet de métadonnées externes dans le metastore parent si l’appelant est un administrateur de metastore ou dispose du privilège CREATE_EXTERNAL_METADATA . Accorde à tous les utilisateurs de compte lors de la création par défaut.

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, DATABRICKSSAPOTHERMYSQLTABLEAUMONGODBKAFKAGOOGLE_BIGQUERYLOOKERCONFLUENTMICROSOFT_FABRICAZURE_SYNAPSEMICROSOFT_SQL_SERVERORACLESNOWFLAKESERVICENOWSTREAM_NATIVEPOWER_BISALESFORCEPOSTGRESQL, , , TERADATAWORKDAY

ENTITY_TYPE

    Type d’entité au sein du système externe.

Options

--description string

    Description de texte libre fournie par l’utilisateur.

--json JSON

    Chaîne JSON inline ou chemin @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 externes.

Indicateurs globaux

Exemples

L’exemple suivant crée un objet de métadonnées externe 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 externes à 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 externes à 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 externes qui correspond au nom fourni. L’appelant doit être un administrateur de metastore, le propriétaire de l’objet de métadonnées externes ou un utilisateur disposant 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

Indicateurs globaux

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 externes spécifié dans un metastore. L’appelant doit être un administrateur de metastore, le propriétaire de l’objet de métadonnées externes ou un utilisateur disposant 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

Indicateurs globaux

Exemples

L’exemple suivant obtient un objet de métadonnées externes :

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

Répertorier les objets de métadonnées externes dans le metastore. Si l’appelant est l’administrateur du metastore, tous les objets de métadonnées externes sont récupérés. Sinon, seuls les objets de métadonnées externes sur lequel l’appelant a BROWSE sont récupérés. Il n’existe aucune garantie d’un classement 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 à retourner par page.

--page-token string

    Jeton pour récupérer la page suivante des résultats.

Indicateurs globaux

Exemples

L’exemple suivant répertorie tous les objets de métadonnées externes :

databricks external-metadata list-external-metadata

L’exemple suivant répertorie 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 externes 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 requête. L’appelant doit être un administrateur de metastore, le propriétaire de l’objet de métadonnées externes 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 seule chaîne, avec plusieurs champs séparés par des virgules (aucun espace). Le chemin du champ est relatif à l’objet de ressource, à l’aide d’un point (.) pour parcourir 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 le remplacement complet. Il est recommandé de toujours répertorier explicitement les champs mis à jour et d’éviter d’utiliser des 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, DATABRICKSSAPOTHERMYSQLTABLEAUMONGODBKAFKAGOOGLE_BIGQUERYLOOKERCONFLUENTMICROSOFT_FABRICAZURE_SYNAPSEMICROSOFT_SQL_SERVERORACLESNOWFLAKESERVICENOWSTREAM_NATIVEPOWER_BISALESFORCEPOSTGRESQL, , , TERADATAWORKDAY

ENTITY_TYPE

    Type d’entité au sein du système externe.

Options

--description string

    Description de texte libre fournie par l’utilisateur.

--json JSON

    Chaîne JSON inline ou chemin @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 externes.

Indicateurs globaux

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"}'

Indicateurs globaux

--debug

  Faut-il activer la journalisation du débogage ?

-h ou --help

    Affiche l’aide pour l’interface CLI de Databricks, le groupe de commandes associé ou la commande concernée.

--log-file chaîne de caractères

    Chaîne représentant le fichier utilisé pour écrire les logs de sortie. Si cet indicateur n’est pas défini, les journaux de sortie sont écrits par défaut dans stderr.

--log-format Format

    Type de format de journal : text ou json. La valeur par défaut est text.

--log-level chaîne de caractères

    Chaîne représentant le niveau de journalisation. Si cet indicateur n’est pas défini, le niveau de format de journal est désactivé.

Type -o, --output

    Type de sortie de commande, text ou json. La valeur par défaut est text.

-p, --profile chaîne de caractères

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

--progress-format Format

    Format permettant d’afficher les journaux de progression : default, append, inplace ou json

-t, --target chaîne de caractères

    Le cas échéant, la cible d'ensemble à utiliser