OS Manuals

/usr/lib/postgresql/18/bin/pg_recvlogical

commercial-spilo-4-fips compat package

From commercial-spilo-4-fips-compat 4.1.2-r9 (enterprise-packages), captured 2026-11-08 by running pg_recvlogical --help (exit 0). permalink

pg_recvlogical controls PostgreSQL logical decoding streams.

Usage:
  pg_recvlogical [OPTION]...

Action to be performed:
      --create-slot      create a new replication slot (for the slot's name see --slot)
      --drop-slot        drop the replication slot (for the slot's name see --slot)
      --start            start streaming in a replication slot (for the slot's name see --slot)

Options:
      --enable-failover  enable replication slot synchronization to standby servers when
                         creating a replication slot
  -E, --endpos=LSN       exit after receiving the specified LSN
  -f, --file=FILE        receive log into this file, - for stdout
  -F  --fsync-interval=SECS
                         time between fsyncs to the output file (default: 10)
      --if-not-exists    do not error if slot already exists when creating a slot
  -I, --startpos=LSN     where in an existing slot should the streaming start
  -n, --no-loop          do not loop on connection lost
  -o, --option=NAME[=VALUE]
                         pass option NAME with optional value VALUE to the
                         output plugin
  -P, --plugin=PLUGIN    use output plugin PLUGIN (default: test_decoding)
  -s, --status-interval=SECS
                         time between status packets sent to server (default: 10)
  -S, --slot=SLOTNAME    name of the logical replication slot
  -t, --enable-two-phase enable decoding of prepared transactions when creating a slot
      --two-phase        (same as --enable-two-phase, deprecated)
  -v, --verbose          output verbose messages
  -V, --version          output version information, then exit
  -?, --help             show this help, then exit

Connection options:
  -d, --dbname=DBNAME    database to connect to
  -h, --host=HOSTNAME    database server host or socket directory
  -p, --port=PORT        database server port number
  -U, --username=NAME    connect as specified database user
  -w, --no-password      never prompt for password
  -W, --password         force password prompt (should happen automatically)

Report bugs to <pgsql-bugs@lists.postgresql.org>.
PostgreSQL home page: <https://www.postgresql.org/>
Options (24)
OptionDescriptionSource
--create-slotcreate a new replication slot (for the slot's name see --slot)help
--drop-slotdrop the replication slot (for the slot's name see --slot)help
--startstart streaming in a replication slot (for the slot's name see --slot)help
--enable-failoverenable replication slot synchronization to standby servers when creating a replication slothelp
-E, --endpos LSNexit after receiving the specified LSNhelp
-f, --file FILEreceive log into this file, - for stdouthelp
-F--fsync-interval=SECS time between fsyncs to the output file (default: 10)help
--if-not-existsdo not error if slot already exists when creating a slothelp
-I, --startpos LSNwhere in an existing slot should the streaming starthelp
-n, --no-loopdo not loop on connection losthelp
-o, --option NAME[=VALUEpass option NAME with optional value VALUE to the output pluginhelp
-P, --plugin PLUGINuse output plugin PLUGIN (default: test_decoding)help
-s, --status-interval SECStime between status packets sent to server (default: 10)help
-S, --slot SLOTNAMEname of the logical replication slothelp
--two-phase(same as --enable-two-phase, deprecated)help
-v, --verboseoutput verbose messageshelp
-V, --versionoutput version information, then exithelp
-?, --helpshow this help, then exithelp
-d, --dbname DBNAMEdatabase to connect tohelp
-h, --host HOSTNAMEdatabase server host or socket directoryhelp
-p, --port PORTdatabase server port numberhelp
-U, --username NAMEconnect as specified database userhelp
-w, --no-passwordnever prompt for passwordhelp
-W, --passwordforce password prompt (should happen automatically)help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.