DESCRIBE-GATEWAY

Beschreibt die Eigenschaften eines Gateways.

DESCRIBE kann mit DESC abgekürzt werden.

Siehe auch:

CREATE-GATEWAY , ALTER-GATEWAY, DROP-GATEWAY , SHOW-GATEWAYS

Syntax

DESC[RIBE] GATEWAY <name>
Copy

Parameter

name

Gibt den Bezeichner für das zu beschreibende Gateway an.

Wenn der Bezeichner Leerzeichen oder Sonderzeichen enthält, muss die gesamte Zeichenfolge in doppelte Anführungszeichen gesetzt werden. Bei Bezeichnern, die in doppelte Anführungszeichen eingeschlossen sind, ist auch die Groß- und Kleinschreibung zu beachten.

Weitere Informationen dazu finden Sie unter Anforderungen an Bezeichner.

Ausgabe

Die Befehlsausgabe stellt Gateway-Eigenschaften und -Metadaten in den folgenden Spalten bereit:

Spalte

Beschreibung

name

Gateway-Name.

ingress_url

Gateway-Eingangs-URL.

privatelink_ingress_url

PrivateLink-Eingangs-URL.

database_name

Datenbank, in der das Gateway erstellt wird.

schema_name

Schema, in dem das Gateway erstellt wird.

owner

Rolle, die Eigentümer des Gateway ist.

owner_role_type

Typ der Rolle, die Eigentümer des Objekts ist, entweder ROLE oder DATABASE_ROLE.

spec

Gateway-Spezifikation (YAML-Format). Diese Spalte wird nur angezeigt, wenn die Rolle, die den Befehl ausführt, über die Berechtigung USAGE, MODIFYoder OWNERSHIP für das Gateway verfügt.

created_on

Zeitstempel, wann das Gateway erstellt wurde.

updated_on

Zeitstempel, wann das Gateway zuletzt aktualisiert wurde.

comment

Kommentar zum Gateway.

Bemerkung

Wenn die verwendete Rolle die Berechtigung USAGE, MODIFYoder OWNERSHIP für das Gateway hat, wird die spec-Spalte angezeigt. Wenn nicht, werden die anderen Spalten angezeigt, aber nicht die spec-Spalte.

Anforderungen an die Zugriffssteuerung

Eine Rolle, die zur Ausführung dieser Operation verwendet wird, muss mindestens die folgenden Berechtigungen haben:

Berechtigung

Objekt

Anmerkungen

USAGE, MODIFY oder OWNERSHIP

Gateway

Jede dieser Berechtigungen lässt eine Beschreibung des Gateways zu. Nur Rollen mit diesen Berechtigungen können die Spezifikation anzeigen.

USAGE

Datenbank

Erforderlich für die Datenbank, die das Gateway enthält.

USAGE

Schema

Erforderlich für das Schema, das das Gateway enthält.

Eine Anleitung zum Erstellen einer kundenspezifischen Rolle mit einer bestimmten Gruppe von Berechtigungen finden Sie unter Erstellen von kundenspezifischen Rollen.

Allgemeine Informationen zu Rollen und Berechtigungen zur Durchführung von SQL-Aktionen auf sicherungsfähigen Objekten finden Sie unter Übersicht zur Zugriffssteuerung.

Nutzungshinweise

  • Um die Ausgabe dieses Befehls nachzubearbeiten, können Sie den Befehl Pipe-Operator (->>) oder die RESULT_SCAN-Funktion verwenden. Beide Konstrukte behandeln die Ausgabe als Resultset, das Sie abfragen können.

    Sie können zum Beispiel den Pipe-Operator oder die RESULT_SCAN-Funktion verwenden, um bestimmte Spalten aus der SHOW-Befehlsausgabe auszuwählen oder die Zeilen zu filtern.

    Wenn Sie sich auf die Ausgabespalten beziehen, verwenden Sie Bezeichner mit doppelten Anführungszeichen für die Spaltennamen. Um beispielsweise die Ausgabespalte type auszuwählen, geben Sie SELECT "type" an.

    Sie müssen Bezeichner in doppelten Anführungszeichen verwenden, da die Ausgabespaltennamen für SHOW-Befehle in Kleinbuchstaben geschrieben sind. Die doppelten Anführungszeichen stellen sicher, dass die Spaltennamen in der SELECT-Liste oder WHERE-Klausel den Spaltennamen in der SHOW-Befehlsausgabe entsprechen, die gescannt wurde.

Beispiele

Das folgende Beispiel beschreibt das Gateway mit dem Namen split_gateway:

DESCRIBE GATEWAY split_gateway;
Copy