pgd group show v6.1.0

Synopsis

The pgd group show command is used to display group-level information in the EDB Postgres Distributed cluster.

Syntax

pgd group <GROUP_NAME> show [OPTIONS]

Where <GROUP_NAME> is the name of the group for which you want to display information.

Options

The following table lists the options available for the pgd cluster show command:

LongDescription
--summaryOnly Show summary of the group.
--optionsOnly show options of the group.
--nodesOnly show nodes of the group.

Only one of the above options can be specified at a time.

See Global Options.

Examples

Show group information

pgd group group-a show
Output
# Summary
 Group Property    | Value
-------------------+---------
 Group Name        | group-a
 Parent Group Name | pgdx6
 Group Type        | data
 Write Leader      | pgd-a3
 Commit Scope      |

# Nodes
 Node Name | Node Kind | Join State | Node Status
-----------+-----------+------------+-------------
 pgd-a2    | data      | ACTIVE     | Up
 pgd-a3    | data      | ACTIVE     | Up
 pgd-a1    | data      | ACTIVE     | Up

# Options
 Option Name                       | Option Value  | Option Source
-----------------------------------+---------------+---------------
 analytics_autoadd_tables          | false         | group
 analytics_storage_location        |               | default
 apply_delay                       | 00:00:00      | inherited
 check_constraints                 | true          | inherited
 default_commit_scope              | local protect | group
 enable_raft                       | true          | group
 enable_routing                    | true          | group
 enable_wal_decoder                | false         | inherited
 http_port                         | 6434          | pg_config
 location                          | London        | group
 num_writers                       | 2             | pg_config
 read_only_consensus_timeout       | 00:00:00      | pg_config
 read_only_max_client_connections  | 250           | pg_config
 read_only_max_server_connections  | 250           | pg_config
 read_only_port                    | 6433          | pg_config
 read_write_consensus_timeout      | 00:00:00      | pg_config
 read_write_max_client_connections | 250           | pg_config
 read_write_max_server_connections | 250           | pg_config
 read_write_port                   | 6432          | pg_config
 route_reader_max_lag              | -1            | default
 route_writer_max_lag              | -1            | default
 route_writer_wait_flush           | false         | group
 streaming_mode                    | null          | group
 use_https                         | true          | group

Show group summary information

pgd group group-a show --summary
Output
 Group Property    | Value
-------------------+---------
 Group Name        | group-a
 Parent Group Name | pgdx6
 Group Type        | data
 Write Leader      | pgd-a3
 Commit Scope      |

Show group nodes information

pgd group group-a show --nodes
Output
 Node Name | Node Kind | Join State | Node Status
-----------+-----------+------------+-------------
 pgd-a1    | data      | ACTIVE     | Up
 pgd-a2    | data      | ACTIVE     | Up
 pgd-a3    | data      | ACTIVE     | Up

Show group options information

pgd group group-a show --options
Output
 Option Name                       | Option Value  | Option Source
-----------------------------------+---------------+---------------
 analytics_autoadd_tables          | false         | group
 analytics_storage_location        |               | default
 apply_delay                       | 00:00:00      | inherited
 check_constraints                 | true          | inherited
 default_commit_scope              | local protect | group
 enable_raft                       | true          | group
 enable_routing                    | true          | group
 enable_wal_decoder                | false         | inherited
 http_port                         | 6434          | pg_config
 location                          | London        | group
 num_writers                       | 2             | pg_config
 read_only_consensus_timeout       | 00:00:00      | pg_config
 read_only_max_client_connections  | 250           | pg_config
 read_only_max_server_connections  | 250           | pg_config
 read_only_port                    | 6433          | pg_config
 read_write_consensus_timeout      | 00:00:00      | pg_config
 read_write_max_client_connections | 250           | pg_config
 read_write_max_server_connections | 250           | pg_config
 read_write_port                   | 6432          | pg_config
 route_reader_max_lag              | -1            | default
 route_writer_max_lag              | -1            | default
 route_writer_wait_flush           | false         | group
 streaming_mode                    | null          | group
 use_https                         | true          | group

Show group information as JSON

pgd group group-a show -o json
Output
[
  {
    "Summary": [
      {
        "info": "Group Name",
        "value": "group-a"
      },
      {
        "info": "Parent Group Name",
        "value": "pgdx6"
      },
      {
        "info": "Group Type",
        "value": "data"
      },
      {
        "info": "Write Leader",
        "value": "pgd-a3"
      },
      {
        "info": "Commit Scope",
 @@ -97,72 +178,144 @@ __OUTPUT__
      {
        "join_state": "ACTIVE",
        "node_kind_name": "data",
        "node_name": "pgd-a2",
        "node_status": "Up"
      },
      {
        "join_state": "ACTIVE",
        "node_kind_name": "data",
        "node_name": "pgd-a3",
        "node_status": "Up"
      },
      {
        "join_state": "ACTIVE",
        "node_kind_name": "data",
        "node_name": "pgd-a1",
        "node_status": "Up"
      }
    ]
  },
  {
    "Options": [
      {
        "option_name": "analytics_autoadd_tables",
        "option_source": "group",
        "option_value": "false"
      },
      {
        "option_name": "analytics_storage_location",
        "option_source": "default",
        "option_value": ""
      },
      {
        "option_name": "apply_delay",
        "option_source": "inherited",
        "option_value": "00:00:00"
      },
      {
        "option_name": "check_constraints",
        "option_source": "inherited",
        "option_value": "true"
      },
      {
        "option_name": "default_commit_scope",
        "option_source": "group",
        "option_value": "local protect"
      },
      {
        "option_name": "enable_raft",
        "option_source": "group",
        "option_value": "true"
      },
      {
        "option_name": "enable_routing",
        "option_source": "group",
        "option_value": "true"
      },
      {
        "option_name": "enable_wal_decoder",
        "option_source": "inherited",
        "option_value": "false"
      },
      {
        "option_name": "http_port",
        "option_source": "pg_config",
        "option_value": "6434"
      },
      {
        "option_name": "location",
        "option_source": "group",
        "option_value": "London"
      },
      {
        "option_name": "num_writers",
        "option_source": "pg_config",
        "option_value": "2"
      },
      {
        "option_name": "read_only_consensus_timeout",
        "option_source": "pg_config",
        "option_value": "00:00:00"
      },
      {
        "option_name": "read_only_max_client_connections",
        "option_source": "pg_config",
        "option_value": "250"
      },
      {
        "option_name": "read_only_max_server_connections",
        "option_source": "pg_config",
        "option_value": "250"
      },
      {
        "option_name": "read_only_port",
        "option_source": "pg_config",
        "option_value": "6433"
      },
      {
        "option_name": "read_write_consensus_timeout",
        "option_source": "pg_config",
        "option_value": "00:00:00"
      },
      {
        "option_name": "read_write_max_client_connections",
        "option_source": "pg_config",
        "option_value": "250"
      },
      {
        "option_name": "read_write_max_server_connections",
        "option_source": "pg_config",
        "option_value": "250"
      },
      {
        "option_name": "read_write_port",
        "option_source": "pg_config",
        "option_value": "6432"
      },
      {
        "option_name": "route_reader_max_lag",
        "option_source": "default",
        "option_value": "-1"
      },
      {
        "option_name": "route_writer_max_lag",
        "option_source": "default",
        "option_value": "-1"
      },
      {
        "option_name": "route_writer_wait_flush",
        "option_source": "group",
        "option_value": "false"
      },
      {
        "option_name": "streaming_mode",
        "option_source": "group",
        "option_value": "null"
      },
      {
        "option_name": "use_https",
        "option_source": "group",
        "option_value": "true"
      }
    ]
   }
   

export const _frontmatter = {"title":"pgd group show","navTitle":"Show","deepToC":true,"redirects":["/pgd/latest/cli/command_ref/group/show/"]}