pgd group get-option
====================

概要
----

``pgd group get-option`` コマンドは、 EDB
Postgres分散クラスターでグループレベルのオプションを取得するために使用されます。

ユーザーとロール
^^^^^^^^^^^^^^^^

``bdr_read_all_stats`` ロール以上が必要です。 :ref:`ユーザーロール <ユーザーロール>` 
を参照してください。

構文
----

.. code:: plaintext

   pgd group <GROUP_NAME> get-option [OPTIONS] <OPTION>

``<GROUP_NAME>`` は、オプションを取得するグループの名前です。

``<OPTION>``
は、取得する特定のグループオプションの名前です。オプションを指定しない場合、コマンドはすべてのグループオプションをリストします。次のオプションが使用できます。

グループオプション
^^^^^^^^^^^^^^^^^^

.. csv-table::
  :header: Option,Description
  :widths: 10,30
  :align: left
  :class: longtable

  apply_delay,グループに変更を適用する際の遅延。
  check_constraints,グループ内のコンストレインをチェックするかどうか。
  default_commit_scope,グループのデフォルトのコミットスコープ。
  enable_routing,グループ内のルーティングを有効にするかどうか。
  enable_raft,グループでRaftを有効にするかどうか。
  enable_wal_decoder,グループでWALデコーダーを有効にするかどうか。
  location,グループの場所。
  num_writers,グループ内のライターの数。
  route_reader_max_lag,グループ内のリーダーの最大遅延。
  route_writer_max_lag,グループ内のライタの最大遅延。
  streaming_mode,グループのストリーミングモード。
  route_writer_wait_flush,グループ内のライタをフラッシュするための待機時間。
  analytics_storage_location,グループ内の分析の保存場所。
  analytics_autoadd_tables,グループ内の分析にテーブルを自動的に追加するかどうか。
  evict_node_action,ノードが`evict_node_lag_bytes`を超えたときに実行するアクション。 `none`デフォルトはアクションを実行しません。 `part`はノードを分割します。
  evict_node_lag_bytes,`evict_node_action`が実行される前にノードが蓄積できるバイト単位の最大レプリケーションラグ。

グループ接続マネージャーオプション
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. csv-table::
  :header: Option,Description
  :widths: 10,30
  :align: left
  :class: longtable

  read_write_port,読み取り/書き込み接続をリッスンするポート
  read_only_port,読み取り専用接続をリッスンするポート
  http_port,REST API呼び出しをリッスンするhttpポート統合の目的
  use_https,httpリスナーがHTTPSを使用するかどうか。有効になっている場合、サーバー証明書はTLSに使用されます
  server_pool_mode,:ref:`Connection pooling<Connection pooling>` モード `none` プーリングなし `session`、または`transaction`
  server_pool_timeout,`server_pool_mode`が`session`または`transaction`の場合、断念するまでに利用可能なプールされたサーバー接続を待機する時間デフォルト10秒
  read_write_max_client_connections,許可される最大読み取り/書き込みクライアント接続、デフォルトはmax_connections
  read_write_max_server_connections,サーバーに対して開かれる最大読み取り/書き込み接続
  read_only_max_client_connections,許可される最大読み取り専用クライアント接続
  read_only_max_server_connections,サーバーに対して開かれる読み取り専用接続の最大数
  read_write_consensus_timeout,読み取り/書き込み接続が受け入れられなくなるまでにコンセンサスが失われるまで待機する時間
  read_only_consensus_timeout,読み取り専用接続が受け入れられなくなるまでに、コンセンサス損失を待機する時間。

グループプロキシオプションPGD 5.xのみ
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. csv-table::
  :header: Option,Description
  :widths: 10,30
  :align: left
  :class: longtable

  proxy_listen_address,グループ内のプロキシのリッスンアドレス。
  proxy_listen_addresses,グループ内のプロキシのリッスンアドレス。
  proxy_listen_port,グループ内のプロキシのリッスンポート。
  proxy_max_client_conn,グループ内のプロキシのクライアントの最大接続数。
  proxy_max_server_conn,グループ内のプロキシのサーバー接続の最大数。
  proxy_server_conn_timeout,グループ内のプロキシのサーバー接続タイムアウト。
  proxy_server_conn_keepalive,グループ内のプロキシのサーバー接続キープアライブ。
  proxy_fallback_node_groups,グループ内のプロキシのフォールバックノードグループ。
  proxy_fallback_node_group_timeout,グループ内のプロキシのフォールバックノードグループタイムアウト。
  proxy_consensus_grace_period,グループ内のプロキシのコンセンサス猶予期間。
  proxy_read_listen_address,グループ内の読み取りプロキシのリッスンアドレス。
  proxy_read_listen_addresses,グループ内の読み取りプロキシのリッスンアドレス。
  proxy_read_listen_port,グループ内の読み取りプロキシのリッスンポート。
  proxy_read_max_client_conn,グループ内の読み取りプロキシのクライアントの最大接続数。
  proxy_read_max_server_conn,グループ内の読み取りプロキシのサーバー接続の最大数。
  proxy_read_server_conn_keepalive,グループ内の読み取りプロキシのサーバー接続キープアライブ。
  proxy_read_server_conn_timeout,グループ内の読み取りプロキシのサーバー接続タイムアウト。
  proxy_read_consensus_grace_period,グループ内の読み取りプロキシのコンセンサス猶予期間。

``(inherited)``
の後に値が表示されている場合、これは値がグループに特に設定されていないが、親グループから継承されることを意味します。

オプション
----------

コマンド固有のオプションはありません。 `Global Options <https://www.enterprisedb.com/docs/pgd/latest/reference/cli/command_ref/#global-options>`_ を参照してください。

例
--

すべてのグループオプションをリストする
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: shell

   pgd group dc1_subgroup get-option
   __OUTPUT__
    Option Name                       | Option Value
   - ----------------------------------+---------------
    analytics_autoadd_tables          | false
    analytics_storage_location        |
    apply_delay                       | 00:00:00
    check_constraints                 | true
    default_commit_scope              | local protect
    enable_raft                       | true
    enable_routing                    | true
    enable_wal_decoder                | false
    http_port                         | 6434
    location                          |
    num_writers                       | 2
    read_only_consensus_timeout       | 00:00:00
    read_only_max_client_connections  | 250
    read_only_max_server_connections  | 250
    read_only_port                    | 6433
    read_write_consensus_timeout      | 00:00:00
    read_write_max_client_connections | 250
    read_write_max_server_connections | 250
    read_write_port                   | 6432
    route_reader_max_lag              | -1
    route_writer_max_lag              | -1
    route_writer_wait_flush           | false
    streaming_mode                    | null
    use_https                         | true

特定のグループオプションを取得する
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: shell

   pgd group dc1_subgroup get-option location
   __OUTPUT__
    Option Name | Option Value
   - ------------+--------------
    location    | London

特定のグループオプションをjsonとして取得する
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. code:: shell

   pgd group dc1_subgroup get-option location -o json
   __OUTPUT__
   [
     {
       "option_name": "location",
       "option_value": "London"
     }
   ]
