pgd group get-option v6.1.0

Suggest edits

Synopsis

The pgd group get-option command is used to get group-level options in the EDB Postgres Distributed cluster.

Syntax

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

Where <GROUP_NAME> is the name of the group for which you want to get options.

And <OPTION> is the name of a specific group option you want to get. If no option is specified, all group options are listed. The following options are available:

Group Options

OptionDescription
apply_delayThe delay in applying changes to the group.
check_constraintsWhether to check constraints in the group.
default_commit_scopeThe default commit scope of the group.
enable_routingWhether to enable routing in the group.
enable_raftWhether to enable Raft in the group.
enable_wal_decoderWhether to enable the WAL decoder in the group.
locationThe location of the group.
num_writersThe number of writers in the group.
route_reader_max_lagThe maximum lag for the reader in the group.
route_writer_max_lagThe maximum lag for the writer in the group.
streaming_modeThe streaming mode of the group.
route_writer_wait_flushThe wait time for flushing the writer in the group.
analytics_storage_locationThe storage location for analytics in the group.
analytics_autoadd_tablesWhether to automatically add tables to analytics in the group.

Group Connection Manager Options

OptionDescription
read_write_portwhich port to listen on for read-write connections
read_only_portwhich port to listen on for read-only connections
http_portwhich http port to listen for REST API calls (for integration purposes)
use_httpswhether http listener should use HTTPS, if enabled, the server certificate is used to TLS
read_write_max_client_connectionsmaximum read-write client connections allowed, defaults to max_connections
read_write_max_server_connectionsmaximum read-write connections that will be opened to server
read_only_max_client_connectionsmaximum read-only client connections allowed
read_only_max_server_connectionsmaximum read-only connections that will be opened to server
read_write_consensus_timeouthow long to wait on loss of consensus before read-write connections are no longer accepted
read_only_consensus_timeouthow long to wait on loss of consensus before read-only connections are no longer accepted.

Options

No command specific options. See Global Options.

Examples

List all group options

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

Get a specific group option

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

Get a specific group option as json

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

pgd group set-option

↑ Up

pgd group

Next →

pgd group set-leader