---
name: "pgpool"
section: "8"
platform: "linux"
package: "pgpool2"
version: "4.6.1-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/pgpool"
---

# pgpool(8)

Pgpool-II main server

## NAME

pgpool - Pgpool-II main server

## SYNOPSIS

**pgpool** \[*option*...\]

**pgpool** \[*option*...\] *stop*

**pgpool** \[*option*...\] *reload*

## DESCRIPTION

the Pgpool-II main server

## USAGES

**pgpool** runs in 3 modes: start, stop and reload. If none of stop or reload is given, it is assumed that "start" is specified.

## COMMON OPTIONS

These are common options for 3 modes.

- **-a** *hba\_config\_file* **--hba-file=***hba\_config\_file*

  Set the path to the pool\_hba.conf configuration file. Mandatory if the file is placed other than the standard location.

- **-f** *config\_file* **--config-file=***config\_file*

  Set the path to the pgpool.conf configuration file. Mandatory if the file is placed other than the standard location.

- **-F** *pc\_config\_file* **--pcp-file=***pcp\_config\_file*

  Set the path to the pcp.conf configuration file. Mandatory if the file is placed other than the standard location.

- **-k** *key\_file* **--key-file=***key\_file*

  Set the path to the .pgpoolkey file. Mandatory if you use AES256 encrypted password and the file is placed other than the standard location and used.

- **-h** **--help**

  Print help.

## STARTING PGPOOL-II MAIN SERVER

Here are options for the start mode.

**-d**\
 **--debug**

Run Pgpool-II in debug mode. Lots of debug messages are produced.

**-n**\
 **--dont-detach**

Don't run in daemon mode, does not detach control ttys.

**-x**\
 **--debug-assertions**

Turns on various assertion checks, This is a debugging aid.

**-C**\
 **--clear-oidmaps**

Clear query cache oidmaps when memqcache\_method is *memcached*.

If memqcache\_method is *shmem*, Pgpool-II always discards oidmaps at the start-up time. So this option is not necessary.

**-D**\
 **--discard-status**

Discard pgpool\_status file and do not restore previous status.

**Caution**\
 This option is testing purpose only for developers and you should not use it for other purposes. If pgpool\_status is accidentally removed, Pgpool-II may go into split-brain (there are multiple primary servers exist).

## STOPPING PGPOOL-II MAIN SERVER

Here are options for the stop mode.

**-m** *shutdown\_mode*\
 **--mode=***shutdown\_mode*

Stop Pgpool-II. *shutdown\_mode* is either smart, fast or immediate. If smart is specified, Pgpool-II will wait for all clients are disconnected. If fast or immediate are specified, Pgpool-II immediately stops itself without waiting for all clients are disconnected. There's no difference between fast and immediate in the current implementation.

## RELOADING PGPOOL-II CONFIGURATION FILES

Reload configuration file of Pgpool-II. No specific options exist for reload mode. Common options are applicable.