GTM_PROXY(1)

NAME
gtm_proxy - Proxy to gtm, Postgres-XC Global Transaction Manager

SYNOPSIS

gtm_proxy [option...]

DESCRIPTION

    Note

    The following description applies only to Postgres-XC

Gtm proxy provides proxy feature from Postgres-XC Coordinator and Datanode to gtm. Gtm proxy groups connections and interactions between gtm and other Postgres-XC components to reduce both the number of interactions and the size of messages.

It is highly advised to start and stop gtm_proxy with gtm_ctl(8).

You must provide gtm configuration file gtm_proxy.conf placed at gtm working directory as specified by -D command line option. The configuration file specifies gtm running environment and resources.

Some of the parameters specified in the control file can be overridden by command line options.

CONFIGURATION FILE

    Note

    The following description applies only to Postgres-XC

GTM-Proxy configuration parameters are specified in the configuration file gtm_proxy.conf. placed in the working directory specified as -D option of gtm_proxy command line option as described in the next section.

Format of the configuration file is the same as postgresql.conf. Options are as follows.

err_wait_count (integer)
    Specifies how many times GTM-Proxy detects reconnect command from gtm_ctl when communication error with GTM is detected. Default value is zero. Refer to err_wait_idle and err_wait_interval.

err_wait_idle (integer)
    Specifies how long in second GTM-Proxy waits before it begin to detect reconnect from gtm_ctl when communication error with GTM is detected. Default value is zero. Refer to err_wait_count and err_wait_interval.

err_wait_interval (integer)
    Specifies how long in second GTM-Proxy waits between each detection of reconnect from gtm_ctl when communication error with GTM is detected. Default value is zero. Refer to err_wait_count and err_wait_idle.

gtm_connect_retry_count (integer)
    Specifies how many times GTM-Proxy retries to connect to GTM when communication error with GTM is detected. Default value is zero. Refer to gtm_connect_retry_idle and gtm_connect_retry_interval.

gtm_connect_retry_idle (integer)
    Specifies how long in second GTM-Proxy waits before it retries to connect to GTM when communication error with GTM is detected. Default value is zero. Refer to gtm_connect_retry_count and gtm_connect_retry_interval.

gtm_connect_retry_interval (integer)
    Specifies how log in second GTM-Proxy waits between each retry to connect to GTM when communication error with GTM is detected. Default value is zero. Refer to gtm_connect_retry_count and gtm_connect_retry_idle.

gtm_host (string)
    Specifies listen addresses (host name or IP address) of gtm. There is no default value for this parameter.

gtm_port (integer)
    Specifies the port number of gtm. There is no default value for this parameter.

keepalives_count (integer)
    Specifies keepalives_count option for the connection to gtm. Default value is zero and keepalives feature is disabled.

keepalives_idle (integer)
    Specifies keepalives_idle option for the connection to gtm. Default value is zero and keepalives feature is disabled.

keepalives_interval (integer)
    Specifies keepalives_interval option for the connection to gtm. Default value is zero and keepalives feature is disabled.

log_file (string)
    Specifies log file name. This file will be created at the working directory of this gtm_proxy as specified by -D command line option. The default is gtm_proxy.log.

log_min_messages (enum)
    Controls which message levels are written to the log. Valid values are DEBUG, DEBUG5, DEBUG4, DEBUG3, DEBUG2, DEBUG1, INFO, NOTICE, WARNING, ERROR, LOG, FATAL and PANIC. Each level includes all the levels that follow it. The later the level, the fewer messages are sent. The default is WARNING.

listen_addresses (string)
    Specifies listen addresses (host name or IP address) of this gtm_proxy. Default value is '*'.

nodename (string)
    Specifies the name of this gtm_proxy. There is no default value for this parameter.

port (integer)
    Specifies the port number of this gtm_proxy. Default port value is 6666.

worker_threads (integer)
    Specifies the number of worker threads for this gtm_proxy. Default value is 1.

OPTIONS

Options are specified with preceding '-', each option may be associated with a value. They can be specified in -o option of gtm_ctl(8).

Options are as follows:

D
    Specify a directory which holds data for gtm_proxy

l
    Specify a log file for gtm_ctl.

h
    Specify host name or IP address used by the gtm_proxy.

p
    Specify port number to listen.

i
    Specify gtm_proxy id, which is registered to gtm.

n
    Specify number of worker threads of gtm_proxy.

s
    Specify host name or IP address of target gtm.

t
    Specify port number of target gtm.