external-metadata Befehlsgruppe

Hinweis

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Die external-metadata Befehlsgruppe innerhalb der Databricks CLI enthält Befehle zum Registrieren und Verwalten von Metadaten zu externen Systemen im Unity-Katalog.

databricks external-metadata create-external-metadata

Erstellen Sie ein neues externes Metadatenobjekt im übergeordneten Metastore, wenn der Aufrufer ein Metastore-Administrator ist oder über die CREATE_EXTERNAL_METADATA Berechtigung verfügt. Gewährt browsen allen Kontobenutzern bei der Erstellung standardmäßig.

databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]

Argumente

NAME

    Name des externen Metadatenobjekts.

SYSTEM_TYPE

    Typ des externen Systems. Unterstützte Werte: AMAZON_REDSHIFT, , AZURE_SYNAPSE, DATABRICKSCONFLUENT, GOOGLE_BIGQUERY, KAFKA, , LOOKER, MICROSOFT_SQL_SERVERORACLEOTHERMYSQLMONGODBMICROSOFT_FABRIC, SALESFORCESAPSERVICENOWPOWER_BIPOSTGRESQLSTREAM_NATIVETABLEAUSNOWFLAKETERADATA. . . WORKDAY

ENTITY_TYPE

    Entitätstyp innerhalb des externen Systems.

Options

--description string

    Vom Benutzer bereitgestellte Freiformtextbeschreibung.

--json JSON

    Die Inline-JSON-Zeichenfolge oder der @path zur JSON-Datei mit dem Anforderungstext

--owner string

    Besitzer des externen Metadatenobjekts.

--url string

    DIE URL, die dem externen Metadatenobjekt zugeordnet ist.

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird ein externes Metadatenobjekt für eine Snowflake-Tabelle erstellt:

databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"

Im folgenden Beispiel wird ein externes Metadatenobjekt mit JSON erstellt:

databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'

Im folgenden Beispiel wird ein externes Metadatenobjekt mithilfe einer JSON-Datei erstellt:

databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json

databricks external-metadata delete-external-metadata

Löschen Sie das externe Metadatenobjekt, das dem angegebenen Namen entspricht. Der Aufrufer muss ein Metastoreadministrator, der Besitzer des externen Metadatenobjekts oder ein Benutzer sein, der über die BERECHTIGUNG MANAGE verfügt.

databricks external-metadata delete-external-metadata NAME [flags]

Argumente

NAME

    Name des zu löschenden externen Metadatenobjekts.

Options

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird ein externes Metadatenobjekt gelöscht:

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

Rufen Sie das angegebene externe Metadatenobjekt in einem Metaspeicher ab. Der Aufrufer muss ein Metastoreadministrator, der Besitzer des externen Metadatenobjekts oder ein Benutzer sein, der über die BROWSE-Berechtigung verfügt.

databricks external-metadata get-external-metadata NAME [flags]

Argumente

NAME

    Name des abzurufenden externen Metadatenobjekts.

Options

Globale Kennzeichnungen

Beispiele

Das folgende Beispiel ruft ein externes Metadatenobjekt ab:

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

Auflisten externer Metadatenobjekte im Metaspeicher. Wenn der Aufrufer der Metastore-Administrator ist, werden alle externen Metadatenobjekte abgerufen. Andernfalls werden nur externe Metadatenobjekte abgerufen, für die der Aufrufer BROWSE aktiviert hat. Es gibt keine Garantie für eine bestimmte Reihenfolge der Elemente im Array.

databricks external-metadata list-external-metadata [flags]

Options

--page-size int

    Maximale Anzahl externer Metadatenobjekte, die pro Seite zurückgegeben werden sollen.

--page-token string

    Token zum Abrufen der nächsten Seite der Ergebnisse.

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel werden alle externen Metadatenobjekte aufgelistet:

databricks external-metadata list-external-metadata

Im folgenden Beispiel werden externe Metadatenobjekte mit Paginierung aufgelistet:

databricks external-metadata list-external-metadata --page-size 10

databricks external-metadata update-external-metadata

Aktualisieren Sie das externe Metadatenobjekt, das dem angegebenen Namen entspricht. Der Aufrufer kann nur den Besitzer oder andere Metadatenfelder in einer Anforderung aktualisieren. Der Aufrufer muss ein Metastoreadministrator, der Besitzer des externen Metadatenobjekts oder ein Benutzer sein, der über die MODIFY-Berechtigung verfügt. Wenn der Anrufer den Besitzer aktualisiert, muss er auch über die BERECHTIGUNG MANAGE verfügen.

databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]

Argumente

NAME

    Name des externen Metadatenobjekts.

UPDATE_MASK

    Das Feldformat muss eine einzelne Zeichenfolge sein, wobei mehrere Felder durch Kommas getrennt sind (keine Leerzeichen). Der Feldpfad ist relativ zum Ressourcenobjekt, wobei ein Punkt (.) zum Navigieren zwischen Unterfeldern (z. B author.given_name. ) verwendet wird. Die Angabe von Elementen in Sequenz- oder Zuordnungsfeldern ist nicht zulässig, da nur das gesamte Sammlungsfeld angegeben werden kann. Feldnamen müssen exakt mit den Ressourcenfeldnamen übereinstimmen.

    Ein Sternchen-*-Feldmaske gibt den vollständigen Ersatz an. Es wird empfohlen, die zu aktualisierenden Felder immer explizit auflisten und die Verwendung von Wildcards zu vermeiden, da sie zu unbeabsichtigten Ergebnissen führen kann, wenn sich die API in zukunft ändert.

SYSTEM_TYPE

    Typ des externen Systems. Unterstützte Werte: AMAZON_REDSHIFT, , AZURE_SYNAPSE, DATABRICKSCONFLUENT, GOOGLE_BIGQUERY, KAFKA, , LOOKER, MICROSOFT_SQL_SERVERORACLEOTHERMYSQLMONGODBMICROSOFT_FABRIC, SALESFORCESAPSERVICENOWPOWER_BIPOSTGRESQLSTREAM_NATIVETABLEAUSNOWFLAKETERADATA. . . WORKDAY

ENTITY_TYPE

    Entitätstyp innerhalb des externen Systems.

Options

--description string

    Vom Benutzer bereitgestellte Freiformtextbeschreibung.

--json JSON

    Die Inline-JSON-Zeichenfolge oder der @path zur JSON-Datei mit dem Anforderungstext

--owner string

    Besitzer des externen Metadatenobjekts.

--url string

    DIE URL, die dem externen Metadatenobjekt zugeordnet ist.

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird die Beschreibung eines externen Metadatenobjekts aktualisiert:

databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"

Im folgenden Beispiel wird der Besitzer eines externen Metadatenobjekts aktualisiert:

databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"

Im folgenden Beispiel wird ein externes Metadatenobjekt mithilfe von JSON aktualisiert:

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

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel