DESCRIBE POSTGRES INSTANCE¶

Décrit les propriétés d’une instance Snowflake Postgres.

Utilisez cette commande pour :

Surveillez l’:ref:` état <instance-states>` d’une instance lors d’opérations asynchrones telles que ALTER, CREATE ou FORK.
Récupérez les détails de la connexion, comme le nom d’hôte.
Vérifiez les paramètres de configuration tels que l’état de haute disponibilité, la version Postgres et les paramètres de serveur personnalisés.
Affichez le champ origin pour identifier les instances forkées et leur source.

DESCRIBE peut être abrégé en DESC.

Voir aussi :: CREATE POSTGRES INSTANCE , ALTER POSTGRES INSTANCE, DROP POSTGRES INSTANCE , SHOW POSTGRES INSTANCES

Syntaxe¶

{ DESC | DESCRIBE } POSTGRES INSTANCE <name>

Copy

Paramètres¶

name

Spécifie l’identificateur de l’instance Postgres à décrire.

Si l’identificateur contient des espaces ou des caractères spéciaux, toute la chaîne doit être délimitée par des guillemets doubles. Les identificateurs entre guillemets doubles sont également sensibles à la casse.

Pour plus d’informations, voir Exigences relatives à l’identificateur.

Sortie¶

La sortie de la commande comprend les colonnes suivantes, qui décrivent les propriétés et les métadonnées de l’objet :

La commande renvoie les résultats dans un format propriété/valeur plutôt que dans une sortie sous forme de colonnes. Chaque propriété apparaît comme une ligne séparée avec sa valeur correspondante.

Propriété	Description
`name`	Nom de l’instance Postgres.
`owner`	Rôle qui possède l’instance Postgres.
`owner_role_type`	Type de rôle de propriétaire (par exemple, ROLE ou DATABASE_ROLE).
`created_on`	Date et heure de création de l’instance Postgres.
`updated_on`	Date et heure de la dernière mise à jour de l’instance Postgres.
`type`	Type de l’instance Postgres (par exemple, PRIMARY).
`host`	Nom d’hôte utilisé pour se connecter à l’instance Postgres.
`privatelink_service_identifier`	Identificateur du service Private Link, si Private Link est configuré pour l’instance.
`compute_family`	Famille de calcul (taille de l’instance) de l’instance Postgres.
`storage_size_gb`	Taille de stockage allouée à l’instance Postgres, en GB.
`postgres_version`	Version principale de Postgres exécutée sur l’instance.
`postgres_settings`	Paramètres du serveur Postgres personnalisés configurés pour l’instance.
`high_availability`	Indique si la haute disponibilité est activée pour l’instance (`true` ou `false`).
`authentication_authority`	Méthode d’authentification utilisée pour l’instance (actuellement `POSTGRES`).
`maintenance_window_start`	Heure de la journée (0-23, UTC) lorsqu’une fenêtre de maintenance peut commencer, ou `None` si elle n’est pas définie.
`state`	État actuel de l’instance. Valeurs possibles : `CREATING`, `RESTORING`, `STARTING`, `REPLAYING`, `FINALIZING`, `READY`, `RESTARTING`, `RESUMING`, `SUSPENDING`, `SUSPENDED`.
`comment`	Commentaire pour l’instance Postgres, ou `None` s’il n’est pas défini.
`origin`	Origine de l’instance Postgres (par exemple, si forkée depuis une autre instance), ou `None` s’il n’y a pas de fork.
`replicas`	Liste des répliques de lecture associées à l’instance.
`operations`	Opérations en attente ou en cours sur l’instance (par exemple, redimensionnement, mise à niveau, activation de la HA).
`network_policy`	Politique réseau attachée à l’instance, ou `None` si elle n’est pas définie.
`storage_integration`	Intégration de stockage utilisée par l’instance, ou `None` si elle n’est pas définie.
`certificate`	Certificat SSL pour des connexions sécurisées à l’instance Postgres.

Exigences en matière de contrôle d’accès¶

Un rôle utilisé pour exécuter cette opération doit au minimum disposer des privilèges suivants :

Privilège	Objet	Remarques
OPERATE ou OWNERSHIP	Instance Postgres

Pour obtenir des instructions sur la création d’un rôle personnalisé avec un ensemble spécifique de privilèges, voir Création de rôles personnalisés.

Pour des informations générales sur les rôles et les privilèges accordés pour effectuer des actions SQL sur des objets sécurisables, voir Aperçu du contrôle d’accès.

Notes sur l’utilisation¶

Pour post-traiter la sortie de cette commande, vous pouvez utiliser l’opérateur de canal (->>) ou la fonction RESULT_SCAN. Les deux constructions traitent la sortie comme un jeu de résultats que vous pouvez interroger.

Par exemple, vous pouvez utiliser l’opérateur de canal ou la fonction RESULT_SCAN pour sélectionner des colonnes spécifiques à partir de la sortie de la commande SHOW ou pour filtrer les lignes.

Lorsque vous faites référence aux colonnes de sortie, utilisez des identificateurs entre guillemets doubles pour les noms des colonnes. Par exemple, pour sélectionner la colonne de sortie type, spécifiez SELECT "type".

Vous devez utiliser des identificateurs entre guillemets doubles, car les noms des colonnes de sortie pour les commandes SHOW sont en minuscules. Les guillemets doubles garantissent que les noms des colonnes dans la liste SELECT ou dans la clause WHERE correspondent aux noms des colonnes dans la sortie de la commande SHOW qui a été analysée.

Utilisez cette commande pour vérifier si l’état d’une instance lors de la création, de la modification ou d’autres opérations asynchrones. Le champ operations est une chaîne JSON qui reflète la séquence des opérations qui se produit au cours d’une opération CREATE POSTGRES INSTANCE ou ALTER POSTGRES INSTANCE. Vous pouvez attendre que le champ operations devienne vide, ou que l’une des tâches affiche la valeur ready. Le tableau suivant montre un exemple de valeur du champ operations vers la fin d’une opération ALTER POSTGRES INSTANCE pour modifier le paramètre COMPUTE_FAMILY.

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

Exemples¶

Décrivez une instance Postgres :

DESCRIBE POSTGRES INSTANCE my_postgres;

Copy

Ci-dessous figure une sortie typique de cette commande :

+------------------------------------------------------------------------+
| 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-----             |
|                                |                                       |
+------------------------------------------------------------------------+

Utilisez SHOW avec l’:doc:` opérateur de flux </sql-reference/operators-flow>` pour trouver une instance, puis décrivez-la :

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

Utilisez l’opérateur de flux pour extraire des propriétés spécifiques :

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

Copy

Vérifiez le nom d’hôte de connexion d’une instance :

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

Copy