Partager via

Interface CLI (héritée) Unity Catalog

  • Article

Important

Cette documentation a été mise hors service et peut ne pas être mise à jour.

Ces informations s’appliquent aux anciennes versions Databricks CLI 0,18 et inférieures. Databricks vous recommande d’utiliser à la place la nouvelle version 0.205 ou supérieure de l’interface CLI Databricks. Consultez Qu’est-ce que l’interface CLI Databricks ?. Pour trouver votre version de l’interface CLI Databricks, exécutez databricks -v.

Pour migrer de Databricks CLI version 0,18 ou inférieure vers Databricks CLI version 0,205 ou supérieure, consultez Migration Databricks CLI.

Remarque

L’interface CLI de Unity Catalog est expérimentale.

L’interface CLI de Unity Catalog nécessite Databricks CLI (héritée) 0.17.0 ou ultérieure, configuré avec l’authentification. Pour mettre à jour l’interface CLI Databricks ou pour voir la version installée, consultez Mettre à jour l’interface CLI.

Les exemples d’options et de valeurs de champ dans les exemples suivants sont destinés seulement à des fins d’illustration.

Utilisez l’interface CLI Unity Catalog pour utiliser :

  • Les ressources Unity Catalog comme les metastores, les informations d’identification de stockage, les emplacements externes, les catalogues, les schémas, les tables et leurs autorisations.
  • Les ressources de Partage Delta telles que les partages, les destinataires et les fournisseurs.

Vous exécutez les sous-commandes de l’interface CLI de Unity Catalog en les ajoutant à databricks unity-catalog. Ces sous-commandes appellent l’API Unity Catalog, qui inclut également l’API Delta Sharing.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog --help.

Sortie :

Usage: databricks unity-catalog [OPTIONS] COMMAND [ARGS]...

  Utility to interact with Databricks Unity Catalog.

Options:
  -v, --version  0.17.1
  -h, --help     Show this message and exit.

Commands:
  catalogs
  external-locations
  lineage
  metastores
  permissions
  providers
  recipients
  schemas
  shares
  storage-credentials
  tables

Metastores

Utilisez la sous-commande unity-catalog metastores pour travailler avec des metastores.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores --help.

Créer un metastore

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores create --help. Consultez aussi Créer un métastore de catalogue Unity.

Notes

La création d’un metastore n’associe pas automatiquement le metastore à un espace de travail ou à des informations d’identification de stockage. Pour effectuer ces tâches, consultez Lier un metastore à un espace de travail, Créer des informations d’identification de stockage et Mettre à jour les paramètres d’un metastore.

Si vous exécutez cette commande sur un espace de travail auquel un metastore a déjà été affecté, vous allez mettre à jour le metastore affecté à cet espace de travail.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores assign --help.

databricks unity-catalog metastores assign --workspace-id 1234567890123456 \
                                           --metastore-id 12a345b6-7890-1cd2-3456-e789f0a12b34 \
                                           --default-catalog-name main

Pour obtenir l’ID de l’espace de travail, consultez Noms, URL et ID des instances d’espace de travail.

Pour obtenir l’ID du metastore, exécutez databricks unity-catalog metastores get-summary. Pour un exemple, consultez Obtenir des informations résumées sur le metastore actif.

Sortie :

{}

Consultez aussi Créer un métastore de catalogue Unity.

Mettre à jour les paramètres d’un metastore

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores update --help.

databricks unity-catalog metastores update --id 12a345b6-7890-1cd2-3456-e789f0a12b34 \
                                           --json-file update-metastore.json

Pour obtenir l’ID du metastore, exécutez databricks unity-catalog metastores get-summary. Pour un exemple, consultez Obtenir des informations résumées sur le metastore actif.

update-metastore.json:

{
  "storage_root_credential_id": "12a345b6-7890-1cd2-3456-e789f0a12b34"
}

Pour obtenir l’ID des informations d’identification racine du stockage, consultez Obtenir des informations sur les informations d’identification de stockage.

Lister les metastores disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores list --help.

databricks unity-catalog metastores list

Obtenir des informations sur un metastore

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores get --help.

databricks unity-catalog metastores get --id 12a345b6-7890-1cd2-3456-e789f0a12b34

Pour obtenir l’ID du metastore, exécutez databricks unity-catalog metastores get-summary. Pour un exemple, consultez Obtenir des informations résumées sur le metastore actif.

Obtenir des informations résumées sur le metastore actuel

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores get-summary --help.

databricks unity-catalog metastores get-summary

Obtenir l’affectation du metastore actuel d’un espace de travail

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores get-assignment --help.

databricks unity-catalog metastores get-assignment

Sortie :

{
  "workspace_id": 1234567890123456,
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "default_catalog_name": "main"
}

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores unassign --help.

databricks unity-catalog metastores unassign --workspace-id 1234567890123456 \
                                             --metastore-id 12a345b6-7890-1cd2-3456-e789f0a12b34

Pour obtenir l’ID de l’espace de travail, consultez Noms, URL et ID des instances d’espace de travail.

Pour obtenir l’ID du metastore, exécutez databricks unity-catalog metastores get-summary. Pour un exemple, consultez Obtenir des informations résumées sur le metastore actif.

Sortie :

{}

Supprimer un metastore

Avertissement

Avant de supprimer un metastore, vous devez supprimer tous les espaces de travail qui l’utilisent ou supprimer le lien entre ce metastore et ces espaces de travail. Contactez le support Azure Databricks pour obtenir de l’aide sur la suppression des liens de metastore des espaces de travail.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog metastores delete --help.

Pour forcer la suppression du metastore, utilisez l’option --force .

databricks unity-catalog metastores delete --id 12a345b6-7890-1cd2-3456-e789f0a12b34

Pour obtenir l’ID du metastore, exécutez databricks unity-catalog metastores get-summary. Pour un exemple, consultez Obtenir des informations résumées sur le metastore actif.

Si l’opération réussit, aucun résultat n’est retourné.

Informations d’identification de stockage

Utilisez la sous-commande unity-catalog storage-credentials pour travailler avec des informations d’identification de stockage. Consultez Créer des informations d’identification de stockage pour la connexion à Azure Data Lake Storage Gen2.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog storage-credentials --help.

Créer des informations d’identification de stockage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog storage-credentials create --help.

Voir également Créer des informations d’identification de stockage pour la connexion à Azure Data Lake Storage Gen2.

Mettre à jour les paramètres des informations d’identification de stockage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog storage-credentials update --help.

Lister les informations d’identification de stockage disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog storage-credentials list --help.

databricks unity-catalog storage-credentials list

Obtenir des détails sur des informations d’identification de stockage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog storage-credentials get --help.

databricks unity-catalog storage-credentials get --name my-storage-root-credential

Supprimer des informations d’identification de stockage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog storage-credentials delete --help.

Pour forcer la suppression des informations d’identification de stockage, utilisez l’option --force.

databricks unity-catalog storage-credentials delete --name my-storage-root-credential

Si l’opération réussit, aucun résultat n’est retourné.

Emplacements externes

Utilisez la sous-commande unity-catalog external-locations pour travailler avec des emplacements externes. Veuillez consulter la rubrique Créer un emplacement externe pour connecter le stockage cloud à Azure Databricks.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations --help.

Créer un emplacement externe.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations create --help. Consulter aussi Créer un emplacement externe pour connecter un stockage cloud à Azure Databricks.

Valider un emplacement externe et une paire d’informations d’identification

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations validate --help.

Valider un nom d’emplacement externe et une paire d’informations d’identification après leur création

databricks unity-catalog external-locations validate --name my-external-location \
                                                     --cred-name my-storage-root-credential

Sortie :

{
  "isDir": true,
  "results": [
    {
      "operation": "READ",
      "result": "PASS"
    },
    {
      "operation": "LIST",
      "result": "PASS"
    },
    {
      "operation": "WRITE",
      "result": "PASS"
    },
    {
      "operation": "DELETE",
      "result": "PASS"
    }
  ]
}

Mettre à jour les paramètres d’un emplacement externe

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations update --help.

databricks unity-catalog external-locations update --name my-external-location \
                                                   --json-file update-external-location.json

udpate-external-location.json:

{
  "name": "my-external-location-2"
}

Lister les emplacements externes disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations list --help.

databricks unity-catalog external-locations list

Obtenir des informations sur un emplacement externe

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations get --help.

databricks unity-catalog external-locations get --name my-external-location

Supprimer un emplacement externe.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog external-locations delete --help.

Pour forcer la suppression de l’emplacement externe, utilisez l’option --force.

databricks unity-catalog external-locations delete --name my-external-location

Si l’opération réussit, aucun résultat n’est retourné.

Catalogues

Utilisez la sous-commande unity-catalog catalogs pour travailler avec des catalogues.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog catalogs --help.

Créer un catalogue

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog catalogs create --help. Consultez également Créer des catalogues.

databricks unity-catalog catalogs create --name my-catalog

Sortie :

{
  "name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656113178995,
  "created_by": "someone@example.com",
  "updated_at": 1656113178995,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

Mettre à jour les paramètres d’un catalogue

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog catalogs update --help.

databricks unity-catalog catalogs update --name my-catalog \
                                         --json-file update-catalog.json

update-catalog.json:

{
  "name": "my-catalog-2",
  "owner": "someone@example.com"
}

Sortie :

{
  "name": "my-catalog-2",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656355967835,
  "created_by": "someone@example.com",
  "updated_at": 1656356095989,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

Lister les catalogues disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog catalogs list --help.

databricks unity-catalog catalogs list

Sortie :

{
  "catalogs": [
    {
      "name": "main",
      "owner": "someone@example.com",
      "comment": "Main catalog (auto-created)",
      "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656112029355,
      "created_by": "someone@example.com",
      "updated_at": 1656112029355,
      "updated_by": "someone@example.com",
      "catalog_type": "MANAGED_CATALOG"
    },
    {
      "...": "..."
    }
  ]
}

Obtenir des informations sur un catalogue

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog catalogs get --help.

databricks unity-catalog catalogs get --name my-catalog

Sortie :

{
  "name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "created_at": 1656113178995,
  "created_by": "someone@example.com",
  "updated_at": 1656113178995,
  "updated_by": "someone@example.com",
  "catalog_type": "MANAGED_CATALOG"
}

Supprimer un catalogue

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog catalogs delete --help. Consultez aussi Supprimer un catalogue.

Pour forcer la suppression d’un catalogue, utilisez l’option --purge.

databricks unity-catalog catalogs delete --name my-catalog

Si l’opération réussit, aucun résultat n’est retourné.

Schémas

Utilisez la sous-commande unity-catalog schemas pour travailler avec des schémas.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog schemas --help.

Créer un schéma

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog schemas create --help. Consultez également Créer des schémas.

databricks unity-catalog schemas create --catalog-name my-catalog \
                                        --name my-schema

Sortie :

{
  "name": "my-schema",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema",
  "created_at": 1656113607800,
  "created_by": "someone@example.com",
  "updated_at": 1656113607800,
  "updated_by": "someone@example.com"
}

Modifier les paramètres d’un schéma

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog schemas update --help.

databricks unity-catalog schemas update --full-name my-catalog.my-schema \
                                        --json-file update-schema.json

update-schema.json:

{
  "name": "my-schema-2",
  "owner": "someone@example.com"
}

Sortie :

{
  "name": "my-schema-2",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "comment": "Default schema (auto-created)",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema-2",
  "created_at": 1656355967837,
  "created_by": "someone@example.com",
  "updated_at": 1656356592786,
  "updated_by": "someone@example.com"
}

Lister les schémas disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog schemas list --help.

databricks unity-catalog schemas list --catalog-name my-catalog

Sortie :

{
  "schemas": [
    {
      "name": "default",
      "catalog_name": "my-catalog",
      "owner": "someone@example.com",
      "comment": "Default schema (auto-created)",
      "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "full_name": "my-catalog.default",
      "created_at": 1656113178996,
      "created_by": "someone@example.com",
      "updated_at": 1656113178996,
      "updated_by": "someone@example.com"
    },
    {
      "...": "..."
    }
  ]
}

Obtenir des informations sur un schéma

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog schemas get --help.

databricks unity-catalog schemas get --full-name my-catalog.my-schema

Sortie :

{
  "name": "my-schema",
  "catalog_name": "my-catalog",
  "owner": "someone@example.com",
  "metastore_id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
  "full_name": "my-catalog.my-schema",
  "created_at": 1656113607800,
  "created_by": "someone@example.com",
  "updated_at": 1656113607800,
  "updated_by": "someone@example.com"
}

Supprimer un schéma

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog schemas delete --help. Consultez aussi Supprimer un schéma.

Pour forcer la suppression d’un schéma, utilisez l’option --purge.

databricks unity-catalog schemas delete --full-name my-catalog.my-schema

Si l’opération réussit, aucun résultat n’est retourné.

Tables

Utilisez la sous-commande unity-catalog tables pour travailler avec des tables.

Notes

La création de tables avec l’interface CLI de Unity Catalog n’est pas prise en charge. Pour créer des tables, consultez Qu’est-ce que les tables et les vues ? et tutoriel : Créer votre première table et accorder des privilèges.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog tables --help.

Lister les tables disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog tables list --help.

databricks unity-catalog tables list --catalog-name main \
                                     --schema-name default

Lister les résumés des tables disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog tables list-summaries --help.

databricks unity-catalog tables list-summaries --catalog-name main

Sortie :

{
  "tables": [
    {
      "full_name": "main.default.mytable",
      "table_type": "MANAGED"
    },
    {
      "...": "..."
    }
  ]
}

Obtenir des informations sur une table

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog tables get --help.

databricks unity-catalog tables get --full-name main.default.mytable

Suppression d’une table

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog tables delete --help.

databricks unity-catalog tables delete --full-name main.default.mytable

Si l’opération réussit, aucun résultat n’est retourné.

Traçabilités

Utilisez la sous-commande unity-catalog lineage pour travailler avec des traçabilités de table et de colonne.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog lineage --help.

Lister la traçabilité d’une table

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog lineage table --help.

databricks unity-catalog lineage table --table-name main.default.mytable \
                                       --level 1

Lister la traçabilité d’une colonne

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog lineage column --help.

databricks unity-catalog lineage column --table-name main.default.mytable \
                                        --column-name id

Autorisations

Utilisez la sous-commande unity-catalog permissions pour travailler avec des autorisations pour les objets sécurisables. Consultez aussi Gérer les privilèges dans Unity Catalog.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog permissions --help.

Obtenir des informations sur les autorisations d’un objet sécurisable

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog permissions get --help. Consultez aussi Privilèges Unity Catalog et objets sécurisables.

Catalogue

databricks unity-catalog permissions get --catalog main

Sortie :

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "USE CATALOG"
      ]
    }
  ]
}

schéma

databricks unity-catalog permissions get --schema main.default

Sortie :

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "USE SCHEMA"
      ]
    }
  ]
}

Table de charge de travail

databricks unity-catalog permissions get --table main.default.mytable

Sortie :

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "SELECT"
      ]
    }
  ]
}

Informations d’identification de stockage

databricks unity-catalog permissions get --storage-credential my-storage-root-credential

Sortie :

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "READ_FILES"
      ]
    }
  ]
}

Emplacement externe

databricks unity-catalog permissions get --external-location my-external-location

Sortie :

{
  "privilege_assignments": [
    {
      "principal": "account users",
      "privileges": [
        "READ_FILES"
      ]
    }
  ]
}

Mettre à jour les autorisations d’un objet sécurisable

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog permissions update --help. Consultez aussi Privilèges Unity Catalog et objets sécurisables.

Catalogue

databricks unity-catalog permissions update --catalog \
                                            --json-file update-catalog-permissions.json

update-catalog-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": [ "USE CATALOG" ],
      "remove": [ "CREATE SCHEMA" ]
    }
  ]
}

schéma

databricks unity-catalog permissions update --schema \
                                            --json-file update-schema-permissions.json

update-schema-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": [ "USE SCHEMA" ],
      "remove": [ "CREATE TABLE" ]
    },
    {
      "principal": "admin team",
      "add": [ "CREATE TABLE" ]
    }
  ]
}

Table de charge de travail

databricks unity-catalog permissions update --table \
                                            --json-file update-table-permissions.json

update-table-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "add": [ "SELECT" ],
      "remove": [ "MODIFY" ]
    },
    {
      "principal": "admin team",
      "add": [ "ALL" ]
    }
  ]
}

Informations d’identification de stockage

databricks unity-catalog permissions update --storage-credential \
                                            --json-file update-storage-credential-permissions.json

update-storage-credential-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "remove": [ "READ FILES" ]
    },
    {
      "principal": "storage team",
      "add": [ "READ FILES",
               "WRITE FILES",
               "CREATE EXTERNAL TABLE"
             ]
    },
    {
      "principal": "admin team",
      "add": [ "ALL" ]
    }
  ]
}

Emplacement externe

databricks unity-catalog permissions update --external-location \
                                            --json-file update-external-location-permissions.json

update-external-location-permissions.json:

{
  "changes": [
    {
      "principal": "account users",
      "remove": [ "READ FILES" ]
    },
    {
      "principal": "storage team",
      "add": [ "READ FILES",
               "WRITE FILES",
               "CREATE EXTERNAL TABLE"
             ]
    },
    {
      "principal": "admin team",
      "add": [ "ALL" ]
    }
  ]
}

Partages

Utilisez la sous-commande unity-catalog shares pour travailler avec des partages, qui sont des objets contenant des collections de tables dans un metastore Unity Catalog activé pour Delta Sharing et que vous voulez partager en tant que groupe avec des destinataires Delta Sharing. Un partage ne peut contenir des tables que d’un seul metastore. Consultez Créer et gérer des partages pour Delta Sharing.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares --help.

Créer un partage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares create --help. Voir aussi Créer et gérer des partages pour Delta Sharing.

databricks unity-catalog shares create --name my-share

Sortie :

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Mettre à jour les paramètres d’un partage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares update --help. Voir aussi Mise à jour des partages.

Ajouter une table à un partage

databricks unity-catalog shares update --name my-share \
                                       --add-table main.default.mytable

Sortie :

{
  "name": "my-share",
  "objects": [
    {
      "name": "main.default.mytable",
      "data_object_type": "TABLE",
      "added_at": 1656434168847,
      "added_by": "someone@example.com",
      "shared_as": "default.mytable",
      "cdf_enabled": false
    }
  ],
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Voir aussi Ajout d’une table à un partage

Supprimer une table d’un partage

databricks unity-catalog shares update --name my-share \
                                       --remove-table main.default.mytable

Sortie :

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Voir aussi Ajout d’une table à un partage

Mettre à jour les autorisations d’un partage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares update-permissions --help. Voir aussi Gérer l’accès aux partages de données Delta Sharing (pour les fournisseurs).

databricks unity-catalog shares update-permissions --name my-share \
                                                   --json-file update-share-permissions.json

update-share-permissions.json:

{
  "privilege_assignments": [
    {
      "principal": "my-recipient",
      "privileges": [
        "SELECT"
      ]
    }
  ]
}

Lister les partages disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares list --help. Voir aussi Afficher les partages et partager les détails.

databricks unity-catalog shares list

Sortie :

{
  "shares": [
    {
      "name": "my-share",
      "created_at": 1656433327533,
      "created_by": "someone@example.com",
      "owner": "someone@example.com"
    },
    {
      "...": "..."
    }
  ]
}

Obtenir des informations sur un partage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares get --help. Voir aussi Afficher les partages et partager les détails.

databricks unity-catalog shares get --name my-share

Sortie :

{
  "name": "my-share",
  "created_at": 1656433327533,
  "created_by": "someone@example.com",
  "owner": "someone@example.com"
}

Lister les autorisations d’un partage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares list-permissions --help. Voir aussi Afficher les destinataires qui disposent d’autorisations sur un partage.

databricks unity-catalog shares list-permissions --name my-share

Sortie :

{
  "privilege_assignments": [
    {
      "principal": "my-recipient",
      "privileges": [
        "SELECT"
      ]
    }
  ]
}

Supprimer un partage

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog shares delete --help. Consultez aussi Supprimer un partage.

databricks unity-catalog shares delete --name my-share

Si l’opération réussit, aucun résultat n’est retourné.

Destinataires

Utilisez la sous-commande unity-catalog recipients pour travailler avec des destinataires de données pour des metastores Unity Catalog activés pour Delta Sharing. Les destinataires de données sont des personnes ou des groupes avec lesquels un utilisateur Azure Databricks partage des données en dehors de l’organisation de l’utilisateur Azure Databricks. Consultez Créer et gérer des destinataires de données pour Delta Sharing.

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients --help.

Créer un destinataire

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients create --help. Consultez également Créer et gérer des destinataires de données pour Delta Sharing.

Pour générer une nouvelle URL d’activation pour une destinataire, exécutez databricks unity-catalog recipients rotate-token. Pour obtenir un exemple, consultez Effectuer la rotation du jeton d’un destinataire.

databricks unity-catalog recipients create --name my-recipient

Sortie :

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656521688006,
      "updated_at": 1656435288006,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Modifier les paramètres d’un destinataire

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients update --help.

databricks unity-catalog recipients update --name my-recipient \
                                           --json-file update-recipient-settings.json

update-recipient-settings.json:

{
  "name": "my-recipient-2"
}

Sortie :

{
  "name": "my-recipient-2",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "expiration_time": 1656436808507,
      "updated_at": 1656435908507,
      "updated_by": "someone@example.com"
    },
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435908509,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656522308510,
      "updated_at": 1656435908510,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656436740986,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Effectuer la rotation du jeton d’un destinataire

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients rotate-token --help. Voir aussi Gérer les jetons de destinataire (partage ouvert).

databricks unity-catalog recipients rotate-token --name my-recipient \
                                                 --existing-token-expire-in-seconds 900

Sortie :

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "expiration_time": 1656436808507,
      "updated_at": 1656435908507,
      "updated_by": "someone@example.com"
    },
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435908509,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656522308510,
      "updated_at": 1656435908510,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Lister les destinataires disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients list --help. Voir aussi Afficher les destinataires.

databricks unity-catalog recipients list

Sortie :

{
  "recipients": [
    {
      "name": "my-recipient",
      "created_at": 1656435288003,
      "created_by": "someone@example.com",
      "tokens": [
        {
          "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
          "created_at": 1656435288005,
          "created_by": "someone@example.com",
          "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
          "expiration_time": 1656521688006,
          "updated_at": 1656435288006,
          "updated_by": "someone@example.com"
        }
      ],
      "authentication_type": "TOKEN",
      "updated_at": 1656435288003,
      "updated_by": "someone@example.com",
      "owner": "someone@example.com"
    }
  ]
}

Lister les autorisations de partage d’un destinataire

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients list-permissions --help. Voir aussi Afficher les autorisations de partage d’un destinataire.

databricks unity-catalog recipients list-permissions --name my-recipient

Sortie :

{
  "permissions_out": [
    {
      "share_name": "my-share",
      "privilege_assignments": [
        {
          "privileges": [
            "SELECT"
          ]
        }
      ]
    }
  ]
}

Obtenir des informations sur un destinataire

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients get --help. Voir aussi Afficher les détails du destinataire.

databricks unity-catalog recipients get --name my-recipient

Sortie :

{
  "name": "my-recipient",
  "created_at": 1656435288003,
  "created_by": "someone@example.com",
  "tokens": [
    {
      "id": "12a345b6-7890-1cd2-3456-e789f0a12b34",
      "created_at": 1656435288005,
      "created_by": "someone@example.com",
      "activation_url": "https://example.com/delta_sharing/retrieve_config.html?<unique-id>",
      "expiration_time": 1656521688006,
      "updated_at": 1656435288006,
      "updated_by": "someone@example.com"
    }
  ],
  "authentication_type": "TOKEN",
  "updated_at": 1656435288003,
  "updated_by": "someone@example.com",
  "owner": "someone@example.com"
}

Supprimer un destinataire

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog recipients delete --help. Consultez aussi Supprimer un destinataire.

databricks unity-catalog recipients delete --name my-recipient

Si l’opération réussit, aucun résultat n’est retourné.

Fournisseurs

Si vous êtes un destinataire de données partagées Delta Sharing, utilisez la unity-catalog providers sous-commande pour travailler avec des fournisseurs de données Delta Sharing. Consultez Gérer les fournisseurs de partage Delta (pour les destinataires de données).

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog providers --help.

Créer un fournisseur

Si vous êtes destinataire de données partagées à l’aide du protocole de partage ouvert et que vous utilisez un espace de travail Databricks attaché à un metastore Unity Catalog, vous pouvez créer un objet fournisseur dans votre metastore Unity Catalog. Vous pouvez ensuite gérer l’accès aux données partagées à l’aide d’Unity Catalog.

Important

Ce scénario est rare. Si vous utilisez un espace de travail Databricks activé pour Unity Catalog et qu’un autre client Databricks partage des données avec vous, il doit utiliser le Partage Databricks-à-Databricks. Avec le partage Databricks-à-Databricks, les objets fournisseur sont créés à votre place dans Unity Catalog.

Pour créer un fournisseur, vous devez :

Exécutez la commande suivante, en my-provider remplaçant par le nom que vous souhaitez donner au fournisseur et config.share par le chemin d’accès à votre fichier d’informations d’identification téléchargé, qui est nommé config.share par défaut.

databricks unity-catalog providers create --name my-provider  \
                  --recipient-profile-json-file config.share

Mettre à jour les paramètres d’un fournisseur

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog providers update --help.

databricks unity-catalog providers update --name my-provider \
                                          --new-name my-provider-2

Lister les fournisseurs disponibles

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog providers list --help.

databricks unity-catalog providers list

Obtenir des informations sur un fournisseur

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog providers get --help.

databricks unity-catalog providers get --name my-provider

Lister les partages disponibles d’un fournisseur

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog providers list-shares --help.

databricks unity-catalog providers list-shares --name my-provider

Supprimer un fournisseur

Pour afficher la documentation d’utilisation, exécutez databricks unity-catalog providers delete --help.

databricks unity-catalog providers delete --name my-provider

Si l’opération réussit, aucun résultat n’est retourné.