external-lineage 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-lineage groupe de commandes dans l’interface CLI Databricks contient des commandes pour définir et gérer les relations de traçabilité entre les objets Databricks et les systèmes externes.

databricks external-lineage create-external-lineage-relationship

Créez une relation de traçabilité externe entre un objet databricks ou des métadonnées externes et un autre objet de métadonnées externe.

databricks external-lineage create-external-lineage-relationship SOURCE TARGET [flags]

Arguments

SOURCE

    Objet source de la relation de traçabilité externe.

TARGET

    Objet cible de la relation de traçabilité externe.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Exemples

L’exemple suivant crée une relation de traçabilité externe à l’aide de JSON :

databricks external-lineage create-external-lineage-relationship source_object target_object --json '{"column_mappings": [{"source_column": "id", "target_column": "external_id"}]}'

L’exemple suivant crée une relation de traçabilité externe à l’aide d’un fichier JSON :

databricks external-lineage create-external-lineage-relationship source_object target_object --json @lineage.json

databricks external-lineage delete-external-lineage-relationship

Supprimez une relation de traçabilité externe entre un objet databricks ou des métadonnées externes et un autre objet de métadonnées externe.

databricks external-lineage delete-external-lineage-relationship [flags]

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Exemples

L’exemple suivant supprime une relation de traçabilité externe à l’aide de JSON :

databricks external-lineage delete-external-lineage-relationship --json '{"source": "source_object", "target": "target_object"}'

L’exemple suivant supprime une relation de traçabilité externe à l’aide d’un fichier JSON :

databricks external-lineage delete-external-lineage-relationship --json @delete-lineage.json

databricks external-lineage list-external-lineage-relations

Répertorier les relations de traçabilité externe d’un objet Databricks ou de métadonnées externes en fonction d’une direction fournie.

databricks external-lineage list-external-lineage-relationships [flags]

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

--page-size int

    Nombre maximal de relations de traçabilité externe à 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 les relations de traçabilité externe à l’aide de JSON :

databricks external-lineage list-external-lineage-relationships --json '{"object": "my_catalog.my_schema.my_table", "direction": "DOWNSTREAM"}'

L’exemple suivant répertorie les relations de traçabilité externe avec la pagination :

databricks external-lineage list-external-lineage-relationships --json '{"object": "my_catalog.my_schema.my_table", "direction": "UPSTREAM"}' --page-size 10

L’exemple suivant répertorie les relations de traçabilité externe à l’aide d’un fichier JSON :

databricks external-lineage list-external-lineage-relationships --json @list-lineage.json

databricks external-lineage update-external-lineage-relationship

Mettez à jour une relation de traçabilité externe entre un objet databricks ou des métadonnées externes et un autre objet de métadonnées externe.

databricks external-lineage update-external-lineage-relationship UPDATE_MASK SOURCE TARGET [flags]

Arguments

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.

SOURCE

    Objet source de la relation de traçabilité externe.

TARGET

    Objet cible de la relation de traçabilité externe.

Options

--json JSON

    Chaîne JSON inline ou chemin @path vers le fichier JSON avec le corps de la requête

Indicateurs globaux

Exemples

L’exemple suivant met à jour une relation de traçabilité externe à l’aide de JSON :

databricks external-lineage update-external-lineage-relationship "column_mappings" source_object target_object --json '{"column_mappings": [{"source_column": "updated_id", "target_column": "new_external_id"}]}'

L’exemple suivant met à jour une relation de traçabilité externe à l’aide d’un fichier JSON :

databricks external-lineage update-external-lineage-relationship "column_mappings" source_object target_object --json @update-lineage.json

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