{"kind": "tool", "major": "18", "item": {"slug": "pg-recvlogical", "name": "pg_recvlogical", "name_zh": "", "category": "Client applications", "summary": "pg_recvlogical \u2014 control PostgreSQL logical decoding streams", "aliases": ["pg_recvlogical"], "content_hash": "6e51b4b791bf62502d105ef2553c57a513e6bc34c4a42b7a45b82dc8611d1672", "versions": {"10": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "10.23"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "22"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/10/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/10/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=10", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v10.23/postgresql-10.23.tar.bz2", "label": "10.23", "major": "10", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/10/postgresql-10-A4.pdf", "bytes": 12631706, "pages": 2591, "sha256": "34497ab9efb45c5bdf1bd11b9016b5451354feb462fa029cf74557a5fa5fbbc1", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/10/postgresql-10-US.pdf", "bytes": 12531684, "pages": 2724, "sha256": "429cc7133ddf4f97c560aa466dc9caea4b718721a8321e293357037cf0af4733", "built_at": "2026-09-26"}}, "tree": "10", "index": "index.html", "major": "10", "pages": 1085, "release": "10.23", "source_url": "https://ftp.postgresql.org/pub/source/v10.23/postgresql-10.23.tar.bz2", "svg_assets": 0, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9"}, "revision": "f9301feba91e2e2566038a36b8cee0e4402db68989538f88670fddd20b1f78ea", "evidence_kind": "English manual and source declarations", "source_sha256": "94a4b2528372458e5662c18d406629266667c437198160a18cdfd2c4a4d6eee9"}, "sources": [{"url": "/docs/10/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "10.23 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "961ed52996c4b9f657d2fa1894c1e74bd9500b943f6ab26d9cb08ced6e83b7fb"}, {"url": "/docs/10/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "e4330732b6acd6c025a1fbdce45574b23d964de847a1b849ea88b98ab628d2e2"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.16.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/10/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/10/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/10/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.26.6.\u00a0Replication Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/10/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a> and <a class=\"xref\" href=\"/docs/10/protocol-replication.html\" title=\"52.4.\u00a0Streaming Replication Protocol\">Section\u00a052.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/10/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/10/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/10/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"33.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.7\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/10/libpq-envars.html\" title=\"33.14.\u00a0Environment Variables\">Section\u00a033.14</a>).</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.8\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/10/logicaldecoding-example.html\" title=\"48.1.\u00a0Logical Decoding Examples\">Section\u00a048.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.9\">\n<h2>See Also</h2>\n<span class=\"simplelist\"><a class=\"xref\" href=\"/docs/10/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a></span></div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "7fdaefb91981303dc481e4f1250296efbce0c4c148d9f6ffdb45ed389410c379"}, "11": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "11.22"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "22"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/11/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/11/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=11", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v11.22/postgresql-11.22.tar.bz2", "label": "11.22", "major": "11", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/11/postgresql-11-A4.pdf", "bytes": 13057499, "pages": 2732, "sha256": "41d75855e610d0d9b8802b87dc5b080bef8d7e91c7cf69401fbf8d3cf801b4b5", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/11/postgresql-11-US.pdf", "bytes": 12961189, "pages": 2883, "sha256": "6a8899ef36935a5b7ed2b436207564a567a4ef1eb1c2200195876b8de4d4fa30", "built_at": "2026-09-26"}}, "tree": "11", "index": "index.html", "major": "11", "pages": 1125, "release": "11.22", "source_url": "https://ftp.postgresql.org/pub/source/v11.22/postgresql-11.22.tar.bz2", "svg_assets": 0, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0"}, "revision": "53315ddaf3b3f9e6669fd1edc096bbb2cd4a65ea3e836c89e542b43af9ba3a7f", "evidence_kind": "English manual and source declarations", "source_sha256": "2cb7c97d7a0d7278851bbc9c61f467b69c094c72b81740b751108e7892ebe1f0"}, "sources": [{"url": "/docs/11/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "11.22 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "5f1be5d2376384f1085427f2a9ae87d803a3efe059ad3c2d340ff9c9d0130699"}, {"url": "/docs/11/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "3a30e696058b118a55cc42892c39671d9bae86f77e1024d5ebcc4688ad9ab4c3"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.16.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/11/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/11/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/11/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.26.6.\u00a0Replication Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/11/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a> and <a class=\"xref\" href=\"/docs/11/protocol-replication.html\" title=\"53.4.\u00a0Streaming Replication Protocol\">Section\u00a053.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/11/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/11/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/11/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"34.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.7\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/11/libpq-envars.html\" title=\"34.14.\u00a0Environment Variables\">Section\u00a034.14</a>).</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.8\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the received WAL files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.9\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/11/logicaldecoding-example.html\" title=\"49.1.\u00a0Logical Decoding Examples\">Section\u00a049.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.10\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/11/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "cb23380d69569dabfc3a12174e3c5d84e7b01ec354458f8a37ed72d89bf52baf"}, "12": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "12.22"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "22"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/12/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/12/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=12", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v12.22/postgresql-12.22.tar.bz2", "label": "12.22", "major": "12", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/12/postgresql-12-A4.pdf", "bytes": 13424351, "pages": 2803, "sha256": "7422cf53fd1939e7a3d2925231a88b0330e468afa5393627cac0ff86158a0621", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/12/postgresql-12-US.pdf", "bytes": 13322565, "pages": 2958, "sha256": "51f3b04e72907fc38512685946223452ea65f84419c60c66241dfa3396035e77", "built_at": "2026-09-26"}}, "tree": "12", "index": "index.html", "major": "12", "pages": 1131, "release": "12.22", "source_url": "https://ftp.postgresql.org/pub/source/v12.22/postgresql-12.22.tar.bz2", "svg_assets": 2, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b"}, "revision": "7a827e97cbfacd7febff75f34443e2043e40723de5b6d8c9d81a9430b65a37e4", "evidence_kind": "English manual and source declarations", "source_sha256": "8df3c0474782589d3c6f374b5133b1bd14d168086edbc13c6e72e67dd4527a3b"}, "sources": [{"url": "/docs/12/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "12.22 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "e281a1ec15b0f8edb3a166f1b95dda8f8202bae1c2ecb92cbe99efa30359631d"}, {"url": "/docs/12/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "089624dd131f52eea682b304f87a1acb03392ee7bcf78b000699c9b17c7ca22d"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.16.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/12/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/12/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/12/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.26.6.\u00a0Replication Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/12/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a> and <a class=\"xref\" href=\"/docs/12/protocol-replication.html\" title=\"52.4.\u00a0Streaming Replication Protocol\">Section\u00a052.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/12/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/12/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/12/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"33.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.7\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/12/libpq-envars.html\" title=\"33.14.\u00a0Environment Variables\">Section\u00a033.14</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.8\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the received WAL files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.9\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/12/logicaldecoding-example.html\" title=\"48.1.\u00a0Logical Decoding Examples\">Section\u00a048.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.10\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/12/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "7fdaefb91981303dc481e4f1250296efbce0c4c148d9f6ffdb45ed389410c379"}, "13": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "13.23"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "22"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/13/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/13/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=13", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v13.23/postgresql-13.23.tar.bz2", "label": "13.23", "major": "13", "channel": "historical", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/13/postgresql-13-A4.pdf", "bytes": 13843239, "pages": 2826, "sha256": "171cc09f90936dbc1cbd503a98ff07ae72ea58ab9771ff051313f1217737799c", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/13/postgresql-13-US.pdf", "bytes": 13739572, "pages": 2984, "sha256": "48d09c6e197d9db4220f41afe83efe848a8661b1b168d3b89419751ecaf6c24d", "built_at": "2026-09-26"}}, "tree": "13", "index": "index.html", "major": "13", "pages": 1139, "release": "13.23", "source_url": "https://ftp.postgresql.org/pub/source/v13.23/postgresql-13.23.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6"}, "revision": "614ee3133270254e476c118cdf6f72af78d4e4b8bbd9b28ed9ab1e14e4e9c0f6", "evidence_kind": "English manual and source declarations", "source_sha256": "6ec3c82726af92b7dec873fa1cdf881eca92a4219787dfad05acb6b10e041fd6"}, "sources": [{"url": "/docs/13/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "13.23 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "2c399c47cbdea224d29e03c3066ee0cfd762927eca3b0d7eeb97edd08ba9a0b0"}, {"url": "/docs/13/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "2a16c2982d9803edd4bd6920f76b66083e7f2959182d6a3bcec7ccfbac0a9ad8"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.16.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/13/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/13/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/13/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.27.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/13/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a> and <a class=\"xref\" href=\"/docs/13/protocol-replication.html\" title=\"52.4.\u00a0Streaming Replication Protocol\">Section\u00a052.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/13/logicaldecoding.html\" title=\"Chapter\u00a048.\u00a0Logical Decoding\">Chapter\u00a048</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/13/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/13/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"33.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.7\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/13/libpq-envars.html\" title=\"33.14.\u00a0Environment Variables\">Section\u00a033.14</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.8\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the received WAL files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.9\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/13/logicaldecoding-example.html\" title=\"48.1.\u00a0Logical Decoding Examples\">Section\u00a048.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.16.10\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/13/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\">pg_receivewal</span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "7fdaefb91981303dc481e4f1250296efbce0c4c148d9f6ffdb45ed389410c379"}, "14": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "14.24"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "22"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/14/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/14/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=14", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v14.24/postgresql-14.24.tar.bz2", "label": "14.24", "major": "14", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/14/postgresql-14-A4.pdf", "bytes": 14354704, "pages": 2944, "sha256": "8bc6b9dd7b246888bb77f0a5e8c39a2eae52e9926569832669c7d1600becb27c", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/14/postgresql-14-US.pdf", "bytes": 14242178, "pages": 3102, "sha256": "b7ecb5a5f62d8b9f73a69e25a7d26ba285373bc53168a553bff7b77955506db4", "built_at": "2026-09-26"}}, "tree": "14", "index": "index.html", "major": "14", "pages": 1158, "release": "14.24", "source_url": "https://ftp.postgresql.org/pub/source/v14.24/postgresql-14.24.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897"}, "revision": "588700d46356d8837c77c7c0a4e71e645fe6535983b8f1830aa8f2e4e41c40ae", "evidence_kind": "English manual and source declarations", "source_sha256": "a7fa7ed3d558172355f51406097a7bd4f6b473be80f311ef7cda96bf383d8897"}, "sources": [{"url": "/docs/14/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "14.24 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "000e02796e1792d406764eb36538409d4a74c397e4f047ca43f744c0949865bd"}, {"url": "/docs/14/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "5a13567a052954dfe494dfaab9f50919faa1ae56023930fdbb78d45e53feccde"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.17.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/14/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/14/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/14/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.27.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/14/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a> and <a class=\"xref\" href=\"/docs/14/protocol-replication.html\" title=\"53.4.\u00a0Streaming Replication Protocol\">Section\u00a053.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/14/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/14/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/14/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"34.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.7\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/14/libpq-envars.html\" title=\"34.15.\u00a0Environment Variables\">Section\u00a034.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.8\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.9\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/14/logicaldecoding-example.html\" title=\"49.1.\u00a0Logical Decoding Examples\">Section\u00a049.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.10\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/14/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "cb23380d69569dabfc3a12174e3c5d84e7b01ec354458f8a37ed72d89bf52baf"}, "15": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "15.19"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "23"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-t --two-phase"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/15/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 --two-phase can be specified with --create-slot to enable decoding of prepared transactions."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-t", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot", "signature": "-t --two-phase", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot"}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/15/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=15", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v15.19/postgresql-15.19.tar.bz2", "label": "15.19", "major": "15", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/15/postgresql-15-A4.pdf", "bytes": 14609140, "pages": 2987, "sha256": "66228564a4d16efb47d6a914085716ecfe22ca1566db56bc7c3d82f790646d72", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/15/postgresql-15-US.pdf", "bytes": 14495690, "pages": 3153, "sha256": "645a498c2390d47a6223ec74770631185807a19c484edb0fc5a295d9f460bc02", "built_at": "2026-09-26"}}, "tree": "15", "index": "index.html", "major": "15", "pages": 1168, "release": "15.19", "source_url": "https://ftp.postgresql.org/pub/source/v15.19/postgresql-15.19.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89"}, "revision": "6af958c6520151fc7697d56e0616b03fb00522c4568158674d452ae0644ba545", "evidence_kind": "English manual and source declarations", "source_sha256": "e1a64a87a46b825b88c082e4518161a47aab53c45694964f8ba1df28f7859f89"}, "sources": [{"url": "/docs/15/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "15.19 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "f213fbb8407a33f124af89e874da58a165637ae96ea68c6910ce5911cee05d96"}, {"url": "/docs/15/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "015b2ea2bd205946a55a1b837e735570631bac831c92074a6bf58444f9a3cb98"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.17.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/15/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/15/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/15/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.27.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--two-phase</code> can be specified with <code class=\"option\">--create-slot</code> to enable decoding of prepared transactions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/15/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a> and <a class=\"xref\" href=\"/docs/15/protocol-replication.html\" title=\"55.4.\u00a0Streaming Replication Protocol\">Section\u00a055.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/15/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/15/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code></span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code></p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/15/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"34.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.7\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/15/libpq-envars.html\" title=\"34.15.\u00a0Environment Variables\">Section\u00a034.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.8\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.9\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/15/logicaldecoding-example.html\" title=\"49.1.\u00a0Logical Decoding Examples\">Section\u00a049.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.10\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/15/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --two-phase can be specified with --create-slot to enable decoding of prepared transactions."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-t", "--two-phase"], "signature": "-t --two-phase", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot"}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "a1e55e317386f04dfd6208582358f533a1d4d6134c70f94a17b0552b7e30127a"}, "16": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "16.15"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "23"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-t --two-phase"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/16/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 --two-phase can be specified with --create-slot to enable decoding of prepared transactions."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-t", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot", "signature": "-t --two-phase", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot"}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/16/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=16", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v16.15/postgresql-16.15.tar.bz2", "label": "16.15", "major": "16", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/16/postgresql-16-A4.pdf", "bytes": 15282337, "pages": 3055, "sha256": "4bb6c1f63deedac98736d8c4c7bc0fad0ac24e85b07e21ee10411872f06afd06", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/16/postgresql-16-US.pdf", "bytes": 15164148, "pages": 3220, "sha256": "5b6b6166c89991199e144bb0ae34c17a5f29826251dbf19db1abc0df3a3e771b", "built_at": "2026-09-26"}}, "tree": "16", "index": "index.html", "major": "16", "pages": 1169, "release": "16.15", "source_url": "https://ftp.postgresql.org/pub/source/v16.15/postgresql-16.15.tar.bz2", "svg_assets": 3, "source_mode": "en HTML verified against the pinned official archive", "source_sha256": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed"}, "revision": "3c21e58b35318021716440e67bb8bafd392b6a2b965a244d90e9e33c99e0bdef", "evidence_kind": "English manual and source declarations", "source_sha256": "c1575341fa7bd40f5274ea465b34390f4dc64cdd0770af327005caaeb9f6b7ed"}, "sources": [{"url": "/docs/16/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "16.15 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "8fe72a6e0a00b5c893d2dadedc84a27c5d5830f2f292dac509ecd77bd86bf9c9"}, {"url": "/docs/16/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "a28c30c3c0f8783e16d56413a0b6fd39487e336da1683b29b60abf1c229cef26"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.17.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/16/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/16/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/16/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.27.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>In the absence of fatal errors, <span class=\"application\">pg_recvlogical</span> will run until terminated by the <span class=\"systemitem\">SIGINT</span> (<span class=\"keycap\"><strong>Control</strong></span>+<span class=\"keycap\"><strong>C</strong></span>) or <span class=\"systemitem\">SIGTERM</span> signal.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--two-phase</code> can be specified with <code class=\"option\">--create-slot</code> to enable decoding of prepared transactions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/16/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a> and <a class=\"xref\" href=\"/docs/16/protocol-replication.html\" title=\"55.4.\u00a0Streaming Replication Protocol\">Section\u00a055.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/16/logicaldecoding.html\" title=\"Chapter\u00a049.\u00a0Logical Decoding\">Chapter\u00a049</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/16/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code></span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code></p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/16/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"34.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.7\">\n<h2>Exit Status</h2>\n<p><span class=\"application\">pg_recvlogical</span> will exit with status 0 when terminated by the <span class=\"systemitem\">SIGINT</span> or <span class=\"systemitem\">SIGTERM</span> signal. (That is the normal way to end it. Hence it is not an error.) For fatal errors or other signals, the exit status will be nonzero.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.8\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/16/libpq-envars.html\" title=\"34.15.\u00a0Environment Variables\">Section\u00a034.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.9\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.10\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/16/logicaldecoding-example.html\" title=\"49.1.\u00a0Logical Decoding Examples\">Section\u00a049.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.17.11\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/16/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --two-phase can be specified with --create-slot to enable decoding of prepared transactions."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 55.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-t", "--two-phase"], "signature": "-t --two-phase", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot"}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "a1e55e317386f04dfd6208582358f533a1d4d6134c70f94a17b0552b7e30127a"}, "17": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "17.11"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "23"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 53.4 . Ignored in other modes.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-t --two-phase"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/17/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 --two-phase can be specified with --create-slot to enable decoding of prepared transactions."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 53.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 53.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-t", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": "-t --two-phase", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options. Defaults to the user name.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/17/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=17", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v17.11/postgresql-17.11.tar.bz2", "label": "17.11", "major": "17", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/17/postgresql-17-A4.pdf", "bytes": 15521293, "pages": 3099, "sha256": "1991354df0dc89e70ec39328c28988ef8b19c6a93671dab3893650b63e9f4e36", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/17/postgresql-17-US.pdf", "bytes": 15398150, "pages": 3270, "sha256": "07696c8f38abf31babf22d2db337093936e7c472d2af36d050b000c49bbcf52c", "built_at": "2026-09-26"}}, "tree": "17", "index": "index.html", "major": "17", "pages": 1143, "release": "17.11", "source_url": "https://ftp.postgresql.org/pub/source/v17.11/postgresql-17.11.tar.bz2", "svg_assets": 3, "source_mode": "en SGML built with pinned official archive", "source_sha256": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979"}, "revision": "58419c9b0dd42cb34c8d53695bb025a7e582edf55ccd4c5bcb1c2c7c71a37487", "evidence_kind": "English manual and source declarations", "source_sha256": "dd27f2b3c59e73ed14aa3324901242bf69a032a6347805f274e6260322d42979"}, "sources": [{"url": "/docs/17/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "17.11 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "f0e116635d9e0f3f98d7e32d9e87215c597ff933bae24ff3576f55f961a44ebf"}, {"url": "/docs/17/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "3194fc72ddad8e2fcba55f8e007f83413cb352146cb65aaa9457a18d0314ee1b"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.18.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/17/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/17/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/17/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.28.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>In the absence of fatal errors, <span class=\"application\">pg_recvlogical</span> will run until terminated by the <span class=\"systemitem\">SIGINT</span> (<span class=\"keycap\"><strong>Control</strong></span>+<span class=\"keycap\"><strong>C</strong></span>) or <span class=\"systemitem\">SIGTERM</span> signal.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--two-phase</code> can be specified with <code class=\"option\">--create-slot</code> to enable decoding of prepared transactions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/17/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a> and <a class=\"xref\" href=\"/docs/17/protocol-replication.html\" title=\"53.4.\u00a0Streaming Replication Protocol\">Section\u00a053.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/17/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/17/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code></span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/17/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"32.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options. Defaults to the user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.7\">\n<h2>Exit Status</h2>\n<p><span class=\"application\">pg_recvlogical</span> will exit with status 0 when terminated by the <span class=\"systemitem\">SIGINT</span> or <span class=\"systemitem\">SIGTERM</span> signal. (That is the normal way to end it. Hence it is not an error.) For fatal errors or other signals, the exit status will be nonzero.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.8\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/17/libpq-envars.html\" title=\"32.15.\u00a0Environment Variables\">Section\u00a032.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.9\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.10\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/17/logicaldecoding-example.html\" title=\"47.1.\u00a0Logical Decoding Examples\">Section\u00a047.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.11\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/17/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --two-phase can be specified with --create-slot to enable decoding of prepared transactions."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 53.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name."}, {"names": ["-t", "--two-phase"], "signature": "-t --two-phase", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. Defaults to the user name."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "ca38abf8313905817d5430eb84478265d44900451c3dfd110858b605b0811608"}, "18": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "18.6"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "24"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--enable-failover"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-t --enable-two-phase --two-phase (deprecated)"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 --dbname are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot is required for this action."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot and --dbname , --file are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": "--enable-failover", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": "-t --enable-two-phase --two-phase (deprecated)", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=18", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "18.6", "major": "18", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/18/postgresql-18-A4.pdf", "bytes": 15865106, "pages": 3154, "sha256": "19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/18/postgresql-18-US.pdf", "bytes": 15748059, "pages": 3328, "sha256": "facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319", "built_at": "2026-09-26"}}, "tree": "18", "index": "index.html", "major": "18", "pages": 1148, "release": "18.6", "source_url": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "svg_assets": 3, "source_mode": "en SGML built with pinned official archive", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "revision": "ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8", "evidence_kind": "English manual and source declarations", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "sources": [{"url": "/docs/18/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "18.6 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "3052f6f3caa9b5cca077878cde0cd9f927a9489aaf13cc41209fa504c1327f39"}, {"url": "/docs/18/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "68f726af77272fe73a827be2b7b5958d0f2239a6f8ed44264e9d42496bfa4fd0"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.18.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/18/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/18/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/18/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.28.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>In the absence of fatal errors, <span class=\"application\">pg_recvlogical</span> will run until terminated by the <span class=\"systemitem\">SIGINT</span> (<span class=\"keycap\"><strong>Control</strong></span>+<span class=\"keycap\"><strong>C</strong></span>) or <span class=\"systemitem\">SIGTERM</span> signal.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--slot</code> and <code class=\"option\">--dbname</code> are required for this action.</p>\n<p>The <code class=\"option\">--enable-two-phase</code> and <code class=\"option\">--enable-failover</code> options can be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n<p>The <code class=\"option\">--slot</code> is required for this action.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The <code class=\"option\">--slot</code> and <code class=\"option\">--dbname</code>, <code class=\"option\">--file</code> are required for this action.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--enable-failover</code></span></dt>\n<dd>\n<p>Enables the slot to be synchronized to the standbys. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n<p>This parameter is required for <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/18/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a> and <a class=\"xref\" href=\"/docs/18/protocol-replication.html\" title=\"54.4.\u00a0Streaming Replication Protocol\">Section\u00a054.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/18/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/18/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n<p>This parameter is required for any of actions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--enable-two-phase</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code> (deprecated)</span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/18/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"32.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options.</p>\n<p>This parameter is required for <code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.7\">\n<h2>Exit Status</h2>\n<p><span class=\"application\">pg_recvlogical</span> will exit with status 0 when terminated by the <span class=\"systemitem\">SIGINT</span> or <span class=\"systemitem\">SIGTERM</span> signal. (That is the normal way to end it. Hence it is not an error.) For fatal errors or other signals, the exit status will be nonzero.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.8\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/18/libpq-envars.html\" title=\"32.15.\u00a0Environment Variables\">Section\u00a032.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.9\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.10\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/18/logicaldecoding-example.html\" title=\"47.1.\u00a0Logical Decoding Examples\">Section\u00a047.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.11\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/18/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --dbname are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot is required for this action."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot and --dbname , --file are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "signature": "--enable-failover", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "signature": "-t --enable-two-phase --two-phase (deprecated)", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "7e4d124b6d72f9dbcf5a935f6ef5cfdac9d56466c979b9dabadfcd070a54dfeb"}, "19": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "19beta4"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "24"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "--enable-failover"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-t --enable-two-phase --two-phase (deprecated)"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/19/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 --dbname options are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot option is required for this action."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot , --dbname , and --file options are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": "--enable-failover", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": "-t --enable-two-phase --two-phase (deprecated)", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/19/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=19", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v19beta4/postgresql-19beta4.tar.bz2", "label": "19beta4", "major": "19", "channel": "preview", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/19/postgresql-19-A4.pdf", "bytes": 16064841, "pages": 3052, "sha256": "4dd099e4125c591128fc5f3ebd02178dc24781f9e5ae629f96d67c4c8547427b", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/19/postgresql-19-US.pdf", "bytes": 15974616, "pages": 3225, "sha256": "61971fa857f0956d47341a0388fa6af9ae10acf691d4b2fc009007d384b0342b", "built_at": "2026-09-26"}}, "tree": "19", "index": "index.html", "major": "19", "pages": 1155, "release": "19beta4", "source_url": "https://ftp.postgresql.org/pub/source/v19beta4/postgresql-19beta4.tar.bz2", "svg_assets": 5, "source_mode": "en SGML built with pinned official archive", "source_sha256": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86"}, "revision": "1bbbbf4133d426f0e4304010688d2984c30fb67df0cc3a61b3e37eb3f6f37833", "evidence_kind": "English manual and source declarations", "source_sha256": "83157ee9c599d03b2f7a3d73ef3a56ec24e0e79cc2b3501a64d1364f56398c86"}, "sources": [{"url": "/docs/19/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "19beta4 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "e4a79f38bcd57bb1d703968ab9b324e579bff6fe1ae84051f679c6a9f7266b47"}, {"url": "/docs/19/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "c827f460db781b39da305303c88e73729a419cd2b2b9dedb126d8ad5cbf02c95"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.18.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/19/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/19/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/19/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.29.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>In the absence of fatal errors, <span class=\"application\">pg_recvlogical</span> will run until terminated by the <span class=\"systemitem\">SIGINT</span> (<span class=\"keycap\"><strong>Control</strong></span>+<span class=\"keycap\"><strong>C</strong></span>) or <span class=\"systemitem\">SIGTERM</span> signal.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--slot</code> and <code class=\"option\">--dbname</code> options are required for this action.</p>\n<p>The <code class=\"option\">--enable-two-phase</code> and <code class=\"option\">--enable-failover</code> options can be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n<p>The <code class=\"option\">--slot</code> option is required for this action.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The <code class=\"option\">--slot</code>, <code class=\"option\">--dbname</code>, and <code class=\"option\">--file</code> options are required for this action.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--enable-failover</code></span></dt>\n<dd>\n<p>Enables the slot to be synchronized to the standbys. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n<p>This parameter is required for <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk. The default value is 10 seconds.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/19/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a> and <a class=\"xref\" href=\"/docs/19/protocol-replication.html\" title=\"54.4.\u00a0Streaming Replication Protocol\">Section\u00a054.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/19/logicaldecoding-output-plugin.html\" title=\"47.6.\u00a0Logical Decoding Output Plugins\">Section\u00a047.6</a> for information about the plugins <span class=\"productname\">PostgreSQL</span> provides. The default is <a class=\"xref\" href=\"/docs/19/test-decoding.html\" title=\"F.47.\u00a0test_decoding \u2014 SQL-based test/example module for WAL logical decoding\">test_decoding</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/19/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n<p>This parameter is required for any of actions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--enable-two-phase</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code> (deprecated)</span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/19/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"32.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options.</p>\n<p>This parameter is required for <code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.7\">\n<h2>Exit Status</h2>\n<p><span class=\"application\">pg_recvlogical</span> will exit with status 0 when terminated by the <span class=\"systemitem\">SIGINT</span> or <span class=\"systemitem\">SIGTERM</span> signal. (That is the normal way to end it. Hence it is not an error.) For fatal errors or other signals, the exit status will be nonzero.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.8\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/19/libpq-envars.html\" title=\"32.15.\u00a0Environment Variables\">Section\u00a032.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.9\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.10\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/19/logicaldecoding-example.html\" title=\"47.1.\u00a0Logical Decoding Examples\">Section\u00a047.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.11\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/19/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --dbname options are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot option is required for this action."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot , --dbname , and --file options are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "signature": "--enable-failover", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "signature": "-t --enable-two-phase --two-phase (deprecated)", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "e9ce81359df13a6aca69534fe93297793b0f28a248800e47da8b2639c2198c12"}, "20": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "20devel"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "24"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "--enable-failover"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-t --enable-two-phase --two-phase (deprecated)"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/devel/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 --dbname options are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot option is required for this action."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot , --dbname , and --file options are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": "--enable-failover", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": "-t --enable-two-phase --two-phase (deprecated)", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/devel/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=20", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/snapshot/dev/postgresql-snapshot.tar.bz2", "label": "20devel", "major": "20", "channel": "devel", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/20/postgresql-20-A4.pdf", "bytes": 16030631, "pages": 3052, "sha256": "bd5d82c0ce38fc18f92a0447818a91a193a261776bca1c37564bf9a683e177d0", "built_at": "2026-09-28"}, "US": {"url": "/files/documentation/pdf/20/postgresql-20-US.pdf", "bytes": 15936613, "pages": 3223, "sha256": "d97d9e0db479a02f4234b175f50fcad70c3661619afc8d6df9b9437882e3c299", "built_at": "2026-09-28"}}, "tree": "0", "index": "index.html", "major": "20", "pages": 1156, "release": "20devel", "source_url": "https://ftp.postgresql.org/pub/snapshot/dev/postgresql-snapshot.tar.bz2", "svg_assets": 6, "source_mode": "en SGML built with pinned official archive", "source_sha256": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41", "source_snapshot_utc": "26-Sep-2026 20:22"}, "revision": "2eba5e0fd4c3bffb2803247b6cd537878e9d6ee5a6dfbe3c50ece8b421b80918", "evidence_kind": "English manual and source declarations", "source_sha256": "4d3346909b201ac1648232cf290462a7070c119326f56196f1f0253ed80fae41"}, "sources": [{"url": "/docs/devel/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "20devel English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "41f5974cc601de99266a140d005c11de899e48c564a8bd07e13714154f808d32"}, {"url": "/docs/devel/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "a6c7ba748fa1d9feac5bb7cde41d1d36a1f4c26d5963e07fb103d02918b2a8ca"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.18.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/devel/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/devel/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/devel/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.29.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>In the absence of fatal errors, <span class=\"application\">pg_recvlogical</span> will run until terminated by the <span class=\"systemitem\">SIGINT</span> (<span class=\"keycap\"><strong>Control</strong></span>+<span class=\"keycap\"><strong>C</strong></span>) or <span class=\"systemitem\">SIGTERM</span> signal.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--slot</code> and <code class=\"option\">--dbname</code> options are required for this action.</p>\n<p>The <code class=\"option\">--enable-two-phase</code> and <code class=\"option\">--enable-failover</code> options can be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n<p>The <code class=\"option\">--slot</code> option is required for this action.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The <code class=\"option\">--slot</code>, <code class=\"option\">--dbname</code>, and <code class=\"option\">--file</code> options are required for this action.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--enable-failover</code></span></dt>\n<dd>\n<p>Enables the slot to be synchronized to the standbys. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n<p>This parameter is required for <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk. The default value is 10 seconds.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/devel/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a> and <a class=\"xref\" href=\"/docs/devel/protocol-replication.html\" title=\"54.4.\u00a0Streaming Replication Protocol\">Section\u00a054.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/devel/logicaldecoding-output-plugin.html\" title=\"47.6.\u00a0Logical Decoding Output Plugins\">Section\u00a047.6</a> for information about the plugins <span class=\"productname\">PostgreSQL</span> provides. The default is <a class=\"xref\" href=\"/docs/devel/test-decoding.html\" title=\"F.47.\u00a0test_decoding \u2014 SQL-based test/example module for WAL logical decoding\">test_decoding</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/devel/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n<p>This parameter is required for any of actions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--enable-two-phase</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code> (deprecated)</span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/devel/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"32.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options.</p>\n<p>This parameter is required for <code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.7\">\n<h2>Exit Status</h2>\n<p><span class=\"application\">pg_recvlogical</span> will exit with status 0 when terminated by the <span class=\"systemitem\">SIGINT</span> or <span class=\"systemitem\">SIGTERM</span> signal. (That is the normal way to end it. Hence it is not an error.) For fatal errors or other signals, the exit status will be nonzero.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.8\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/devel/libpq-envars.html\" title=\"32.14.\u00a0Environment Variables\">Section\u00a032.14</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.9\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.10\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/devel/logicaldecoding-example.html\" title=\"47.1.\u00a0Logical Decoding Examples\">Section\u00a047.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.11\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/devel/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --dbname options are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot option is required for this action."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot , --dbname , and --file options are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "signature": "--enable-failover", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The default value is 10 seconds. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Section 47.6 for information about the plugins PostgreSQL provides. The default is test_decoding . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "signature": "-t --enable-two-phase --two-phase (deprecated)", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "e9ce81359df13a6aca69534fe93297793b0f28a248800e47da8b2639c2198c12"}}}, "snapshot": {"facts": [{"label": "Documented executable", "value": "pg_recvlogical"}, {"label": "Executable version", "value": "18.6"}, {"label": "Reference inventory", "value": "Client applications"}, {"label": "Option definition groups", "value": "24"}], "tables": [{"key": "options", "rows": [{"summary": "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 .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--create-slot"}}, {"summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--drop-slot"}}, {"summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--start"}}, {"summary": "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 is raised.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-E lsn --endpos= lsn"}}, {"summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--enable-failover"}}, {"summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-f filename --file= filename"}}, {"summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-F interval_seconds --fsync-interval= interval_seconds"}}, {"summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-I lsn --startpos= lsn"}}, {"summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "--if-not-exists"}}, {"summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-n --no-loop"}}, {"summary": "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 plugin.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-o name [= value ] --option= name [= value ]"}}, {"summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-P plugin --plugin= plugin"}}, {"summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-s interval_seconds --status-interval= interval_seconds"}}, {"summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-S slot_name --slot= slot_name"}}, {"summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-t --enable-two-phase --two-phase (deprecated)"}}, {"summary": "Enables verbose mode.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-v --verbose"}}, {"summary": "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 parameters will override any conflicting command line options.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-d dbname --dbname= dbname"}}, {"summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-h hostname-or-ip --host= hostname-or-ip"}}, {"summary": "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 a compiled-in default.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-p port --port= port"}}, {"summary": "User name to connect as. Defaults to current operating system user name.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-U user --username= user"}}, {"summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-w --no-password"}}, {"summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-W --password"}}, {"summary": "Print the pg_recvlogical version and exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-V --version"}}, {"summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": {"url": "/docs/18/app-pgrecvlogical.html", "text": "-? --help"}}], "title": "Documented options", "columns": [{"key": "signature", "label": "Option and arguments"}, {"key": "summary", "label": "Description"}]}], "options": [{"names": ["--create-slot"], "summary": "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 .", "signature": "--create-slot", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 --dbname are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "summary": "Drop the replication slot with the name specified by --slot , then exit.", "signature": "--drop-slot", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot is required for this action."}, {"names": ["--start"], "summary": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified.", "signature": "--start", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot and --dbname , --file are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "summary": "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 is raised.", "signature": "-E lsn --endpos= lsn", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "summary": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot .", "signature": "--enable-failover", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "summary": "Write received and decoded transaction data into this file. Use - for stdout .", "signature": "-f filename --file= filename", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "summary": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk.", "signature": "-F interval_seconds --fsync-interval= interval_seconds", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "summary": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes.", "signature": "-I lsn --startpos= lsn", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "summary": "Do not error out when --create-slot is specified and a slot with the specified name already exists.", "signature": "--if-not-exists", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "summary": "When the connection to the server is lost, do not retry in a loop, just exit.", "signature": "-n --no-loop", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "summary": "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 plugin.", "signature": "-o name [= value ] --option= name [= value ]", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "summary": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists.", "signature": "-P plugin --plugin= plugin", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "summary": "This option has the same effect as the option of the same name in pg_receivewal . See the description there.", "signature": "-s interval_seconds --status-interval= interval_seconds", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "summary": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name.", "signature": "-S slot_name --slot= slot_name", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "summary": "Enables decoding of prepared transactions. This option may only be specified with --create-slot .", "signature": "-t --enable-two-phase --two-phase (deprecated)", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "summary": "Enables verbose mode.", "signature": "-v --verbose", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "summary": "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 parameters will override any conflicting command line options.", "signature": "-d dbname --dbname= dbname", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "summary": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted.", "signature": "-h hostname-or-ip --host= hostname-or-ip", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "summary": "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 a compiled-in default.", "signature": "-p port --port= port", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "summary": "User name to connect as. Defaults to current operating system user name.", "signature": "-U user --username= user", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "summary": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.", "signature": "-w --no-password", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "summary": "Force pg_recvlogical to prompt for a password before connecting to a database.", "signature": "-W --password", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "summary": "Print the pg_recvlogical version and exit.", "signature": "-V --version", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "summary": "Show help about pg_recvlogical command line arguments, and exit.", "signature": "-? --help", "source_url": "/docs/18/app-pgrecvlogical.html", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "related": [{"url": "/wiki/conn/?v=18", "label": "libpq connection parameters"}], "release": {"ref": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "label": "18.6", "major": "18", "channel": "stable", "manifest": {"pdf": {"A4": {"url": "/files/documentation/pdf/18/postgresql-18-A4.pdf", "bytes": 15865106, "pages": 3154, "sha256": "19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190", "built_at": "2026-09-26"}, "US": {"url": "/files/documentation/pdf/18/postgresql-18-US.pdf", "bytes": 15748059, "pages": 3328, "sha256": "facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319", "built_at": "2026-09-26"}}, "tree": "18", "index": "index.html", "major": "18", "pages": 1148, "release": "18.6", "source_url": "https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2", "svg_assets": 3, "source_mode": "en SGML built with pinned official archive", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "revision": "ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8", "evidence_kind": "English manual and source declarations", "source_sha256": "555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"}, "sources": [{"url": "/docs/18/app-pgrecvlogical.html", "file": "app-pgrecvlogical.html", "label": "18.6 English manual \u00b7 app-pgrecvlogical.html", "anchor": "", "sha256": "3052f6f3caa9b5cca077878cde0cd9f927a9489aaf13cc41209fa504c1327f39"}, {"url": "/docs/18/reference-client.html", "file": "reference-client.html", "label": "Client applications inventory", "anchor": "", "sha256": "68f726af77272fe73a827be2b7b5958d0f2239a6f8ed44264e9d42496bfa4fd0"}], "sections": [], "synopsis": ["pg_recvlogical [ option ...]"], "signature": "pg_recvlogical [ option ...]", "description": ["pg_recvlogical \u2014 control PostgreSQL logical decoding streams"], "environment": [], "manual_html": "<div><div class=\"refentry\" id=\"APP-PGRECVLOGICAL\">\n<div class=\"titlepage\"></div>\n<div class=\"refnamediv\">\n<h2><span class=\"refentrytitle\"><span class=\"application\">pg_recvlogical</span></span></h2>\n<p>pg_recvlogical \u2014 control <span class=\"productname\">PostgreSQL</span> logical decoding streams</p>\n</div>\n<div class=\"refsynopsisdiv\">\n<h2>Synopsis</h2>\n<div class=\"cmdsynopsis\">\n<p id=\"id-1.9.4.18.4.1\"><code class=\"command\">pg_recvlogical</code> [<em class=\"replaceable\"><code>option</code></em>...]</p>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.5\">\n<h2>Description</h2>\n<p><code class=\"command\">pg_recvlogical</code> controls logical decoding replication slots and streams data from such replication slots.</p>\n<p>It creates a replication-mode connection, so it is subject to the same constraints as <a class=\"xref\" href=\"/docs/18/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>, plus those for logical replication (see <a class=\"xref\" href=\"/docs/18/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>).</p>\n<p><code class=\"command\">pg_recvlogical</code> has no equivalent to the logical decoding SQL interface's peek and get modes. It sends replay confirmations for data lazily as it receives it and on clean exit. To examine pending data on a slot without consuming it, use <a class=\"link\" href=\"/docs/18/functions-admin.html#FUNCTIONS-REPLICATION\" title=\"9.28.6.\u00a0Replication Management Functions\"><code class=\"function\">pg_logical_slot_peek_changes</code></a>.</p>\n<p>In the absence of fatal errors, <span class=\"application\">pg_recvlogical</span> will run until terminated by the <span class=\"systemitem\">SIGINT</span> (<span class=\"keycap\"><strong>Control</strong></span>+<span class=\"keycap\"><strong>C</strong></span>) or <span class=\"systemitem\">SIGTERM</span> signal.</p>\n<p>When <span class=\"application\">pg_recvlogical</span> receives a <span class=\"systemitem\">SIGHUP</span> signal, it closes the current output file and opens a new one using the filename specified by the <code class=\"option\">--file</code> option. This allows us to rotate the output file by first renaming the current file and then sending a <span class=\"systemitem\">SIGHUP</span> signal to <span class=\"application\">pg_recvlogical</span>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.6\">\n<h2>Options</h2>\n<p>At least one of the following options must be specified to select an action:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">--create-slot</code></span></dt>\n<dd>\n<p>Create a new logical replication slot with the name specified by <code class=\"option\">--slot</code>, using the output plugin specified by <code class=\"option\">--plugin</code>, for the database specified by <code class=\"option\">--dbname</code>.</p>\n<p>The <code class=\"option\">--slot</code> and <code class=\"option\">--dbname</code> are required for this action.</p>\n<p>The <code class=\"option\">--enable-two-phase</code> and <code class=\"option\">--enable-failover</code> options can be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--drop-slot</code></span></dt>\n<dd>\n<p>Drop the replication slot with the name specified by <code class=\"option\">--slot</code>, then exit.</p>\n<p>The <code class=\"option\">--slot</code> is required for this action.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--start</code></span></dt>\n<dd>\n<p>Begin streaming changes from the logical replication slot specified by <code class=\"option\">--slot</code>, continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless <code class=\"option\">--no-loop</code> is specified.</p>\n<p>The <code class=\"option\">--slot</code> and <code class=\"option\">--dbname</code>, <code class=\"option\">--file</code> are required for this action.</p>\n<p>The stream format is determined by the output plugin specified when the slot was created.</p>\n<p>The connection must be to the same database used to create the slot.</p>\n</dd>\n</dl>\n</div>\n<p><code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code> can be specified together. <code class=\"option\">--drop-slot</code> cannot be combined with another action.</p>\n<p>The following command-line options control the location and format of the output and other replication behavior:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-E <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--endpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, automatically stop replication and exit with normal exit status 0 when receiving reaches the specified LSN. If specified when not in <code class=\"option\">--start</code> mode, an error is raised.</p>\n<p>If there's a record with LSN exactly equal to <em class=\"replaceable\"><code>lsn</code></em>, the record will be output.</p>\n<p>The <code class=\"option\">--endpos</code> option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--enable-failover</code></span></dt>\n<dd>\n<p>Enables the slot to be synchronized to the standbys. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-f <em class=\"replaceable\"><code>filename</code></em></code><br></span><span class=\"term\"><code class=\"option\">--file=<em class=\"replaceable\"><code>filename</code></em></code></span></dt>\n<dd>\n<p>Write received and decoded transaction data into this file. Use <code class=\"literal\">-</code> for <span class=\"systemitem\">stdout</span>.</p>\n<p>This parameter is required for <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-F <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--fsync-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>Specifies how often <span class=\"application\">pg_recvlogical</span> should issue <code class=\"function\">fsync()</code> calls to ensure the output file is safely flushed to disk.</p>\n<p>The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently.</p>\n<p>Specifying an interval of <code class=\"literal\">0</code> disables issuing <code class=\"function\">fsync()</code> calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-I <em class=\"replaceable\"><code>lsn</code></em></code><br></span><span class=\"term\"><code class=\"option\">--startpos=<em class=\"replaceable\"><code>lsn</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, start replication from the given LSN. For details on the effect of this, see the documentation in <a class=\"xref\" href=\"/docs/18/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a> and <a class=\"xref\" href=\"/docs/18/protocol-replication.html\" title=\"54.4.\u00a0Streaming Replication Protocol\">Section\u00a054.4</a>. Ignored in other modes.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">--if-not-exists</code></span></dt>\n<dd>\n<p>Do not error out when <code class=\"option\">--create-slot</code> is specified and a slot with the specified name already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-n</code><br></span><span class=\"term\"><code class=\"option\">--no-loop</code></span></dt>\n<dd>\n<p>When the connection to the server is lost, do not retry in a loop, just exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-o <em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code><br></span><span class=\"term\"><code class=\"option\">--option=<em class=\"replaceable\"><code>name</code></em>[=<em class=\"replaceable\"><code>value</code></em>]</code></span></dt>\n<dd>\n<p>Pass the option <em class=\"replaceable\"><code>name</code></em> to the output plugin with, if specified, the option value <em class=\"replaceable\"><code>value</code></em>. Which options exist and their effects depends on the used output plugin.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-P <em class=\"replaceable\"><code>plugin</code></em></code><br></span><span class=\"term\"><code class=\"option\">--plugin=<em class=\"replaceable\"><code>plugin</code></em></code></span></dt>\n<dd>\n<p>When creating a slot, use the specified logical decoding output plugin. See <a class=\"xref\" href=\"/docs/18/logicaldecoding.html\" title=\"Chapter\u00a047.\u00a0Logical Decoding\">Chapter\u00a047</a>. This option has no effect if the slot already exists.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-s <em class=\"replaceable\"><code>interval_seconds</code></em></code><br></span><span class=\"term\"><code class=\"option\">--status-interval=<em class=\"replaceable\"><code>interval_seconds</code></em></code></span></dt>\n<dd>\n<p>This option has the same effect as the option of the same name in <a class=\"xref\" href=\"/docs/18/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a>. See the description there.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-S <em class=\"replaceable\"><code>slot_name</code></em></code><br></span><span class=\"term\"><code class=\"option\">--slot=<em class=\"replaceable\"><code>slot_name</code></em></code></span></dt>\n<dd>\n<p>In <code class=\"option\">--start</code> mode, use the existing logical replication slot named <em class=\"replaceable\"><code>slot_name</code></em>. In <code class=\"option\">--create-slot</code> mode, create the slot with this name. In <code class=\"option\">--drop-slot</code> mode, delete the slot with this name.</p>\n<p>This parameter is required for any of actions.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-t</code><br></span><span class=\"term\"><code class=\"option\">--enable-two-phase</code><br></span><span class=\"term\"><code class=\"option\">--two-phase</code> (deprecated)</span></dt>\n<dd>\n<p>Enables decoding of prepared transactions. This option may only be specified with <code class=\"option\">--create-slot</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-v</code><br></span><span class=\"term\"><code class=\"option\">--verbose</code></span></dt>\n<dd>\n<p>Enables verbose mode.</p>\n</dd>\n</dl>\n</div>\n<p>The following command-line options control the database connection parameters.</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-d <em class=\"replaceable\"><code>dbname</code></em></code><br></span><span class=\"term\"><code class=\"option\">--dbname=<em class=\"replaceable\"><code>dbname</code></em></code></span></dt>\n<dd>\n<p>The database to connect to. See the description of the actions for what this means in detail. The <em class=\"replaceable\"><code>dbname</code></em> can be a <a class=\"link\" href=\"/docs/18/libpq-connect.html#LIBPQ-CONNSTRING\" title=\"32.1.1.\u00a0Connection Strings\">connection string</a>. If so, connection string parameters will override any conflicting command line options.</p>\n<p>This parameter is required for <code class=\"option\">--create-slot</code> and <code class=\"option\">--start</code>.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-h <em class=\"replaceable\"><code>hostname-or-ip</code></em></code><br></span><span class=\"term\"><code class=\"option\">--host=<em class=\"replaceable\"><code>hostname-or-ip</code></em></code></span></dt>\n<dd>\n<p>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 is taken from the <code class=\"envar\">PGHOST</code> environment variable, if set, else a Unix domain socket connection is attempted.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-p <em class=\"replaceable\"><code>port</code></em></code><br></span><span class=\"term\"><code class=\"option\">--port=<em class=\"replaceable\"><code>port</code></em></code></span></dt>\n<dd>\n<p>Specifies the TCP port or local Unix domain socket file extension on which the server is listening for connections. Defaults to the <code class=\"envar\">PGPORT</code> environment variable, if set, or a compiled-in default.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-U <em class=\"replaceable\"><code>user</code></em></code><br></span><span class=\"term\"><code class=\"option\">--username=<em class=\"replaceable\"><code>user</code></em></code></span></dt>\n<dd>\n<p>User name to connect as. Defaults to current operating system user name.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-w</code><br></span><span class=\"term\"><code class=\"option\">--no-password</code></span></dt>\n<dd>\n<p>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a <code class=\"filename\">.pgpass</code> file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-W</code><br></span><span class=\"term\"><code class=\"option\">--password</code></span></dt>\n<dd>\n<p>Force <span class=\"application\">pg_recvlogical</span> to prompt for a password before connecting to a database.</p>\n<p>This option is never essential, since <span class=\"application\">pg_recvlogical</span> will automatically prompt for a password if the server demands password authentication. However, <span class=\"application\">pg_recvlogical</span> will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing <code class=\"option\">-W</code> to avoid the extra connection attempt.</p>\n</dd>\n</dl>\n</div>\n<p>The following additional options are available:</p>\n<div class=\"variablelist\">\n<dl class=\"variablelist\">\n<dt><span class=\"term\"><code class=\"option\">-V</code><br></span><span class=\"term\"><code class=\"option\">--version</code></span></dt>\n<dd>\n<p>Print the <span class=\"application\">pg_recvlogical</span> version and exit.</p>\n</dd>\n<dt><span class=\"term\"><code class=\"option\">-?</code><br></span><span class=\"term\"><code class=\"option\">--help</code></span></dt>\n<dd>\n<p>Show help about <span class=\"application\">pg_recvlogical</span> command line arguments, and exit.</p>\n</dd>\n</dl>\n</div>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.7\">\n<h2>Exit Status</h2>\n<p><span class=\"application\">pg_recvlogical</span> will exit with status 0 when terminated by the <span class=\"systemitem\">SIGINT</span> or <span class=\"systemitem\">SIGTERM</span> signal. (That is the normal way to end it. Hence it is not an error.) For fatal errors or other signals, the exit status will be nonzero.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.8\">\n<h2>Environment</h2>\n<p>This utility, like most other <span class=\"productname\">PostgreSQL</span> utilities, uses the environment variables supported by <span class=\"application\">libpq</span> (see <a class=\"xref\" href=\"/docs/18/libpq-envars.html\" title=\"32.15.\u00a0Environment Variables\">Section\u00a032.15</a>).</p>\n<p>The environment variable <code class=\"envar\">PG_COLOR</code> specifies whether to use color in diagnostic messages. Possible values are <code class=\"literal\">always</code>, <code class=\"literal\">auto</code> and <code class=\"literal\">never</code>.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.9\">\n<h2>Notes</h2>\n<p><span class=\"application\">pg_recvlogical</span> will preserve group permissions on the output files if group permissions are enabled on the source cluster.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.10\">\n<h2>Examples</h2>\n<p>See <a class=\"xref\" href=\"/docs/18/logicaldecoding-example.html\" title=\"47.1.\u00a0Logical Decoding Examples\">Section\u00a047.1</a> for an example.</p>\n</div>\n<div class=\"refsect1\" id=\"id-1.9.4.18.11\">\n<h2>See Also</h2><span class=\"simplelist\"><a class=\"xref\" href=\"/docs/18/app-pgreceivewal.html\" title=\"pg_receivewal\"><span class=\"refentrytitle\"><span class=\"application\">pg_receivewal</span></span></a></span>\n</div>\n</div></div>", "manual_path": "app-pgrecvlogical.html", "comparison_data": {"options": [{"names": ["--create-slot"], "signature": "--create-slot", "description": "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 --dbname are required for this action. The --enable-two-phase and --enable-failover options can be specified with --create-slot ."}, {"names": ["--drop-slot"], "signature": "--drop-slot", "description": "Drop the replication slot with the name specified by --slot , then exit. The --slot is required for this action."}, {"names": ["--start"], "signature": "--start", "description": "Begin streaming changes from the logical replication slot specified by --slot , continuing until terminated by a signal. If the server side change stream ends with a server shutdown or disconnect, retry in a loop unless --no-loop is specified. The --slot and --dbname , --file are required for this action. The stream format is determined by the output plugin specified when the slot was created. The connection must be to the same database used to create the slot."}, {"names": ["-E lsn", "--endpos= lsn"], "signature": "-E lsn --endpos= lsn", "description": "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 is raised. If there's a record with LSN exactly equal to lsn , the record will be output. The --endpos option is not aware of transaction boundaries and may truncate output partway through a transaction. Any partially output transaction will not be consumed and will be replayed again when the slot is next read from. Individual messages are never truncated."}, {"names": ["--enable-failover"], "signature": "--enable-failover", "description": "Enables the slot to be synchronized to the standbys. This option may only be specified with --create-slot ."}, {"names": ["-f filename", "--file= filename"], "signature": "-f filename --file= filename", "description": "Write received and decoded transaction data into this file. Use - for stdout . This parameter is required for --start ."}, {"names": ["-F interval_seconds", "--fsync-interval= interval_seconds"], "signature": "-F interval_seconds --fsync-interval= interval_seconds", "description": "Specifies how often pg_recvlogical should issue fsync() calls to ensure the output file is safely flushed to disk. The server will occasionally request the client to perform a flush and report the flush position to the server. This setting is in addition to that, to perform flushes more frequently. Specifying an interval of 0 disables issuing fsync() calls altogether, while still reporting progress to the server. In this case, data could be lost in the event of a crash."}, {"names": ["-I lsn", "--startpos= lsn"], "signature": "-I lsn --startpos= lsn", "description": "In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 47 and Section 54.4 . Ignored in other modes."}, {"names": ["--if-not-exists"], "signature": "--if-not-exists", "description": "Do not error out when --create-slot is specified and a slot with the specified name already exists."}, {"names": ["-n", "--no-loop"], "signature": "-n --no-loop", "description": "When the connection to the server is lost, do not retry in a loop, just exit."}, {"names": ["-o name [= value ]", "--option= name [= value ]"], "signature": "-o name [= value ] --option= name [= value ]", "description": "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 plugin."}, {"names": ["-P plugin", "--plugin= plugin"], "signature": "-P plugin --plugin= plugin", "description": "When creating a slot, use the specified logical decoding output plugin. See Chapter 47 . This option has no effect if the slot already exists."}, {"names": ["-s interval_seconds", "--status-interval= interval_seconds"], "signature": "-s interval_seconds --status-interval= interval_seconds", "description": "This option has the same effect as the option of the same name in pg_receivewal . See the description there."}, {"names": ["-S slot_name", "--slot= slot_name"], "signature": "-S slot_name --slot= slot_name", "description": "In --start mode, use the existing logical replication slot named slot_name . In --create-slot mode, create the slot with this name. In --drop-slot mode, delete the slot with this name. This parameter is required for any of actions."}, {"names": ["-t", "--enable-two-phase", "--two-phase"], "signature": "-t --enable-two-phase --two-phase (deprecated)", "description": "Enables decoding of prepared transactions. This option may only be specified with --create-slot ."}, {"names": ["-v", "--verbose"], "signature": "-v --verbose", "description": "Enables verbose mode."}, {"names": ["-d dbname", "--dbname= dbname"], "signature": "-d dbname --dbname= dbname", "description": "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 parameters will override any conflicting command line options. This parameter is required for --create-slot and --start ."}, {"names": ["-h hostname-or-ip", "--host= hostname-or-ip"], "signature": "-h hostname-or-ip --host= hostname-or-ip", "description": "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 is taken from the PGHOST environment variable, if set, else a Unix domain socket connection is attempted."}, {"names": ["-p port", "--port= port"], "signature": "-p port --port= port", "description": "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 a compiled-in default."}, {"names": ["-U user", "--username= user"], "signature": "-U user --username= user", "description": "User name to connect as. Defaults to current operating system user name."}, {"names": ["-w", "--no-password"], "signature": "-w --no-password", "description": "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 will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password."}, {"names": ["-W", "--password"], "signature": "-W --password", "description": "Force pg_recvlogical to prompt for a password before connecting to a database. This option is never essential, since pg_recvlogical will automatically prompt for a password if the server demands password authentication. However, pg_recvlogical will waste a connection attempt finding out that the server wants a password. In some cases it is worth typing -W to avoid the extra connection attempt."}, {"names": ["-V", "--version"], "signature": "-V --version", "description": "Print the pg_recvlogical version and exit."}, {"names": ["-?", "--help"], "signature": "-? --help", "description": "Show help about pg_recvlogical command line arguments, and exit."}], "synopsis": ["pg_recvlogical [ option ...]"], "environment": []}, "comparison_hash": "7e4d124b6d72f9dbcf5a935f6ef5cfdac9d56466c979b9dabadfcd070a54dfeb"}, "comparison": {"left": "13", "right": "14", "status": "changed", "diff": "--- PostgreSQL 13\n+++ PostgreSQL 14\n@@ -47,7 +47,7 @@\n       \"signature\": \"-F interval_seconds --fsync-interval= interval_seconds\"\n     },\n     {\n-      \"description\": \"In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 48 and Section 52.4 . Ignored in other modes.\",\n+      \"description\": \"In --start mode, start replication from the given LSN. For details on the effect of this, see the documentation in Chapter 49 and Section 53.4 . Ignored in other modes.\",\n       \"names\": [\n         \"-I lsn\",\n         \"--startpos= lsn\"\n@@ -78,7 +78,7 @@\n       \"signature\": \"-o name [= value ] --option= name [= value ]\"\n     },\n     {\n-      \"description\": \"When creating a slot, use the specified logical decoding output plugin. See Chapter 48 . This option has no effect if the slot already exists.\",\n+      \"description\": \"When creating a slot, use the specified logical decoding output plugin. See Chapter 49 . This option has no effect if the slot already exists.\",\n       \"names\": [\n         \"-P plugin\",\n         \"--plugin= plugin\""}}