Search PostgreSQL documentation

pg_readonlyExtensionsExtensionsAdministration · Extensionscluster database read only pg_readonly Administration pg_recall_guardExtensionsExtensionsAI and vectors · ExtensionsMeasure ANN index recall and detect drift from an approved baseline vector ann recall monitoring drift baseline pg_recall_guard AI and vectors pg_receivewalCommand-line ToolsPG18stream write-ahead logs from a PostgreSQL server Synopsis pg_receivewal [option...] pg_receivewalManual ChaptersPG18stream write-ahead logs from a PostgreSQL server Synopsis pg_receivewal [option...] pg_receivewal --compress=method[:detail]Command-line ToolsPG18pg_receivewal › OptionsZ level-Z method[:detail]--compress=level--compress=method[:detail] Enables compression of write-ahead logs. The compression method can be set to gzip, lz4 (if PostgreSQL was compiled with -… pg_receivewal --create-slotCommand-line ToolsPG18pg_receivewal › Optionscreate-slot Create a new physical replication slot with the name specified in --slot, then exit. pg_receivewal --dbname=connstrCommand-line ToolsPG18pg_receivewal › Optionsd connstr--dbname=connstr Specifies parameters used to connect to the server, as a connection string; these will override any conflicting command line options. This option is called --dbname… pg_receivewal --directory=directoryCommand-line ToolsPG18pg_receivewal › OptionsD directory--directory=directory Directory to write the output to. This parameter is required. pg_receivewal --drop-slotCommand-line ToolsPG18pg_receivewal › Optionsdrop-slot Drop the replication slot with the name specified in --slot, then exit. pg_receivewal --endpos=lsnCommand-line ToolsPG18pg_receivewal › OptionsE lsn--endpos=lsn Automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If there is a record with LSN exactly equal to lsn, the record w… pg_receivewal --helpCommand-line ToolsPG18pg_receivewal › Options?--help Show help about pg_receivewal command line arguments, and exit. pg_receivewal --host=hostCommand-line ToolsPG18pg_receivewal › Optionsh host--host=host Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain socket. The default… pg_receivewal --if-not-existsCommand-line ToolsPG18pg_receivewal › Optionsif-not-exists Do not error out when --create-slot is specified and a slot with the specified name already exists. pg_receivewal --no-loopCommand-line ToolsPG18pg_receivewal › Optionsn--no-loop Don't loop on connection errors. Instead, exit right away with an error. pg_receivewal --no-passwordCommand-line ToolsPG18pg_receivewal › Optionsw--no-password Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass file, the connection attempt wil… pg_receivewal --no-syncCommand-line ToolsPG18pg_receivewal › Optionsno-sync This option causes pg_receivewal to not force WAL data to be flushed to disk. This is faster, but means that a subsequent operating system crash can leave the WAL segments corrupt. G… pg_receivewal --passwordCommand-line ToolsPG18pg_receivewal › OptionsW--password Force pg_receivewal to prompt for a password before connecting to a database. This option is never essential, since pg_receivewal will automatically prompt for a password if the … pg_receivewal --port=portCommand-line ToolsPG18pg_receivewal › Optionsp port--port=port Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the PGPORT environment variable, if set, or … pg_receivewal --slot=slotnameCommand-line ToolsPG18pg_receivewal › OptionsS slotname--slot=slotname Require pg_receivewal to use an existing replication slot (see Section 26.2.6). When this option is used, pg_receivewal will report a flush position to the server, … pg_receivewal --status-interval=intervalCommand-line ToolsPG18pg_receivewal › Optionss interval--status-interval=interval Specifies the number of seconds between status packets sent back to the server. This allows for easier monitoring of the progress from server. A value of… pg_receivewal --synchronousCommand-line ToolsPG18pg_receivewal › Optionssynchronous Flush the WAL data to disk immediately after it has been received. Also send a status packet back to the server immediately after flushing, regardless of --status-interval. This … pg_receivewal --username=usernameCommand-line ToolsPG18pg_receivewal › OptionsU username--username=username User name to connect as. pg_receivewal --verboseCommand-line ToolsPG18pg_receivewal › Optionsv--verbose Enables verbose mode. pg_receivewal --versionCommand-line ToolsPG18pg_receivewal › OptionsV--version Print the pg_receivewal version and exit. pg_receivexlog renamed to pg_receivewalManual ChaptersPG18PostgreSQL 9.6 and below provided a command named pg_receivexlog to fetch write-ahead-log (WAL) files. This command was renamed to pg_receivewal, see pg_receivewal for documentation of pg_re… pg_recvlogicalCommand-line ToolsPG18control PostgreSQL logical decoding streams Synopsis pg_recvlogical [option...] pg_recvlogicalManual ChaptersPG18control PostgreSQL logical decoding streams Synopsis pg_recvlogical [option...] pg_recvlogical --create-slotCommand-line ToolsPG18pg_recvlogical › Optionscreate-slot Create a new logical replication slot with the name specified by --slot, using the output plugin specified by --plugin, for the database specified by --dbname. The --slot and --d… pg_recvlogical --dbname=dbnameCommand-line ToolsPG18pg_recvlogical › Optionsd dbname--dbname=dbname The database to connect to. See the description of the actions for what this means in detail. The dbname can be a connection string. If so, connection string paramete… pg_recvlogical --drop-slotCommand-line ToolsPG18pg_recvlogical › Optionsdrop-slot Drop the replication slot with the name specified by --slot, then exit. The --slot is required for this action. pg_recvlogical --enable-failoverCommand-line ToolsPG18pg_recvlogical › Optionsenable-failover Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot. pg_recvlogical --endpos=lsnCommand-line ToolsPG18pg_recvlogical › OptionsE lsn--endpos=lsn In --start mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in --start mode, an error… pg_recvlogical --file=filenameCommand-line ToolsPG18pg_recvlogical › Optionsf filename--file=filename Write received and decoded transaction data into this file. Use - for stdout. This parameter is required for --start. pg_recvlogical --fsync-interval=interval_secondsCommand-line ToolsPG18pg_recvlogical › OptionsF interval_seconds--fsync-interval=interval_seconds Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasio… pg_recvlogical --helpCommand-line ToolsPG18pg_recvlogical › Options?--help Show help about pg_recvlogical command line arguments, and exit. pg_recvlogical --host=hostname-or-ipCommand-line ToolsPG18pg_recvlogical › Optionsh hostname-or-ip--host=hostname-or-ip Specifies the host name of the machine on which the server is running. If the value begins with a slash, it is used as the directory for the Unix domain… pg_recvlogical --if-not-existsCommand-line ToolsPG18pg_recvlogical › Optionsif-not-exists Do not error out when --create-slot is specified and a slot with the specified name already exists. pg_recvlogical --no-loopCommand-line ToolsPG18pg_recvlogical › Optionsn--no-loop When the connection to the server is lost, do not retry in a loop, just exit. pg_recvlogical --no-passwordCommand-line ToolsPG18pg_recvlogical › Optionsw--no-password Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass file, the connection attempt wil… pg_recvlogical --option=name[=value]Command-line ToolsPG18pg_recvlogical › Optionso name[=value]--option=name[=value] Pass the option name to the output plugin with, if specified, the option value value. Which options exist and their effects depends on the used output plu…