DESCRIBE POSTGRES INSTANCE¶

Beschreibt die Eigenschaften einer:doc:` Snowflake Postgres-Instanz </user-guide/snowflake-postgres/about>`.

Verwenden Sie diesen Befehl für Folgendes:

Überwachen des Status einer Instanz bei asynchronen Vorgängen wieALTER, CREATE oder FORK.
Abrufen von Verbindungsdetails, wie den Hostnamen.
Überprüfen von Konfigurationseinstellungen wie den Status der hohen Verfügbarkeit, die Postgres-Version und die kundenspezifischen Servereinstellungen.
Anzeigen des Felds origin, um geforkte Instanzen und deren Quelle zu identifizieren.

DESCRIBE kann mit DESC abgekürzt werden.

Siehe auch:: CREATE POSTGRES INSTANCE , ALTER POSTGRES INSTANCE, DROP POSTGRES INSTANCE , SHOW POSTGRES INSTANCES

Syntax¶

{ DESC | DESCRIBE } POSTGRES INSTANCE <name>

Copy

Parameter¶

name

Gibt den Bezeichner für die zu beschreibende Postgres-Instanz 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 Ausgabe des Befehls enthält die folgenden Spalten, die die Eigenschaften und Metadaten des Objekts beschreiben:

Der Befehl gibt Ergebnisse in einem Eigenschafts-/Wertformat und nicht in einer spaltenweisen Ausgabe zurück. Jede Eigenschaft wird als separate Zeile mit dem entsprechenden Wert angezeigt.

Eigenschaft	Beschreibung
`name`	Name der Postgres-Instanz.
`owner`	Rolle, der die Postgres-Instanz gehört.
`owner_role_type`	Typ der Eigentümerrolle (zum Beispiel ROLE oder DATABASE_ROLE).
`created_on`	Datum und Uhrzeit der Erstellung der Postgres-Instanz.
`updated_on`	Datum und Uhrzeit der letzten Aktualisierung der Postgres-Instanz.
`type`	Typ der Postgres-Instanz (zum Beispiel PRIMARY).
`host`	Hostname, der für die Verbindung mit der Postgres-Instanz verwendet wird.
`privatelink_service_identifier`	Bezeichner für den Private Link-Dienst, wenn Private Link für die Instanz konfiguriert ist.
`compute_family`	Computefamilie (Instanzgröße) der Postgres-Instanz.
`storage_size_gb`	Speichergröße, die der Postgres-Instanz zugewiesen ist, in GB.
`postgres_version`	Hauptversion von Postgres, die auf der Instanz ausgeführt wird.
`postgres_settings`	Kundenspezifische Postgres-Servereinstellungen, die für die Instanz konfiguriert sind.
`high_availability`	Ob Hochverfügbarkeit für die Instanz aktiviert ist (`true` oder `false`).
`authentication_authority`	Für die Instanz verwendete Authentifizierungsmethode (derzeit `POSTGRES`).
`maintenance_window_start`	Stunde des Tages (0-23, UTC), zu der ein Wartungsfenster beginnen kann; oder``None``, falls nicht festgelegt.
`state`	Aktueller Status der Instanz. Mögliche Werte: `CREATING`, `RESTORING`, `STARTING`, `REPLAYING`, `FINALIZING`, `READY`, `RESTARTING`, `RESUMING`, `SUSPENDING`, `SUSPENDED`.
`comment`	Kommentar zur Postgres-Instanz; oder``None``, falls nicht festgelegt.
`origin`	Ursprung der Postgres-Instanz (z. B. wenn sie von einer anderen Instanz geforkt wurde); oder `None`, wenn es sich nicht um eine Fork handelt.
`replicas`	Liste von Lesereplikaten, die der Instanz zugeordnet sind.
`operations`	Ausstehende oder laufende Vorgänge auf der Instanz (z. B. Größenänderung, Upgrade, HA-Aktivierung).
`network_policy`	Netzwerkrichtlinie, die an die Instanz angehängt ist; oder `None`, falls nicht festgelegt.
`storage_integration`	Von der Instanz verwendete Speicherintegration; oder `None`, falls nicht festgelegt.
`certificate`	SSL-Zertifikat für sichere Verbindungen zur Postgres-Instanz.

Anforderungen an die Zugriffssteuerung¶

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

Berechtigung	Objekt	Anmerkungen
OPERATE oder OWNERSHIP	Postgres-Instanz

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.

Verwenden Sie diesen Befehl, um den Status einer Instanz bei Erstellen, Ändern oder anderen asynchronen Vorgängen zu überprüfen. Das Feld operations ist eineJSON-Zeichenfolge, die die Sequenz von Vorgängen während eines CREATEPOSTGRESINSTANCE- oder ALTERPOSTGRESINSTANCE-Vorgangs darstellt. Sie können darauf warten, dass das Feld operations leer wird oder dass eine der Aufgaben den Wert ready aufweist. Im Folgenden sehen Sie ein Beispiel für den Wert des Felds operations gegen Ende eines ALTERPOSTGRESINSTANCE-Vorgangs zum Ändern derCOMPUTE_FAMILY-Einstellung.

 {
   "upgrade" : {
     "state" : "UPGRADING",
     "start" : "2026-02-16 14:13:58.371 -0800",
     "duration" : "3m36s",
     "compute_family" : "BURST_M",
     "tasks" : [ {
       "flavor" : "resize",
       "state" : "creating"
     }, {
       "flavor" : "resize",
       "state" : "finalizing"
     }, {
       "flavor" : "resize",
       "state" : "ready"
     } ]
   }
}

Beispiele¶

Beschreiben einer Postgres-Instanz:

DESCRIBE POSTGRES INSTANCE my_postgres;

Copy

Im Folgenden sehen Sie eine typische Ausgabe für diesen Befehl:

+------------------------------------------------------------------------+
| property                       | value                                 |
|--------------------------------+---------------------------------------|
| name                           | MY_TEST_INSTANCE                      |
| owner                          | ACCOUNTADMIN                          |
| owner_role_type                | ROLE                                  |
| created_on                     | 2026-01-29 10:04:59.485 -0800         |
| updated_on                     | 2026-02-16 13:21:58.018 -0800         |
| type                           | PRIMARY                               |
| host                           | my-instance-hostname.us-west-2.aws    |
|                                | .postgres.snowflake.pp                |
| privatelink_service_identifier | None                                  |
| compute_family                 | BURST_S                               |
| storage_size_gb                | 10                                    |
| postgres_version               | 18                                    |
| postgres_settings              | {}                                    |
| high_availability              | false                                 |
| authentication_authority       | POSTGRES                              |
| maintenance_window_start       | None                                  |
| state                          | READY                                 |
| comment                        | None                                  |
| origin                         | None                                  |
| replicas                       |                                       |
| operations                     | { }                                   |
| network_policy                 | None                                  |
| storage_integration            | None                                  |
| certificate                    | -----BEGIN CERTIFICATE-----           |
|                                | ... several lines of certificate ...  |
|                                | -----END CERTIFICATE-----             |
|                                |                                       |
+------------------------------------------------------------------------+

Verwenden von SHOW mit dem:doc:Flow-Operator </sql-reference/operators-flow>, um eine Instanz zu finden und anschließend zu beschreiben:

-- Find instances in a specific state
SHOW POSTGRES INSTANCES
  ->> SELECT "name", "state", "postgres_version"
      FROM $1
      WHERE "state" = 'READY' AND "postgres_version" = '17';

-- Then describe a specific instance for full details
DESCRIBE POSTGRES INSTANCE my_postgres;

Copy

Verwenden des Flow-Operators, um bestimmte Eigenschaften zu extrahieren:

DESCRIBE POSTGRES INSTANCE my_postgres
  ->> SELECT "property", "value"
      FROM $1
      WHERE "property" IN ('name', 'state', 'host',
        'postgres_version', 'high_availability');

Copy

Überprüfen des Hostnamens der Verbindung für eine Instanz:

DESCRIBE POSTGRES INSTANCE my_postgres
  ->> SELECT "value" AS hostname
      FROM $1
      WHERE "property" = 'host';

Copy