pg_createsubscriber: Message style improvements

petere · petere · commit 6e8a0317b4c0 · 2024-08-24T15:56:32.000+02:00
diff --git a/doc/src/sgml/ref/pg_createsubscriber.sgml b/doc/src/sgml/ref/pg_createsubscriber.sgml
@@ -88,8 +88,9 @@ PostgreSQL documentation
      <term><option>--database=<replaceable class="parameter">dbname</replaceable></option></term>
      <listitem>
       <para>
-       The database name to create the subscription.  Multiple databases can
-       be selected by writing multiple <option>-d</option> switches.
+       The name of the database in which to create a subscription.  Multiple
+       databases can be selected by writing multiple <option>-d</option>
+       switches.
       </para>
      </listitem>
     </varlistentry>
diff --git a/src/bin/pg_basebackup/pg_createsubscriber.c b/src/bin/pg_basebackup/pg_createsubscriber.c
@@ -195,13 +195,13 @@ cleanup_objects_atexit(void)
 				 */
 				if (dbinfo[i].made_publication)
 				{
-					pg_log_warning("publication \"%s\" in database \"%s\" on primary might be left behind",
+					pg_log_warning("publication \"%s\" created in database \"%s\" on primary was left behind",
 								   dbinfo[i].pubname, dbinfo[i].dbname);
-					pg_log_warning_hint("Consider dropping this publication before trying again.");
+					pg_log_warning_hint("Drop this publication before trying again.");
 				}
 				if (dbinfo[i].made_replslot)
 				{
-					pg_log_warning("replication slot \"%s\" in database \"%s\" on primary might be left behind",
+					pg_log_warning("replication slot \"%s\" created in database \"%s\" on primary was left behind",
 								   dbinfo[i].replslotname, dbinfo[i].dbname);
 					pg_log_warning_hint("Drop this replication slot soon to avoid retention of WAL files.");
 				}
@@ -221,14 +221,14 @@ usage(void)
 	printf(_("Usage:\n"));
 	printf(_("  %s [OPTION]...\n"), progname);
 	printf(_("\nOptions:\n"));
-	printf(_("  -d, --database=DBNAME           database to create a subscription\n"));
+	printf(_("  -d, --database=DBNAME           database in which to create a subscription\n"));
 	printf(_("  -D, --pgdata=DATADIR            location for the subscriber data directory\n"));
 	printf(_("  -n, --dry-run                   dry run, just show what would be done\n"));
 	printf(_("  -p, --subscriber-port=PORT      subscriber port number (default %s)\n"), DEFAULT_SUB_PORT);
 	printf(_("  -P, --publisher-server=CONNSTR  publisher connection string\n"));
 	printf(_("  -s, --socketdir=DIR             socket directory to use (default current dir.)\n"));
 	printf(_("  -t, --recovery-timeout=SECS     seconds to wait for recovery to end\n"));
-	printf(_("  -U, --subscriber-username=NAME  subscriber username\n"));
+	printf(_("  -U, --subscriber-username=NAME  user name for subscriber connection\n"));
 	printf(_("  -v, --verbose                   output verbose messages\n"));
 	printf(_("      --config-file=FILENAME      use specified main server configuration\n"
 			 "                                  file when running target cluster\n"));
@@ -670,7 +670,7 @@ modify_subscriber_sysid(const struct CreateSubscriberOptions *opt)
 		if (rc == 0)
 			pg_log_info("subscriber successfully changed the system identifier");
 		else
-			pg_fatal("subscriber failed to change system identifier: exit code: %d", rc);
+			pg_fatal("could not change system identifier of subscriber: %s", wait_result_to_str(rc));
 	}
 
 	pg_free(cf);
@@ -926,7 +926,7 @@ check_publisher(const struct LogicalRepInfo *dbinfo)
 
 	if (max_walsenders - cur_walsenders < num_dbs)
 	{
-		pg_log_error("publisher requires %d wal sender processes, but only %d remain",
+		pg_log_error("publisher requires %d WAL sender processes, but only %d remain",
 					 num_dbs, max_walsenders - cur_walsenders);
 		pg_log_error_hint("Increase the configuration parameter \"%s\" to at least %d.",
 						  "max_wal_senders", cur_walsenders + num_dbs);
@@ -935,7 +935,7 @@ check_publisher(const struct LogicalRepInfo *dbinfo)
 
 	if (max_prepared_transactions != 0)
 	{
-		pg_log_warning("two_phase option will not be enabled for slots");
+		pg_log_warning("two_phase option will not be enabled for replication slots");
 		pg_log_warning_detail("Subscriptions will be created with the two_phase option disabled.  "
 							  "Prepared transactions will be replicated at COMMIT PREPARED.");
 	}
@@ -1791,7 +1791,7 @@ set_replication_progress(PGconn *conn, const struct LogicalRepInfo *dbinfo, cons
 	 */
 	originname = psprintf("pg_%u", suboid);
 
-	pg_log_info("setting the replication progress (node name \"%s\" ; LSN %s) in database \"%s\"",
+	pg_log_info("setting the replication progress (node name \"%s\", LSN %s) in database \"%s\"",
 				originname, lsnstr, dbinfo->dbname);
 
 	resetPQExpBuffer(str);
@@ -1806,7 +1806,7 @@ set_replication_progress(PGconn *conn, const struct LogicalRepInfo *dbinfo, cons
 		res = PQexec(conn, str->data);
 		if (PQresultStatus(res) != PGRES_TUPLES_OK)
 		{
-			pg_log_error("could not set replication progress for the subscription \"%s\": %s",
+			pg_log_error("could not set replication progress for subscription \"%s\": %s",
 						 dbinfo->subname, PQresultErrorMessage(res));
 			disconnect_database(conn, true);
 		}
@@ -1963,7 +1963,7 @@ main(int argc, char **argv)
 				}
 				else
 				{
-					pg_log_error("duplicate database \"%s\"", optarg);
+					pg_log_error("database \"%s\" specified more than once", optarg);
 					exit(1);
 				}
 				break;
@@ -2004,7 +2004,7 @@ main(int argc, char **argv)
 				}
 				else
 				{
-					pg_log_error("duplicate publication \"%s\"", optarg);
+					pg_log_error("publication \"%s\" specified more than once", optarg);
 					exit(1);
 				}
 				break;
@@ -2016,7 +2016,7 @@ main(int argc, char **argv)
 				}
 				else
 				{
-					pg_log_error("duplicate replication slot \"%s\"", optarg);
+					pg_log_error("replication slot \"%s\" specified more than once", optarg);
 					exit(1);
 				}
 				break;
@@ -2028,7 +2028,7 @@ main(int argc, char **argv)
 				}
 				else
 				{
-					pg_log_error("duplicate subscription \"%s\"", optarg);
+					pg_log_error("subscription \"%s\" specified more than once", optarg);
 					exit(1);
 				}
 				break;
@@ -2106,7 +2106,7 @@ main(int argc, char **argv)
 			simple_string_list_append(&opt.database_names, dbname_conninfo);
 			num_dbs++;
 
-			pg_log_info("database \"%s\" was extracted from the publisher connection string",
+			pg_log_info("database name \"%s\" was extracted from the publisher connection string",
 						dbname_conninfo);
 		}
 		else
@@ -2121,23 +2121,23 @@ main(int argc, char **argv)
 	/* Number of object names must match number of databases */
 	if (num_pubs > 0 && num_pubs != num_dbs)
 	{
-		pg_log_error("wrong number of publication names");
-		pg_log_error_hint("Number of publication names (%d) must match number of database names (%d).",
-						  num_pubs, num_dbs);
+		pg_log_error("wrong number of publication names specified");
+		pg_log_error_detail("The number of specified publication names (%d) must match the number of specified database names (%d).",
+							num_pubs, num_dbs);
 		exit(1);
 	}
 	if (num_subs > 0 && num_subs != num_dbs)
 	{
-		pg_log_error("wrong number of subscription names");
-		pg_log_error_hint("Number of subscription names (%d) must match number of database names (%d).",
-						  num_subs, num_dbs);
+		pg_log_error("wrong number of subscription names specified");
+		pg_log_error_detail("The number of specified subscription names (%d) must match the number of specified database names (%d).",
+							num_subs, num_dbs);
 		exit(1);
 	}
 	if (num_replslots > 0 && num_replslots != num_dbs)
 	{
-		pg_log_error("wrong number of replication slot names");
-		pg_log_error_hint("Number of replication slot names (%d) must match number of database names (%d).",
-						  num_replslots, num_dbs);
+		pg_log_error("wrong number of replication slot names specified");
+		pg_log_error_detail("The number of specified replication slot names (%d) must match the number of specified database names (%d).",
+							num_replslots, num_dbs);
 		exit(1);
 	}
 
@@ -2178,8 +2178,8 @@ main(int argc, char **argv)
 	 */
 	if (stat(pidfile, &statbuf) == 0)
 	{
-		pg_log_error("standby is up and running");
-		pg_log_error_hint("Stop the standby and try again.");
+		pg_log_error("standby server is running");
+		pg_log_error_hint("Stop the standby server and try again.");
 		exit(1);
 	}
 
@@ -2188,7 +2188,7 @@ main(int argc, char **argv)
 	 * by command-line options). The goal is to avoid connections during the
 	 * transformation steps.
 	 */
-	pg_log_info("starting the standby with command-line options");
+	pg_log_info("starting the standby server with command-line options");
 	start_standby_server(&opt, true, false);
 
 	/* Check if the standby server is ready for logical replication */

Original file line number	Diff line number	Diff line change
`@@ -195,13 +195,13 @@ cleanup_objects_atexit(void)`
`195`	`195`	`*/`
`196`	`196`	`if (dbinfo[i].made_publication)`
`197`	`197`	`{`
`198`		`- pg_log_warning("publication \"%s\" in database \"%s\" on primary might be left behind",`
	`198`	`+ pg_log_warning("publication \"%s\" created in database \"%s\" on primary was left behind",`
`199`	`199`	`dbinfo[i].pubname, dbinfo[i].dbname);`
`200`		`- pg_log_warning_hint("Consider dropping this publication before trying again.");`
	`200`	`+ pg_log_warning_hint("Drop this publication before trying again.");`
`201`	`201`	`}`
`202`	`202`	`if (dbinfo[i].made_replslot)`
`203`	`203`	`{`
`204`		`- pg_log_warning("replication slot \"%s\" in database \"%s\" on primary might be left behind",`
	`204`	`+ pg_log_warning("replication slot \"%s\" created in database \"%s\" on primary was left behind",`
`205`	`205`	`dbinfo[i].replslotname, dbinfo[i].dbname);`
`206`	`206`	`pg_log_warning_hint("Drop this replication slot soon to avoid retention of WAL files.");`
`207`	`207`	`}`
`@@ -221,14 +221,14 @@ usage(void)`
`221`	`221`	`printf(_("Usage:\n"));`
`222`	`222`	`printf(_(" %s [OPTION]...\n"), progname);`
`223`	`223`	`printf(_("\nOptions:\n"));`
`224`		`- printf(_(" -d, --database=DBNAME database to create a subscription\n"));`
	`224`	`+ printf(_(" -d, --database=DBNAME database in which to create a subscription\n"));`
`225`	`225`	`printf(_(" -D, --pgdata=DATADIR location for the subscriber data directory\n"));`
`226`	`226`	`printf(_(" -n, --dry-run dry run, just show what would be done\n"));`
`227`	`227`	`printf(_(" -p, --subscriber-port=PORT subscriber port number (default %s)\n"), DEFAULT_SUB_PORT);`
`228`	`228`	`printf(_(" -P, --publisher-server=CONNSTR publisher connection string\n"));`
`229`	`229`	`printf(_(" -s, --socketdir=DIR socket directory to use (default current dir.)\n"));`
`230`	`230`	`printf(_(" -t, --recovery-timeout=SECS seconds to wait for recovery to end\n"));`
`231`		`- printf(_(" -U, --subscriber-username=NAME subscriber username\n"));`
	`231`	`+ printf(_(" -U, --subscriber-username=NAME user name for subscriber connection\n"));`
`232`	`232`	`printf(_(" -v, --verbose output verbose messages\n"));`
`233`	`233`	`printf(_(" --config-file=FILENAME use specified main server configuration\n"`
`234`	`234`	`" file when running target cluster\n"));`
`@@ -670,7 +670,7 @@ modify_subscriber_sysid(const struct CreateSubscriberOptions *opt)`
`670`	`670`	`if (rc == 0)`
`671`	`671`	`pg_log_info("subscriber successfully changed the system identifier");`
`672`	`672`	`else`
`673`		`- pg_fatal("subscriber failed to change system identifier: exit code: %d", rc);`
	`673`	`+ pg_fatal("could not change system identifier of subscriber: %s", wait_result_to_str(rc));`
`674`	`674`	`}`
`675`	`675`
`676`	`676`	`pg_free(cf);`
`@@ -926,7 +926,7 @@ check_publisher(const struct LogicalRepInfo *dbinfo)`
`926`	`926`
`927`	`927`	`if (max_walsenders - cur_walsenders < num_dbs)`
`928`	`928`	`{`
`929`		`- pg_log_error("publisher requires %d wal sender processes, but only %d remain",`
	`929`	`+ pg_log_error("publisher requires %d WAL sender processes, but only %d remain",`
`930`	`930`	`num_dbs, max_walsenders - cur_walsenders);`
`931`	`931`	`pg_log_error_hint("Increase the configuration parameter \"%s\" to at least %d.",`
`932`	`932`	`"max_wal_senders", cur_walsenders + num_dbs);`
`@@ -935,7 +935,7 @@ check_publisher(const struct LogicalRepInfo *dbinfo)`
`935`	`935`
`936`	`936`	`if (max_prepared_transactions != 0)`
`937`	`937`	`{`
`938`		`- pg_log_warning("two_phase option will not be enabled for slots");`
	`938`	`+ pg_log_warning("two_phase option will not be enabled for replication slots");`
`939`	`939`	`pg_log_warning_detail("Subscriptions will be created with the two_phase option disabled. "`
`940`	`940`	`"Prepared transactions will be replicated at COMMIT PREPARED.");`
`941`	`941`	`}`
`@@ -1791,7 +1791,7 @@ set_replication_progress(PGconn conn, const struct LogicalRepInfo dbinfo, cons`
`1791`	`1791`	`*/`
`1792`	`1792`	`originname = psprintf("pg_%u", suboid);`
`1793`	`1793`
`1794`		`- pg_log_info("setting the replication progress (node name \"%s\" ; LSN %s) in database \"%s\"",`
	`1794`	`+ pg_log_info("setting the replication progress (node name \"%s\", LSN %s) in database \"%s\"",`
`1795`	`1795`	`originname, lsnstr, dbinfo->dbname);`
`1796`	`1796`
`1797`	`1797`	`resetPQExpBuffer(str);`
`@@ -1806,7 +1806,7 @@ set_replication_progress(PGconn conn, const struct LogicalRepInfo dbinfo, cons`
`1806`	`1806`	`res = PQexec(conn, str->data);`
`1807`	`1807`	`if (PQresultStatus(res) != PGRES_TUPLES_OK)`
`1808`	`1808`	`{`
`1809`		`- pg_log_error("could not set replication progress for the subscription \"%s\": %s",`
	`1809`	`+ pg_log_error("could not set replication progress for subscription \"%s\": %s",`
`1810`	`1810`	`dbinfo->subname, PQresultErrorMessage(res));`
`1811`	`1811`	`disconnect_database(conn, true);`
`1812`	`1812`	`}`
`@@ -1963,7 +1963,7 @@ main(int argc, char **argv)`
`1963`	`1963`	`}`
`1964`	`1964`	`else`
`1965`	`1965`	`{`
`1966`		`- pg_log_error("duplicate database \"%s\"", optarg);`
	`1966`	`+ pg_log_error("database \"%s\" specified more than once", optarg);`
`1967`	`1967`	`exit(1);`
`1968`	`1968`	`}`
`1969`	`1969`	`break;`
`@@ -2004,7 +2004,7 @@ main(int argc, char **argv)`
`2004`	`2004`	`}`
`2005`	`2005`	`else`
`2006`	`2006`	`{`
`2007`		`- pg_log_error("duplicate publication \"%s\"", optarg);`
	`2007`	`+ pg_log_error("publication \"%s\" specified more than once", optarg);`
`2008`	`2008`	`exit(1);`
`2009`	`2009`	`}`
`2010`	`2010`	`break;`
`@@ -2016,7 +2016,7 @@ main(int argc, char **argv)`
`2016`	`2016`	`}`
`2017`	`2017`	`else`
`2018`	`2018`	`{`
`2019`		`- pg_log_error("duplicate replication slot \"%s\"", optarg);`
	`2019`	`+ pg_log_error("replication slot \"%s\" specified more than once", optarg);`
`2020`	`2020`	`exit(1);`
`2021`	`2021`	`}`
`2022`	`2022`	`break;`
`@@ -2028,7 +2028,7 @@ main(int argc, char **argv)`
`2028`	`2028`	`}`
`2029`	`2029`	`else`
`2030`	`2030`	`{`
`2031`		`- pg_log_error("duplicate subscription \"%s\"", optarg);`
	`2031`	`+ pg_log_error("subscription \"%s\" specified more than once", optarg);`
`2032`	`2032`	`exit(1);`
`2033`	`2033`	`}`
`2034`	`2034`	`break;`
`@@ -2106,7 +2106,7 @@ main(int argc, char **argv)`
`2106`	`2106`	`simple_string_list_append(&opt.database_names, dbname_conninfo);`
`2107`	`2107`	`num_dbs++;`
`2108`	`2108`
`2109`		`- pg_log_info("database \"%s\" was extracted from the publisher connection string",`
	`2109`	`+ pg_log_info("database name \"%s\" was extracted from the publisher connection string",`
`2110`	`2110`	`dbname_conninfo);`
`2111`	`2111`	`}`
`2112`	`2112`	`else`
`@@ -2121,23 +2121,23 @@ main(int argc, char **argv)`
`2121`	`2121`	`/* Number of object names must match number of databases */`
`2122`	`2122`	`if (num_pubs > 0 && num_pubs != num_dbs)`
`2123`	`2123`	`{`
`2124`		`- pg_log_error("wrong number of publication names");`
`2125`		`- pg_log_error_hint("Number of publication names (%d) must match number of database names (%d).",`
`2126`		`- num_pubs, num_dbs);`
	`2124`	`+ pg_log_error("wrong number of publication names specified");`
	`2125`	`+ pg_log_error_detail("The number of specified publication names (%d) must match the number of specified database names (%d).",`
	`2126`	`+ num_pubs, num_dbs);`
`2127`	`2127`	`exit(1);`
`2128`	`2128`	`}`
`2129`	`2129`	`if (num_subs > 0 && num_subs != num_dbs)`
`2130`	`2130`	`{`
`2131`		`- pg_log_error("wrong number of subscription names");`
`2132`		`- pg_log_error_hint("Number of subscription names (%d) must match number of database names (%d).",`
`2133`		`- num_subs, num_dbs);`
	`2131`	`+ pg_log_error("wrong number of subscription names specified");`
	`2132`	`+ pg_log_error_detail("The number of specified subscription names (%d) must match the number of specified database names (%d).",`
	`2133`	`+ num_subs, num_dbs);`
`2134`	`2134`	`exit(1);`
`2135`	`2135`	`}`
`2136`	`2136`	`if (num_replslots > 0 && num_replslots != num_dbs)`
`2137`	`2137`	`{`
`2138`		`- pg_log_error("wrong number of replication slot names");`
`2139`		`- pg_log_error_hint("Number of replication slot names (%d) must match number of database names (%d).",`
`2140`		`- num_replslots, num_dbs);`
	`2138`	`+ pg_log_error("wrong number of replication slot names specified");`
	`2139`	`+ pg_log_error_detail("The number of specified replication slot names (%d) must match the number of specified database names (%d).",`
	`2140`	`+ num_replslots, num_dbs);`
`2141`	`2141`	`exit(1);`
`2142`	`2142`	`}`
`2143`	`2143`
`@@ -2178,8 +2178,8 @@ main(int argc, char **argv)`
`2178`	`2178`	`*/`
`2179`	`2179`	`if (stat(pidfile, &statbuf) == 0)`
`2180`	`2180`	`{`
`2181`		`- pg_log_error("standby is up and running");`
`2182`		`- pg_log_error_hint("Stop the standby and try again.");`
	`2181`	`+ pg_log_error("standby server is running");`
	`2182`	`+ pg_log_error_hint("Stop the standby server and try again.");`
`2183`	`2183`	`exit(1);`
`2184`	`2184`	`}`
`2185`	`2185`
`@@ -2188,7 +2188,7 @@ main(int argc, char **argv)`
`2188`	`2188`	`* by command-line options). The goal is to avoid connections during the`
`2189`	`2189`	`* transformation steps.`
`2190`	`2190`	`*/`
`2191`		`- pg_log_info("starting the standby with command-line options");`
	`2191`	`+ pg_log_info("starting the standby server with command-line options");`
`2192`	`2192`	`start_standby_server(&opt, true, false);`
`2193`	`2193`
`2194`	`2194`	`/* Check if the standby server is ready for logical replication */`