Unity Catalog CLI (Legacy)

  • Artikel

Wichtig

Diese Dokumentation wurde eingestellt und wird unter Umständen nicht aktualisiert.

Diese Informationen gelten für ältere Versionen der Databricks-Befehlszeilenschnittstelle (0.18 und niedriger). Databricks empfiehlt, stattdessen die neuere Databricks-CLI Version 0.205 oder höher zu verwenden. Weitere Informationen finden Sie unter Was ist die Databricks-CLI?. Führen Sie databricks -v aus, um die Version Ihrer Databricks CLI zu ermitteln.

Informationen zum Migrieren der Databricks CLI-Version 0.18 oder niedriger zur Databricks CLI-Version 0.205 oder höher finden Sie unter Databricks CLI-Migration.

Hinweis

Die Unity Catalog CLI ist jedoch experimentell.

Die Unity Catalog CLI erfordert Databricks CLI (Legacy) 0.17.0 oder höher mit konfigurierter Authentifizierung. Informationen zum Aktualisieren der Databricks CLI oder zum Auflisten der installierten Version finden Sie unter Aktualisieren der CLI.

Options- und Feldbeispielwerte in den folgenden Beispielen sind nur für veranschauliche Zwecke vorgesehen.

Verwenden Sie die Unity Catalog CLI, um mit Folgendem zu arbeiten:

  • Unity Catalog-Ressourcen wie Metastores, Speicheranmeldeinformationen, externen Speicherorten, Katalogen, Schemas, Tabellen und deren Berechtigungen.
  • Delta Sharing-Ressourcen wie Freigaben, Empfänger und Anbieter.

Sie führen Unterbefehle über die CLI für Unity Catalog aus, indem Sie sie an databricks unity-catalog anfügen. Durch diese Unterbefehle wird die Unity Catalog-API aufgerufen, die auch die Delta Sharing-API enthält.

Führen Sie databricks unity-catalog --help aus, um die Syntaxdokumentation anzuzeigen.

Ausgabe:

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

Verwenden Sie den Unterbefehl unity-catalog metastores, um mit Metastores zu arbeiten.

Führen Sie databricks unity-catalog metastores --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen eines Metastore

Führen Sie databricks unity-catalog metastores create --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie unter Erstellen eines Unity Catalog-Metastore.

Hinweis

Das Erstellen eines Metastores ordnet den Metastore nicht automatisch einem Arbeitsbereich oder einer Speicheranmeldeinformationen zu. Informationen zum Abschließen dieser Aufgaben finden Sie unter Verknüpfen eines Metastores mit einem Arbeitsbereich, Erstellen einer Speicheranmeldeinformationen und Aktualisieren der Einstellungen eines Metastores.

Wenn Sie diesen Befehl auf einem Arbeitsbereich ausführen, der bereits über einen zugewiesenen Metastore verfügt, aktualisieren Sie den zugewiesenen Metastore dieses Arbeitsbereichs.

Führen Sie databricks unity-catalog metastores assign --help aus, um die Syntaxdokumentation anzuzeigen.

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

Informationen zum Abrufen der Arbeitsbereichs-ID finden Sie unter Arbeitsbereichinstanznamen, URLs und IDs.

Um die Metastore-ID abzurufen, führen Sie databricks unity-catalog metastores get-summary aus. Ein Beispiel finden Sie unter Abrufen zusammengefasster Informationen zum aktuellen Metastore.

Ausgabe:

{}

Weitere Informationen finden Sie unter Erstellen eines Unity Catalog-Metastore.

Aktualisieren der Einstellungen eines Metastores

Führen Sie databricks unity-catalog metastores update --help aus, um die Syntaxdokumentation anzuzeigen.

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

Um die Metastore-ID abzurufen, führen Sie databricks unity-catalog metastores get-summary aus. Ein Beispiel finden Sie unter Abrufen zusammengefasster Informationen zum aktuellen Metastore.

update-metastore.json:

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

Informationen zum Abrufen der Stammanmeldeinformations-ID eines Speichers finden Sie unter Abrufen von Informationen zu einer Speicheranmeldeinformation.

Auflisten verfügbarer Metastores

Führen Sie databricks unity-catalog metastores list --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog metastores list

Abrufen der Informationen zu einem Metastore

Führen Sie databricks unity-catalog metastores get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Um die Metastore-ID abzurufen, führen Sie databricks unity-catalog metastores get-summary aus. Ein Beispiel finden Sie unter Abrufen zusammengefasster Informationen zum aktuellen Metastore.

Abrufen zusammengefasster Informationen zum aktuellen Metastore

Führen Sie databricks unity-catalog metastores get-summary --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog metastores get-summary

Abrufen der aktuellen Metastorezuweisung für einen Arbeitsbereich

Führen Sie databricks unity-catalog metastores get-assignment --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog metastores get-assignment

Ausgabe:

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

Führen Sie databricks unity-catalog metastores unassign --help aus, um die Syntaxdokumentation anzuzeigen.

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

Informationen zum Abrufen der Arbeitsbereichs-ID finden Sie unter Arbeitsbereichinstanznamen, URLs und IDs.

Um die Metastore-ID abzurufen, führen Sie databricks unity-catalog metastores get-summary aus. Ein Beispiel finden Sie unter Abrufen zusammengefasster Informationen zum aktuellen Metastore.

Ausgabe:

{}

Löschen eines Metastores

Warnung

Bevor Sie einen Metastore löschen, müssen Sie alle Arbeitsbereiche löschen, die den Metastore verwenden, oder den Metastorelink zu diesen Arbeitsbereichen entfernen. Wenden Sie sich an den Azure Databricks-Support, wenn Sie Hilfe beim Entfernen von Metastore-Links aus Arbeitsbereichen benötigen.

Führen Sie databricks unity-catalog metastores delete --help aus, um die Syntaxdokumentation anzuzeigen.

Um den Metastore erzwungen zu löschen, verwenden Sie die Option --force.

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

Um die Metastore-ID abzurufen, führen Sie databricks unity-catalog metastores get-summary aus. Ein Beispiel finden Sie unter Abrufen zusammengefasster Informationen zum aktuellen Metastore.

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Speicheranmeldeinformationen

Verwenden Sie den Unterbefehl unity-catalog storage-credentials, um mit Speicheranmeldeinformationen zu arbeiten. Weitere Informationen finden Sie unter Erstellen von Speicheranmeldeinformationen zum Herstellen einer Verbindung mit Azure Data Lake Storage Gen2.

Führen Sie databricks unity-catalog storage-credentials --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen von Speicheranmeldeinformationen

Führen Sie databricks unity-catalog storage-credentials create --help aus, um die Syntaxdokumentation anzuzeigen.

Weitere Informationen finden Sie auch unter Erstellen von Speicheranmeldeinformationen zum Herstellen einer Verbindung mit Azure Data Lake Storage Gen2.

Aktualisieren der Einstellungen einer Speicheranmeldeinformation

Führen Sie databricks unity-catalog storage-credentials update --help aus, um die Syntaxdokumentation anzuzeigen.

Auflisten verfügbarer Speicheranmeldeinformationen

Führen Sie databricks unity-catalog storage-credentials list --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog storage-credentials list

Abrufen von Informationen einer Speicheranmeldeinformation

Führen Sie databricks unity-catalog storage-credentials get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Löschen von Speicheranmeldeinformationen

Führen Sie databricks unity-catalog storage-credentials delete --help aus, um die Syntaxdokumentation anzuzeigen.

Um die Speicheranmeldeinformationen erzwungen zu löschen, verwenden Sie die Option --force.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Externe Speicherorte

Verwenden Sie den Unterbefehl unity-catalog external-locations, um mit externen Speicherorten zu arbeiten. Weitere Informationen finden Sie unter Erstellen eines externen Speicherorts zum Verbinden des Cloudspeichers mit Azure Databricks.

Führen Sie databricks unity-catalog external-locations --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen eines externen Speicherorts

Führen Sie databricks unity-catalog external-locations create --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Erstellen eines externen Speicherorts zum Verbinden des Cloudspeichers mit Azure Databricks.

Überprüfen eines externen Speicherorts und eines Anmeldeinformationspaars

Führen Sie databricks unity-catalog external-locations validate --help aus, um die Syntaxdokumentation anzuzeigen.

Überprüfen eines externen Speicherortnamens und eines Anmeldeinformationspaars, nachdem Sie sie erstellt haben

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

Ausgabe:

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

Aktualisieren der Einstellungen eines externen Speicherorts

Führen Sie databricks unity-catalog external-locations update --help aus, um die Syntaxdokumentation anzuzeigen.

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

Auflisten verfügbarer externer Speicherorte

Führen Sie databricks unity-catalog external-locations list --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog external-locations list

Abrufen von Informationen zu einem externen Speicherort

Führen Sie databricks unity-catalog external-locations get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Löschen eines externen Speicherorts

Führen Sie databricks unity-catalog external-locations delete --help aus, um die Syntaxdokumentation anzuzeigen.

Um den externen Speicherort erzwungen zu löschen, verwenden Sie die Option --force.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Kataloge

Verwenden Sie den Unterbefehl unity-catalog catalogs, um mit Katalogen zu arbeiten.

Führen Sie databricks unity-catalog catalogs --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen eines Katalogs

Führen Sie databricks unity-catalog catalogs create --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Erstellen von Katalogen.

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

Ausgabe:

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

Aktualisieren der Einstellungen eines Katalogs

Führen Sie databricks unity-catalog catalogs update --help aus, um die Syntaxdokumentation anzuzeigen.

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

update-catalog.json:

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

Ausgabe:

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

Auflisten verfügbarer Kataloge

Führen Sie databricks unity-catalog catalogs list --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog catalogs list

Ausgabe:

{
  "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"
    },
    {
      "...": "..."
    }
  ]
}

Abrufen von Informationen zu einem Katalog

Führen Sie databricks unity-catalog catalogs get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Ausgabe:

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

Löschen eines Katalogs

Führen Sie databricks unity-catalog catalogs delete --help aus, um die Syntaxdokumentation anzuzeigen. Informationen finden Sie auch unter Löschen eines Katalogs.

Um einen Katalog erzwungen zu löschen, verwenden Sie die Option --purge.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Schemas

Verwenden Sie den Unterbefehl unity-catalog schemas, um mit Schemas zu arbeiten.

Führen Sie databricks unity-catalog schemas --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen eines Schemas

Führen Sie databricks unity-catalog schemas create --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Erstellen von Schemas.

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

Ausgabe:

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

Ändern der Einstellungen eines Schemas

Führen Sie databricks unity-catalog schemas update --help aus, um die Syntaxdokumentation anzuzeigen.

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

Ausgabe:

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

Auflisten verfügbarer Schemas

Führen Sie databricks unity-catalog schemas list --help aus, um die Syntaxdokumentation anzuzeigen.

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

Ausgabe:

{
  "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"
    },
    {
      "...": "..."
    }
  ]
}

Abrufen von Informationen zu einem Schema

Führen Sie databricks unity-catalog schemas get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Ausgabe:

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

Löschen eines Schemas

Führen Sie databricks unity-catalog schemas delete --help aus, um die Syntaxdokumentation anzuzeigen. Informationen finden Sie auch unter Löschen eines Schemas.

Um eine Schema erzwungen zu löschen, verwenden Sie die Option --purge.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Tabellen

Verwenden Sie den Unterbefehl unity-catalog tables, um mit Tabellen zu arbeiten.

Hinweis

Das Erstellen von Tabellen mit der Unity Catalog-CLI wird nicht unterstützt. Informationen zum Erstellen von Tabellen finden Sie unter Was sind Tabellen und Ansichten? und Lernprogramm: Erstellen Sie Ihre erste Tabelle, und gewähren Sie Berechtigungen.

Führen Sie databricks unity-catalog tables --help aus, um die Syntaxdokumentation anzuzeigen.

Auflisten verfügbarer Tabellen

Führen Sie databricks unity-catalog tables list --help aus, um die Syntaxdokumentation anzuzeigen.

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

Auflisten von Zusammenfassungen verfügbarer Tabellen

Führen Sie databricks unity-catalog tables list-summaries --help aus, um die Syntaxdokumentation anzuzeigen.

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

Ausgabe:

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

Abrufen von Informationen zu einer Tabelle

Führen Sie databricks unity-catalog tables get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Löschen einer Tabelle

Führen Sie databricks unity-catalog tables delete --help aus, um die Syntaxdokumentation anzuzeigen.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Herkünfte

Verwenden Sie den Unterbefehl unity-catalog lineage, um mit Tabellen- und Spaltenherkünften zu arbeiten.

Führen Sie databricks unity-catalog lineage --help aus, um die Syntaxdokumentation anzuzeigen.

Auflisten der Herkunft einer Tabelle

Führen Sie databricks unity-catalog lineage table --help aus, um die Syntaxdokumentation anzuzeigen.

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

Auflisten der Herkunft einer Spalte

Führen Sie databricks unity-catalog lineage column --help aus, um die Syntaxdokumentation anzuzeigen.

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

Berechtigungen

Verwenden Sie den Unterbefehl unity-catalog permissions, um mit Berechtigungen für sicherungsfähige Objekte zu arbeiten. Siehe auch Verwalten von Berechtigungen im Unity-Katalog.

Führen Sie databricks unity-catalog permissions --help aus, um die Syntaxdokumentation anzuzeigen.

Abrufen von Informationen zu Berechtigungen für ein sicherungsfähiges Objekt

Führen Sie databricks unity-catalog permissions get --help aus, um die Syntaxdokumentation anzuzeigen. Siehe auch Unity-Katalogberechtigungen und sicherungsfähige Objekte.

Katalog

databricks unity-catalog permissions get --catalog main

Ausgabe:

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

Schema

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

Ausgabe:

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

Table

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

Ausgabe:

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

Speicheranmeldeinformationen

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

Ausgabe:

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

Externer Speicherort

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

Ausgabe:

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

Aktualisieren der Berechtigungen eines sicherungsfähigen Objekts

Führen Sie databricks unity-catalog permissions update --help aus, um die Syntaxdokumentation anzuzeigen. Siehe auch Unity-Katalogberechtigungen und sicherungsfähige Objekte.

Katalog

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

Schema

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

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

Speicheranmeldeinformationen

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

Externer Speicherort

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

Freigaben

Verwenden Sie den Unterbefehl unity-catalog shares, um mit Freigaben zu arbeiten, bei denen es sich um Objekte handelt, die Sammlungen von Tabellen in einem Delta Sharing-aktivierten Unity Catalog-Metastore enthalten, den Sie als Gruppe mit Delta Sharing-Empfängern freigeben möchten. Eine Freigabe kann Tabellen nur aus einem einzelnen Metastore enthalten. Weitere Informationen finden Sie unter Erstellen und Verwalten von Freigaben für Delta Sharing.

Führen Sie databricks unity-catalog shares --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen einer Freigabe

Führen Sie databricks unity-catalog shares create --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Erstellen und Verwalten von Freigaben für Delta Sharing.

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

Ausgabe:

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

Aktualisieren der Einstellungen einer Freigabe

Führen Sie databricks unity-catalog shares update --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie unter Aktualisieren von Freigaben.

Hinzufügen einer Tabelle zu einer Freigabe

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

Ausgabe:

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

Weitere Informationen finden Sie unter Hinzufügen von Tabellen zu einer Freigabe.

Entfernen einer Tabelle aus einer Freigabe

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

Ausgabe:

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

Weitere Informationen finden Sie unter Hinzufügen von Tabellen zu einer Freigabe.

Aktualisieren der Berechtigungen einer Freigabe

Führen Sie databricks unity-catalog shares update-permissions --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie außerdem unter Verwalten des Zugriffs auf Delta Sharing-Datenfreigaben (für Anbieter).

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

Auflisten der verfügbaren Freigaben

Führen Sie databricks unity-catalog shares list --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Anzeigen von Freigaben und Freigabedetails.

databricks unity-catalog shares list

Ausgabe:

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

Abrufen von Informationen zu einer Freigabe

Führen Sie databricks unity-catalog shares get --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Anzeigen von Freigaben und Freigabedetails.

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

Ausgabe:

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

Auflisten der Berechtigungen einer Freigabe

Führen Sie databricks unity-catalog shares list-permissions --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Anzeigen der Empfänger, die über Berechtigungen für eine Freigabe verfügen.

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

Ausgabe:

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

Löschen einer Freigabe

Führen Sie databricks unity-catalog shares delete --help aus, um die Syntaxdokumentation anzuzeigen. Informationen finden Sie auch unter Löschen einer Freigabe.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Empfänger

Verwenden Sie den Unterbefehl unity-catalog recipients, um mit Datenempfängern für Delta Sharing zu arbeiten, die Unity Catalog-Metastores aktiviert haben. Datenempfänger sind Personen oder Gruppen, mit denen ein Azure Databricks-Benutzer Daten außerhalb der Organisation von Azure Databricks teilt. Weitere Informationen finden Sie unter Erstellen und Verwalten von Datenempfängern für Delta Sharing.

Führen Sie databricks unity-catalog recipients --help aus, um die Syntaxdokumentation anzuzeigen.

Verwalten eines Empfängers

Führen Sie databricks unity-catalog recipients create --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Erstellen und Verwalten von Datenempfängern für Delta Sharing.

Führen Sie databricks unity-catalog recipients rotate-token zum Generieren einer neuen Aktivierungs-URL für einen Empfänger aus. Ein Beispiel finden Sie unter Drehen des Empfängertokens.

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

Ausgabe:

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

Ändern der Einstellungen eines Empfängers

Führen Sie databricks unity-catalog recipients update --help aus, um die Syntaxdokumentation anzuzeigen.

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

update-recipient-settings.json:

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

Ausgabe:

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

Drehen des Empfängertokens

Führen Sie databricks unity-catalog recipients rotate-token --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Verwalten von Empfängertoken (offene Freigabe).

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

Ausgabe:

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

Auflisten verfügbarer Empfänger

Führen Sie databricks unity-catalog recipients list --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Anzeigen von Empfängern.

databricks unity-catalog recipients list

Ausgabe:

{
  "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"
    }
  ]
}

Auflisten der Freigabeberechtigungen eines Empfängers

Führen Sie databricks unity-catalog recipients list-permissions --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Anzeigen der Freigabeberechtigungen eines Empfängers.

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

Ausgabe:

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

Abrufen von Informationen zu einem Empfänger

Führen Sie databricks unity-catalog recipients get --help aus, um die Syntaxdokumentation anzuzeigen. Weitere Informationen finden Sie auch unter Anzeigen von Empfängerdetails.

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

Ausgabe:

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

Löschen eines Empfängers

Führen Sie databricks unity-catalog recipients delete --help aus, um die Syntaxdokumentation anzuzeigen. Informationen finden Sie auch unter Löschen eines Empfängers.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.

Anbieter

Wenn Sie ein Delta Sharing-Empfänger für freigegebene Daten sind, können Sie den Unterbefehl unity-catalog providers verwenden, um mit Delta Sharing-Datenanbietern zu arbeiten. Weitere Informationen finden Sie unter Verwalten von Delta Sharing-Anbietern (für Datenempfänger).

Führen Sie databricks unity-catalog providers --help aus, um die Syntaxdokumentation anzuzeigen.

Erstellen eines Anbieters

Wenn Sie ein Empfänger von Daten sind, die mithilfe des Protokolls für offene Freigaben freigegeben wurden, und sie einen Databricks-Arbeitsbereich verwenden, der an einen Unity Catalog-Metastore angefügt ist, können Sie ein Anbieterobjekt in Ihrem Unity Catalog-Metastore erstellen. Anschließend können Sie den Zugriff auf die freigegebenen Daten mithilfe von Unity Catalog verwalten.

Wichtig

Dieses Szenario ist selten. Wenn Sie einen Databricks-Arbeitsbereich verwenden, der für Unity-Katalog aktiviert ist und ein anderer Databricks-Kunde Daten für Sie freigibt, sollte er bzw. sie die Databricks-to-Databricks-Freigabeverwenden. Mit der Datenbricks-zu-Databricks-Freigabe werden Anbieterobjekte für Sie im Unity-Katalog erstellt.

Um einen Anbieter zu erstellen, müssen Sie:

  • Ein Metastore-Administrator oder ein Benutzer mit der Berechtigung CREATE_PROVIDER für den Metastore sein.
  • Zugriff auf die heruntergeladene Anmeldeinformationsdatei haben. Weitere Informationen finden Sie unter Erhalten von Zugriff im Modell für offene Freigaben.

Führen Sie den folgenden Befehl aus, und ersetzen Sie my-provider durch den Namen, den Sie dem Anbieter geben möchten, und config.share durch den Pfad zur heruntergeladenen Anmeldeinformationsdatei, die standardmäßig den Namen „config.share“ aufweist.

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

Aktualisieren der Einstellungen eines Anbieters

Führen Sie databricks unity-catalog providers update --help aus, um die Syntaxdokumentation anzuzeigen.

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

Auflisten der verfügbaren Anbieter

Führen Sie databricks unity-catalog providers list --help aus, um die Syntaxdokumentation anzuzeigen.

databricks unity-catalog providers list

Abrufen von Informationen zu einem Anbieter

Führen Sie databricks unity-catalog providers get --help aus, um die Syntaxdokumentation anzuzeigen.

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

Auflisten der verfügbaren Freigaben eines Anbieters

Führen Sie databricks unity-catalog providers list-shares --help aus, um die Syntaxdokumentation anzuzeigen.

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

Löschen eines Anbieters

Führen Sie databricks unity-catalog providers delete --help aus, um die Syntaxdokumentation anzuzeigen.

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

Wenn der Vorgang erfolgreich ist, werden keine Ergebnisse zurückgegeben.