Rename pg_recvlogical's --create/--drop to --create-slot/--drop-slot.

anarazel · anarazel · commit c8b6cba84a98 · 2014-10-06T12:11:52.000+02:00
A future patch (9.5 only) adds slot management to pg_receivexlog. The
verbs create/drop don't seem descriptive enough there. It seems better
to rename pg_recvlogical's commands now, in beta, than live with the
inconsistency forever.

The old form (e.g. --drop) will still be accepted by virtue of most
getopt_long() options accepting abbreviations for long commands.

Backpatch to 9.4 where pg_recvlogical was introduced.

Author: Michael Paquier and Andres Freund
Discussion: CAB7nPqQtt79U6FmhwvgqJmNyWcVCbbV-nS72j_jyPEopERg9rg@mail.gmail.com
diff --git a/doc/src/sgml/logicaldecoding.sgml b/doc/src/sgml/logicaldecoding.sgml
@@ -149,7 +149,7 @@ postgres=# SELECT pg_drop_replication_slot('regression_slot');
     another connection.
    </para>
 <programlisting>
-# pg_recvlogical -d postgres --slot test --create
+# pg_recvlogical -d postgres --slot test --create-slot
 # pg_recvlogical -d postgres --slot test --start -f -
 CTRL-Z
 # psql -d postgres -c "INSERT INTO data(data) VALUES('4');"
@@ -158,7 +158,7 @@ BEGIN 693
 table public.data: INSERT: id[integer]:4 data[text]:'4'
 COMMIT 693
 CTRL-C
-# pg_recvlogical -d postgres --slot test --drop
+# pg_recvlogical -d postgres --slot test --drop-slot
 </programlisting>
   </sect1>
   <sect1 id="logicaldecoding-explanation">
diff --git a/doc/src/sgml/ref/pg_recvlogical.sgml b/doc/src/sgml/ref/pg_recvlogical.sgml
@@ -53,7 +53,7 @@ PostgreSQL documentation
     <variablelist>
 
      <varlistentry>
-      <term><option>--create</option></term>
+      <term><option>--create-slot</option></term>
       <listitem>
        <para>
         Create a new logical replication slot with the name specified in
@@ -82,7 +82,7 @@ PostgreSQL documentation
      </varlistentry>
 
      <varlistentry>
-      <term><option>--drop</option></term>
+      <term><option>--drop-slot</option></term>
       <listitem>
        <para>
         Drop the replication slot with the name specified
@@ -266,8 +266,9 @@ PostgreSQL documentation
       <listitem>
        <para>
         In <option>--start</option> mode, use the existing logical replication slot named
-        <replaceable>slot_name</replaceable>. In <option>--create</option> mode, create the
-        slot with this name. In <option>--drop</option> mode, delete the slot with this name.
+        <replaceable>slot_name</replaceable>. In <option>--create-slot</option>
+        mode, create the slot with this name. In <option>--drop-slot</option>
+        mode, delete the slot with this name.
        </para>
       </listitem>
      </varlistentry>
diff --git a/src/bin/pg_basebackup/pg_recvlogical.c b/src/bin/pg_basebackup/pg_recvlogical.c
@@ -91,9 +91,9 @@ usage(void)
 			 "                         time between status packets sent to server (default: %d)\n"), (standby_message_timeout / 1000));
 	printf(_("  -S, --slot=SLOT        name of the logical replication slot\n"));
 	printf(_("\nAction to be performed:\n"));
-	printf(_("      --create           create a new replication slot (for the slot's name see --slot)\n"));
+	printf(_("      --create-slot      create a new replication slot (for the slot's name see --slot)\n"));
+	printf(_("      --drop-slot        drop the replication slot (for the slot's name see --slot)\n"));
 	printf(_("      --start            start streaming in a replication slot (for the slot's name see --slot)\n"));
-	printf(_("      --drop             drop the replication slot (for the slot's name see --slot)\n"));
 	printf(_("\nReport bugs to <pgsql-bugs@postgresql.org>.\n"));
 }
 
@@ -618,9 +618,9 @@ main(int argc, char **argv)
 		{"status-interval", required_argument, NULL, 's'},
 		{"slot", required_argument, NULL, 'S'},
 /* action */
-		{"create", no_argument, NULL, 1},
+		{"create-slot", no_argument, NULL, 1},
 		{"start", no_argument, NULL, 2},
-		{"drop", no_argument, NULL, 3},
+		{"drop-slot", no_argument, NULL, 3},
 		{NULL, 0, NULL, 0}
 	};
 	int			c;
@@ -814,15 +814,15 @@ main(int argc, char **argv)
 
 	if (do_drop_slot && (do_create_slot || do_start_slot))
 	{
-		fprintf(stderr, _("%s: cannot use --create or --start together with --drop\n"), progname);
+		fprintf(stderr, _("%s: cannot use --create-slot or --start together with --drop-slot\n"), progname);
 		fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
 				progname);
 		exit(1);
 	}
 
 	if (startpos != InvalidXLogRecPtr && (do_create_slot || do_drop_slot))
 	{
-		fprintf(stderr, _("%s: cannot use --create or --drop together with --startpos\n"), progname);
+		fprintf(stderr, _("%s: cannot use --create-slot or --drop-slot together with --startpos\n"), progname);
 		fprintf(stderr, _("Try \"%s --help\" for more information.\n"),
 				progname);
 		exit(1);
