DESCRIBE POSTGRES INSTANCE

:doc:`Snowflake Postgresインスタンス</user-guide/snowflake-postgres/about>`のプロパティについて記述します。

このコマンドを使用して次を実行します。

  • ALTER、CREATE、FORKといった非同期操作中のインスタンスの:ref:`状態<instance-states>`をモニターします。

  • ホスト名などの接続の詳細を取得します。

  • 高可用性ステータス、Postgresのバージョン、カスタムサーバー設定などの構成設定を確認します。

  • ``origin``フィールドを表示してフォークされたインスタンスとそのソースを識別します。

DESCRIBE は DESC に短縮できます。

こちらもご参照ください。

CREATE POSTGRES INSTANCEALTER POSTGRES INSTANCEDROP POSTGRES INSTANCESHOW POSTGRES INSTANCES

構文

{ DESC | DESCRIBE } POSTGRES INSTANCE <name>
Copy

パラメーター

name

記述するPostgresインスタンスの識別子を指定します。

識別子にスペースまたは特殊文字が含まれる場合は、文字列全体を二重引用符で囲む必要があります。二重引用符で囲まれた識別子も大文字と小文字が区別されます。

詳細については、 識別子の要件 をご参照ください。

出力

コマンドの出力には、オブジェクトのプロパティとメタデータを説明する以下の列が含まれます。

このコマンドは、列指向出力ではなく、プロパティ/値形式で結果を返します。各プロパティは、対応する値を持つ個別の行として表示されます。

プロパティ

説明

name

Postgresインスタンスの名前。

owner

Postgresインスタンスを所有するロール。

owner_role_type

所有者ロールのタイプ(例:ROLEまたはDATABASE_ROLE)。

created_on

Postgresインスタンスが作成された日時。

updated_on

Postgresインスタンスが最後に更新された日時。

type

Postgresインスタンスのタイプ(例:PRIMARY)。

host

Postgresインスタンスへの接続に使用するホスト名。

privatelink_service_identifier

インスタンスに対してPrivate Linkが構成されている場合は、:doc:`Private Linkサービス</user-guide/admin-security-privatelink>`の識別子。

compute_family

Postgresインスタンスの:doc:`コンピュートファミリー</user-guide/snowflake-postgres/postgres-instance-sizes>`(インスタンスサイズ)。

storage_size_gb

Postgresインスタンスに割り当てられたストレージサイズ(GB)。

postgres_version

インスタンスで実行されているPostgresのメジャーバージョン。

postgres_settings

インスタンスに構成されているカスタム:doc:Postgresサーバー設定</user-guide/snowflake-postgres/postgres-server-settings>

high_availability

インスタンスで:doc:高可用性</user-guide/snowflake-postgres/high-availability>`が有効化されているかどうか(``true``または``false`)。

authentication_authority

インスタンスに使用される認証方法(現在は``POSTGRES``)。

maintenance_window_start

メンテナンスウィンドウ</user-guide/snowflake-postgres/managing-instances>`を開始できる時間帯(0-23、UTC)。設定されていない場合は``None`

state

インスタンスの現在の:ref:状態<instance-states>。可能な値:CREATINGRESTORINGSTARTINGREPLAYINGFINALIZINGREADYRESTARTINGRESUMINGSUSPENDINGSUSPENDED

comment

Postgresインスタンスのコメント。設定されていない場合は``None``。

origin

Postgresインスタンスの基点(例:別のインスタンスからフォークされた場合)。フォークでない場合は``None``。

replicas

そのインスタンスに関連付けられた:doc:`リードレプリカ</user-guide/snowflake-postgres/postgres-create-replica>`のリスト。

operations

そのインスタンス上で保留中または進行中の操作(例:サイズ変更、アップグレード、HA有効化)。

network_policy

インスタンスにアタッチされた:doc:ネットワークポリシー</user-guide/snowflake-postgres/postgres-network>。設定されていない場合は``None``。

storage_integration

インスタンスが使用するストレージ統合。設定されていない場合は``None``。

certificate

Postgresインスタンスに安全に接続するための:doc:SSL証明書</user-guide/snowflake-postgres/postgres-ssl-certs>

アクセス制御の要件

この操作の実行に使用される ロール には、少なくとも次の 権限 が必要です。

権限

オブジェクト

メモ

OPERATE または OWNERSHIP

Postgresインスタンス

指定された権限のセットを使用してカスタムロールを作成する手順については、 カスタムロールの作成 をご参照ください。

セキュリティ保護可能なオブジェクト に対して SQL アクションを実行するためのロールと権限付与に関する一般的な情報については、 アクセス制御の概要 をご参照ください。

使用上の注意

  • このコマンドの出力を後処理するには、 パイプ演算子->>)または RESULT_SCAN 関数。どちらのコンストラクトも、出力を クエリできる結果セットとして扱います。

    たとえば、パイプ演算子または RESULT_SCAN 関数を使用して、 SHOW コマンド出力から特定の列を選択したり、行をフィルター処理したりできます。

    出力列を参照する場合は、列名に:ref:二重引用符<label-delimited_identifier>`で囲まれた識別子を使用します。たとえば、出力列 ``type` を選択するには、 SELECT "type" を指定します。

    SHOW コマンドの出力列名は小文字のため、二重引用符で囲まれた識別子を使用する必要があります。二重引用符により、 SELECT リストまたは WHERE 句内の列名が、スキャンされた SHOW コマンド出力内の列名と一致することが保証されます。

  • 作成中、変更中、またはその他の非同期操作中にインスタンスの:ref:`状態<instance-states>`を確認するには、このコマンドを使用します。``operations``フィールドは、CREATE POSTGRES INSTANCEまたはALTER POSTGRES INSTANCEの操作中に発生する操作シーケンスを反映するJSON文字列です。``operations``フィールドが空になるか、タスクのいずれかが``ready``という値になるのを待つことができます。次に示すのは、COMPUTE_FAMILY設定を変更するALTER POSTGRES INSTANCE操作の終了近くにおける``operations``フィールドの値の例です。

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

Postgresインスタンスを記述します。

DESCRIBE POSTGRES INSTANCE my_postgres;
Copy

そのコマンドの一般的な出力を次に示します。

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

SHOWを:doc:`フロー演算子</sql-reference/operators-flow>`と一緒に使用してインスタンスを見つけ、記述します。

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

フロー演算子を使用して特定のプロパティを抽出します。

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

インスタンスの接続ホスト名を確認します。

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