pgpro_controldata

pgpro_controldata — display control information of a PostgreSQL/Postgres Pro database cluster and compatibility information for a cluster and/or server

Synopsis

pgpro_controldata [option...]

Description

pgpro_controldata prints control information, such as the catalog version, initialized by initdb command of any PostgreSQL/Postgres Pro server. It also shows information about write-ahead logging and checkpoint processing. This information is cluster-wide and not specific to any database.

pgpro_controldata also helps to check compatibility between PostgreSQL/Postgres Pro database servers and clusters. It can print server or cluster parameters that can affect the compatibility and check whether a cluster and server are compatible by comparing those parameters.

pgpro_controldata is provided with Postgres Pro Standard as a separate pre-built package pgpro-controldata (for the detailed installation instructions, see Chapter 16).

Options

pgpro_controldata accepts the following command-line arguments. If no arguments are specified, pgpro_controldata just prints the control information like pg_controldata does. Note that compatibility-related command-line arguments -P and -S specified together work the same way as -C.

General-Purpose

-B
--bindir

Specifies the PostgreSQL/Postgres Pro executable directory, needed to get server compatibility parameters.

-D datadir
--pgdata=datadir

Specifies the file system location of the database configuration files. If this option is omitted, the environment variable PGDATA is used.

-V
--version

Print the pgpro_controldata version, then exit.

-?
--help

Show help about pgpro_controldata command-line arguments, then exit.

Compatibility-Related

-C
--compatibility-check

Display all parameters that can affect compatibility between the specified server and cluster and check whether they are compatible.

Use the -D option or the environment variable PGDATA to provide the path to the data directory, where read access is required.

If the -B option is omitted, the current server is assumed.

The cluster data and the server must have the same byte order and architecture type for this option to work correctly.

-P
--cluster-compatibility-params

Display all parameters of the specified cluster that can affect the compatibility.

Use the -D option or the environment variable PGDATA to provide the path to the data directory, where read access is required.

The cluster data and the server must have the same byte order and architecture type for this option to work correctly.

-S
--server-compatibility-params

Display all parameters of the specified or current server that can affect the compatibility.

If the -B option is omitted, the current server is assumed.

Environment

PGDATA

Default data directory location

PG_COLOR

Specifies whether to use color in diagnostic messages. Possible values are always, auto and never.