DESCRIBE POSTGRES INSTANCE¶

Descreve as propriedades de uma instância Snowflake Postgres.

Use esse comando para:

Monitorar o estado de uma instância durante operações assíncronas como ALTER, CREATE ou FORK.
Recuperar detalhes da conexão, como o nome do host.
Verificar configurações como status de alta disponibilidade, versão do Postgres e configurações de servidor personalizadas.
Exibir o campo origin para identificar instâncias bifurcadas e sua origem.

DESCRIBE pode ser abreviado como DESC.

Consulte também:: CREATE POSTGRES INSTANCE, ALTER POSTGRES INSTANCE, DROP POSTGRES INSTANCE, SHOW POSTGRES INSTANCES

Sintaxe¶

{ DESC | DESCRIBE } POSTGRES INSTANCE <name>

Copy

Parâmetros¶

name

Especifica o identificador da instância Postgres a ser descrita.

Se o identificador contiver espaços ou caracteres especiais, toda a cadeia de caracteres deverá ser delimitada por aspas duplas. Os identificadores delimitados por aspas duplas também diferenciam letras maiúsculas de minúsculas.

Para obter mais informações, consulte Requisitos para identificadores.

Saída¶

A saída do comando inclui as seguintes colunas, que descrevem as propriedades e metadados do objeto:

O comando retorna resultados no formato de propriedade/valor em vez de uma saída colunar. Cada propriedade aparece como uma linha separada com o valor correspondente.

Propriedade	Descrição
`name`	Nome da instância Postgres.
`owner`	Função proprietária da instância Postgres.
`owner_role_type`	Tipo da função de proprietário (por exemplo, ROLE ou DATABASE_ROLE).
`created_on`	Data e hora de criação da instância Postgres.
`updated_on`	Data e hora em que a instância Postgres foi atualizada pela última vez.
`type`	Tipo de instância Postgres (por exemplo, PRIMARY).
`host`	Nome do host usado para se conectar à instância Postgres.
`privatelink_service_identifier`	Identificador do serviço Private Link, se o Private Link estiver configurado para a instância.
`compute_family`	Família de computação (tamanho da instância) da instância Postgres.
`storage_size_gb`	Tamanho de armazenamento alocado para a instância Postgres, em GB.
`postgres_version`	Versão principal do Postgres em execução na instância.
`postgres_settings`	Configurações do servidor Postgres personalizadas configuradas para a instância.
`high_availability`	Indica se a alta disponibilidade está habilitada para a instância (`true` ou `false`).
`authentication_authority`	Método de autenticação usado para a instância (atualmente``POSTGRES``).
`maintenance_window_start`	Hora do dia (0-23, UTC) quando uma janela de manutenção pode começar, ou `None` se não estiver definida.
`state`	Estado atual da instância. Valores possíveis: `CREATING`, `RESTORING`, `STARTING`, `REPLAYING`, `FINALIZING`, `READY`, `RESTARTING`, `RESUMING`, `SUSPENDING`, `SUSPENDED`.
`comment`	Comentário para a instância Postgres ou `None` se não estiver definida.
`origin`	Origem da instância Postgres (por exemplo, se for derivada de outra instância), ou `None` se não for uma derivação.
`replicas`	Lista de réplicas de leitura associadas à instância.
`operations`	Operações pendentes ou em andamento na instância (por exemplo, redimensionar, atualizar, habilitação de HA).
`network_policy`	Política de redes anexada à instância ou `None` se não estiver definida.
`storage_integration`	Integração de armazenamento usada pela instância ou `None` se não estiver definida.
`certificate`	Certificado SSL para conexões seguras com a instância Postgres.

Requisitos de controle de acesso¶

A função usada para executar essa operação deve ter, no mínimo, os seguintes privilégios:

Privilégio	Objeto	Notas
OPERATE ou OWNERSHIP	Instância Postgres

Para instruções sobre como criar uma função personalizada com um conjunto específico de privilégios, consulte Criação de funções personalizadas.

Para informações gerais sobre concessões de funções e privilégios para executar ações de SQL em objetos protegíveis, consulte Visão geral do controle de acesso.

Notas de uso¶

Para pós-processar a saída deste comando, você pode usar o operador de canal (->>) ou a função RESULT_SCAN. Ambos os constructos tratam a saída como um conjunto de resultados que você pode consultar.

Por exemplo, é possível usar o operador de canal ou a função RESULT_SCAN para selecionar colunas específicas da saída do comando SHOW ou filtrar as linhas.

Quando você fizer referência a colunas de saída, use identificadores entre aspas duplas para os nomes das colunas. Por exemplo, para selecionar a coluna de saída type, especifique SELECT "type".

Você deve usar identificadores entre aspas duplas porque os nomes das colunas de saída para os comandos SHOW estão em minúsculas. As aspas duplas garantem que os nomes das colunas na lista SELECT ou na cláusula WHERE correspondam aos nomes das colunas na saída do comando SHOW que foi verificada.

Use esse comando para verificar o estado de uma instância durante a criação, modificação ou outras operações assíncronas. O campo operations é uma string JSON que reflete qualquer sequência de operações que acontece durante uma operação CREATE POSTGRES INSTANCE ou ALTER POSTGRES INSTANCE. Você pode esperar o campo operations ficar vazio, ou que uma das tarefas tenha o valor ready. A seguir mostramos um exemplo de valor do campo operations próximo ao final de uma operação ALTER POSTGRES INSTANCE para mudar a configuração de 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"
     } ]
   }
}

Exemplos¶

Descreva uma instância Postgres:

DESCRIBE POSTGRES INSTANCE my_postgres;

Copy

A saída típica desse comando é mostrada a seguir:

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

Use SHOW com o operador de fluxo para encontrar uma instância, depois descreva-a:

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

Use o operador de fluxo para extrair propriedades específicas:

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

Copy

Verifique o nome do host da conexão de uma instância:

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

Copy