create-proxy v5.6
Warning: You are not reading the most recent version of this documentation.
Documentation improvements are made only to the latest version.
As per semantic versioning, PGD minor releases remain backward compatible and may include important bug fixes and enhancements.
We recommend upgrading the latest minor release as soon as possible.
If you want up-to-date information, read the latest PGD documentation.
Documentation improvements are made only to the latest version.
As per semantic versioning, PGD minor releases remain backward compatible and may include important bug fixes and enhancements.
We recommend upgrading the latest minor release as soon as possible.
If you want up-to-date information, read the latest PGD documentation.
Creates proxy in the EDB Postgres Distributed cluster.
Synopsis
Creates proxy in the EDB Postgres Distributed cluster and attaches it to the given group. The proxy name must be unique across the cluster and match with the name given in the corresponding proxy config file.
Use the proxy mode to route connections to Write Leader (default), Read Nodes (read-only), or both (any). Proxy listens on 'listen_port' for Write Leader connections while on 'read_listen_port' for Read Nodes connections.
pgd create-proxy [flags]
Options
| Flag | Description |
|---|---|
--group-name | Group name |
--proxy-mode | Proxy mode (default, read-only, any); proxy will route connections to - default - Write Leader read-only - Read Nodes any - both Write Leader and Read Nodes (default "default") |
--proxy-name | Proxy name |
See global options for global options.
Examples
Attaching in default mode.
In this example, we attach a new proxy called proxy-a1 to group group_a, with 'default' mode.
$ pgd create-proxy --proxy-name proxy-a1 --group-name group_a
Output
proxy created successfully
Attaching in any mode.
In this example, we attach anew proxy called proxy-b1 to group group_b, with 'any' mode.
$ pgd create-proxy --proxy-name proxy-b1 --group-name group_b --proxy-mode any
Output
proxy created successfully