doc: Fix description of replication command CREATE_REPLICATION_SLOT

michaelpq · michaelpq · commit 63585b1ebd0d · 2022-10-13T08:53:42.000+09:00
The output plugin name is a mandatory option when creating a logical slot, but the grammar documented was not described as such. While on it, fix two comments in repl_gram.y to show that TEMPORARY is an optional grammar choice. Author: Ayaki Tachikake Discussion: https://postgr.es/m/OSAPR01MB2852607B2329FFA27834105AF1229@OSAPR01MB2852.jpnprd01.prod.outlook.com Backpatch-through: 15
diff --git a/doc/src/sgml/protocol.sgml b/doc/src/sgml/protocol.sgml
@@ -1987,7 +1987,7 @@ psql "dbname=postgres replication=database" -c "IDENTIFY_SYSTEM;"
     </varlistentry>
 
     <varlistentry id="protocol-replication-create-replication-slot" xreflabel="CREATE_REPLICATION_SLOT">
-     <term><literal>CREATE_REPLICATION_SLOT</literal> <replaceable class="parameter">slot_name</replaceable> [ <literal>TEMPORARY</literal> ] { <literal>PHYSICAL</literal> | <literal>LOGICAL</literal> } [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ]
+     <term><literal>CREATE_REPLICATION_SLOT</literal> <replaceable class="parameter">slot_name</replaceable> [ <literal>TEMPORARY</literal> ] { <literal>PHYSICAL</literal> | <literal>LOGICAL</literal> <replaceable class="parameter">output_plugin</replaceable> } [ ( <replaceable class="parameter">option</replaceable> [, ...] ) ]
       <indexterm><primary>CREATE_REPLICATION_SLOT</primary></indexterm>
      </term>
      <listitem>
diff --git a/src/backend/replication/repl_gram.y b/src/backend/replication/repl_gram.y
@@ -172,7 +172,7 @@ base_backup:
 			;
 
 create_replication_slot:
-			/* CREATE_REPLICATION_SLOT slot TEMPORARY PHYSICAL [options] */
+			/* CREATE_REPLICATION_SLOT slot [TEMPORARY] PHYSICAL [options] */
 			K_CREATE_REPLICATION_SLOT IDENT opt_temporary K_PHYSICAL create_slot_options
 				{
 					CreateReplicationSlotCmd *cmd;
@@ -183,7 +183,7 @@ create_replication_slot:
 					cmd->options = $5;
 					$$ = (Node *) cmd;
 				}
-			/* CREATE_REPLICATION_SLOT slot TEMPORARY LOGICAL plugin [options] */
+			/* CREATE_REPLICATION_SLOT slot [TEMPORARY] LOGICAL plugin [options] */
 			| K_CREATE_REPLICATION_SLOT IDENT opt_temporary K_LOGICAL IDENT create_slot_options
 				{
 					CreateReplicationSlotCmd *cmd;

Original file line number	Diff line number	Diff line change
`@@ -172,7 +172,7 @@ base_backup:`
`172`	`172`	`;`
`173`	`173`
`174`	`174`	`create_replication_slot:`
`175`		`- /* CREATE_REPLICATION_SLOT slot TEMPORARY PHYSICAL [options] */`
	`175`	`+ /* CREATE_REPLICATION_SLOT slot [TEMPORARY] PHYSICAL [options] */`
`176`	`176`	`K_CREATE_REPLICATION_SLOT IDENT opt_temporary K_PHYSICAL create_slot_options`
`177`	`177`	`{`
`178`	`178`	`CreateReplicationSlotCmd *cmd;`
`@@ -183,7 +183,7 @@ create_replication_slot:`
`183`	`183`	`cmd->options = $5;`
`184`	`184`	`$$ = (Node *) cmd;`
`185`	`185`	`}`
`186`		`- /* CREATE_REPLICATION_SLOT slot TEMPORARY LOGICAL plugin [options] */`
	`186`	`+ /* CREATE_REPLICATION_SLOT slot [TEMPORARY] LOGICAL plugin [options] */`
`187`	`187`	`\| K_CREATE_REPLICATION_SLOT IDENT opt_temporary K_LOGICAL IDENT create_slot_options`
`188`	`188`	`{`
`189`	`189`	`CreateReplicationSlotCmd *cmd;`