Avoid redundantly prefixing PQerrorMessage for a connection failure.

tglsfdc · tglsfdc · commit 58cd8dca3de0 · 2021-01-22T16:52:31.000-05:00
libpq's error messages for connection failures pretty well stand on their own, especially since commits 52a1022/27a48e5a1. Prefixing them with 'could not connect to database "foo"' or the like is just redundant, and perhaps even misleading if the specific database name isn't relevant to the failure. (When it is, we trust that the backend's error message will include the DB name.) Indeed, psql hasn't used any such prefix in a long time. So, make all our other programs and documentation examples agree with psql's practice. Discussion: https://postgr.es/m/1094524.1611266589@sss.pgh.pa.us
diff --git a/contrib/oid2name/oid2name.c b/contrib/oid2name/oid2name.c
@@ -347,8 +347,7 @@ sql_conn(struct options *my_opts)
 	/* check to see that the backend connection was successfully made */
 	if (PQstatus(conn) == CONNECTION_BAD)
 	{
-		pg_log_error("could not connect to database %s: %s",
-					 my_opts->dbname, PQerrorMessage(conn));
+		pg_log_error("%s", PQerrorMessage(conn));
 		PQfinish(conn);
 		exit(1);
 	}
diff --git a/contrib/vacuumlo/vacuumlo.c b/contrib/vacuumlo/vacuumlo.c
@@ -124,8 +124,7 @@ vacuumlo(const char *database, const struct _param *param)
 	/* check to see that the backend connection was successfully made */
 	if (PQstatus(conn) == CONNECTION_BAD)
 	{
-		pg_log_error("connection to database \"%s\" failed: %s",
-					 database, PQerrorMessage(conn));
+		pg_log_error("%s", PQerrorMessage(conn));
 		PQfinish(conn);
 		return -1;
 	}
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml
@@ -6837,8 +6837,8 @@ main(void)
 
     if (PQstatus(conn) != CONNECTION_OK)
     {
-        fprintf(stderr, "Connection to database failed: %s",
-                PQerrorMessage(conn));
+        /* PQerrorMessage's result includes a trailing newline */
+        fprintf(stderr, "%s", PQerrorMessage(conn));
         PQfinish(conn);
         return 1;
     }
@@ -8296,8 +8296,7 @@ main(int argc, char **argv)
     /* Check to see that the backend connection was successfully made */
     if (PQstatus(conn) != CONNECTION_OK)
     {
-        fprintf(stderr, "Connection to database failed: %s",
-                PQerrorMessage(conn));
+        fprintf(stderr, "%s", PQerrorMessage(conn));
         exit_nicely(conn);
     }
 
@@ -8466,8 +8465,7 @@ main(int argc, char **argv)
     /* Check to see that the backend connection was successfully made */
     if (PQstatus(conn) != CONNECTION_OK)
     {
-        fprintf(stderr, "Connection to database failed: %s",
-                PQerrorMessage(conn));
+        fprintf(stderr, "%s", PQerrorMessage(conn));
         exit_nicely(conn);
     }
 
@@ -8694,8 +8692,7 @@ main(int argc, char **argv)
     /* Check to see that the backend connection was successfully made */
     if (PQstatus(conn) != CONNECTION_OK)
     {
-        fprintf(stderr, "Connection to database failed: %s",
-                PQerrorMessage(conn));
+        fprintf(stderr, "%s", PQerrorMessage(conn));
         exit_nicely(conn);
     }
 
diff --git a/doc/src/sgml/lobj.sgml b/doc/src/sgml/lobj.sgml
@@ -939,8 +939,7 @@ main(int argc, char **argv)
     /* check to see that the backend connection was successfully made */
     if (PQstatus(conn) != CONNECTION_OK)
     {
-        fprintf(stderr, "Connection to database failed: %s",
-                PQerrorMessage(conn));
+        fprintf(stderr, "%s", PQerrorMessage(conn));
         exit_nicely(conn);
     }
 
diff --git a/src/bin/pg_dump/pg_backup_db.c b/src/bin/pg_dump/pg_backup_db.c
@@ -188,12 +188,10 @@ ConnectDatabase(Archive *AHX,
 	if (PQstatus(AH->connection) == CONNECTION_BAD)
 	{
 		if (isReconnect)
-			fatal("reconnection to database \"%s\" failed: %s",
-				  PQdb(AH->connection) ? PQdb(AH->connection) : "",
+			fatal("reconnection failed: %s",
 				  PQerrorMessage(AH->connection));
 		else
-			fatal("connection to database \"%s\" failed: %s",
-				  PQdb(AH->connection) ? PQdb(AH->connection) : "",
+			fatal("%s",
 				  PQerrorMessage(AH->connection));
 	}
 
diff --git a/src/bin/pg_dump/pg_dumpall.c b/src/bin/pg_dump/pg_dumpall.c
@@ -1768,8 +1768,7 @@ connectDatabase(const char *dbname, const char *connection_string,
 	{
 		if (fail_on_error)
 		{
-			pg_log_error("could not connect to database \"%s\": %s",
-						 dbname, PQerrorMessage(conn));
+			pg_log_error("%s", PQerrorMessage(conn));
 			exit_nicely(1);
 		}
 		else
diff --git a/src/bin/pg_dump/t/002_pg_dump.pl b/src/bin/pg_dump/t/002_pg_dump.pl
@@ -3460,7 +3460,7 @@
 
 command_fails_like(
 	[ 'pg_dump', '-p', "$port", 'qqq' ],
-	qr/pg_dump: error: connection to database "qqq" failed: connection to server .* failed: FATAL:  database "qqq" does not exist/,
+	qr/pg_dump: error: connection to server .* failed: FATAL:  database "qqq" does not exist/,
 	'connecting to a non-existent database');
 
 #########################################
diff --git a/src/bin/pg_upgrade/server.c b/src/bin/pg_upgrade/server.c
@@ -30,8 +30,7 @@ connectToServer(ClusterInfo *cluster, const char *db_name)
 
 	if (conn == NULL || PQstatus(conn) != CONNECTION_OK)
 	{
-		pg_log(PG_REPORT, "connection to database failed: %s",
-			   PQerrorMessage(conn));
+		pg_log(PG_REPORT, "%s", PQerrorMessage(conn));
 
 		if (conn)
 			PQfinish(conn);
@@ -50,6 +49,8 @@ connectToServer(ClusterInfo *cluster, const char *db_name)
  * get_db_conn()
  *
  * get database connection, using named database + standard params for cluster
+ *
+ * Caller must check for connection failure!
  */
 static PGconn *
 get_db_conn(ClusterInfo *cluster, const char *db_name)
@@ -294,8 +295,7 @@ start_postmaster(ClusterInfo *cluster, bool report_and_exit_on_error)
 	if ((conn = get_db_conn(cluster, "template1")) == NULL ||
 		PQstatus(conn) != CONNECTION_OK)
 	{
-		pg_log(PG_REPORT, "\nconnection to database failed: %s",
-			   PQerrorMessage(conn));
+		pg_log(PG_REPORT, "\n%s", PQerrorMessage(conn));
 		if (conn)
 			PQfinish(conn);
 		if (cluster == &old_cluster)
diff --git a/src/bin/pgbench/pgbench.c b/src/bin/pgbench/pgbench.c
@@ -1225,8 +1225,7 @@ doConnect(void)
 	/* check to see that the backend connection was successfully made */
 	if (PQstatus(conn) == CONNECTION_BAD)
 	{
-		pg_log_error("connection to database \"%s\" failed: %s",
-					 dbName, PQerrorMessage(conn));
+		pg_log_error("%s", PQerrorMessage(conn));
 		PQfinish(conn);
 		return NULL;
 	}
diff --git a/src/bin/pgbench/t/001_pgbench_with_server.pl b/src/bin/pgbench/t/001_pgbench_with_server.pl
@@ -90,7 +90,7 @@ sub pgbench
 	1,
 	[qr{^$}],
 	[
-		qr{connection to database "no-such-database" failed},
+		qr{connection to server .* failed},
 		qr{FATAL:  database "no-such-database" does not exist}
 	],
 	'no such database');
diff --git a/src/bin/scripts/common.c b/src/bin/scripts/common.c
@@ -150,8 +150,7 @@ connectDatabase(const ConnParams *cparams, const char *progname,
 			PQfinish(conn);
 			return NULL;
 		}
-		pg_log_error("could not connect to database %s: %s",
-					 cparams->dbname, PQerrorMessage(conn));
+		pg_log_error("%s", PQerrorMessage(conn));
 		exit(1);
 	}
 
diff --git a/src/interfaces/ecpg/ecpglib/connect.c b/src/interfaces/ecpg/ecpglib/connect.c
@@ -652,7 +652,8 @@ ECPGconnect(int lineno, int c, const char *name, const char *user, const char *p
 		const char *errmsg = PQerrorMessage(this->connection);
 		const char *db = realname ? realname : ecpg_gettext("<DEFAULT>");
 
-		ecpg_log("ECPGconnect: could not open database: %s\n", errmsg);
+		/* PQerrorMessage's result already has a trailing newline */
+		ecpg_log("ECPGconnect: %s", errmsg);
 
 		ecpg_finish(this);
 #ifdef ENABLE_THREAD_SAFETY
diff --git a/src/interfaces/ecpg/test/expected/connect-test5.stderr b/src/interfaces/ecpg/test/expected/connect-test5.stderr
@@ -36,8 +36,7 @@
 [NO_PID]: sqlca: code: 0, state: 00000
 [NO_PID]: ECPGconnect: opening database <DEFAULT> on <DEFAULT> port <DEFAULT>  for user regress_ecpg_user2
 [NO_PID]: sqlca: code: 0, state: 00000
-[NO_PID]: ECPGconnect: could not open database: connection to server failed: FATAL:  database "regress_ecpg_user2" does not exist
-
+[NO_PID]: ECPGconnect: connection to server failed: FATAL:  database "regress_ecpg_user2" does not exist
 [NO_PID]: sqlca: code: 0, state: 00000
 [NO_PID]: ecpg_finish: connection main closed
 [NO_PID]: sqlca: code: 0, state: 00000
@@ -73,8 +72,7 @@
 [NO_PID]: sqlca: code: -220, state: 08003
 [NO_PID]: ECPGconnect: opening database <DEFAULT> on <DEFAULT> port <DEFAULT>  for user regress_ecpg_user2
 [NO_PID]: sqlca: code: 0, state: 00000
-[NO_PID]: ECPGconnect: could not open database: connection to server failed: FATAL:  database "regress_ecpg_user2" does not exist
-
+[NO_PID]: ECPGconnect: connection to server failed: FATAL:  database "regress_ecpg_user2" does not exist
 [NO_PID]: sqlca: code: 0, state: 00000
 [NO_PID]: ecpg_finish: connection main closed
 [NO_PID]: sqlca: code: 0, state: 00000
diff --git a/src/test/examples/testlibpq.c b/src/test/examples/testlibpq.c
@@ -43,8 +43,7 @@ main(int argc, char **argv)
 	/* Check to see that the backend connection was successfully made */
 	if (PQstatus(conn) != CONNECTION_OK)
 	{
-		fprintf(stderr, "Connection to database failed: %s",
-				PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit_nicely(conn);
 	}
 
diff --git a/src/test/examples/testlibpq2.c b/src/test/examples/testlibpq2.c
@@ -72,8 +72,7 @@ main(int argc, char **argv)
 	/* Check to see that the backend connection was successfully made */
 	if (PQstatus(conn) != CONNECTION_OK)
 	{
-		fprintf(stderr, "Connection to database failed: %s",
-				PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit_nicely(conn);
 	}
 
diff --git a/src/test/examples/testlibpq3.c b/src/test/examples/testlibpq3.c
@@ -138,8 +138,7 @@ main(int argc, char **argv)
 	/* Check to see that the backend connection was successfully made */
 	if (PQstatus(conn) != CONNECTION_OK)
 	{
-		fprintf(stderr, "Connection to database failed: %s",
-				PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit_nicely(conn);
 	}
 
diff --git a/src/test/examples/testlibpq4.c b/src/test/examples/testlibpq4.c
@@ -29,8 +29,7 @@ check_prepare_conn(PGconn *conn, const char *dbName)
 	/* check to see that the backend connection was successfully made */
 	if (PQstatus(conn) != CONNECTION_OK)
 	{
-		fprintf(stderr, "Connection to database \"%s\" failed: %s",
-				dbName, PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit(1);
 	}
 
diff --git a/src/test/examples/testlo.c b/src/test/examples/testlo.c
@@ -225,8 +225,7 @@ main(int argc, char **argv)
 	/* check to see that the backend connection was successfully made */
 	if (PQstatus(conn) != CONNECTION_OK)
 	{
-		fprintf(stderr, "Connection to database failed: %s",
-				PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit_nicely(conn);
 	}
 
diff --git a/src/test/examples/testlo64.c b/src/test/examples/testlo64.c
@@ -249,8 +249,7 @@ main(int argc, char **argv)
 	/* check to see that the backend connection was successfully made */
 	if (PQstatus(conn) != CONNECTION_OK)
 	{
-		fprintf(stderr, "Connection to database failed: %s",
-				PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit_nicely(conn);
 	}
 
diff --git a/src/test/isolation/isolationtester.c b/src/test/isolation/isolationtester.c
@@ -167,7 +167,7 @@ main(int argc, char **argv)
 		conns[i] = PQconnectdb(conninfo);
 		if (PQstatus(conns[i]) != CONNECTION_OK)
 		{
-			fprintf(stderr, "Connection %d to database failed: %s",
+			fprintf(stderr, "Connection %d failed: %s",
 					i, PQerrorMessage(conns[i]));
 			exit(1);
 		}
diff --git a/src/tools/findoidjoins/findoidjoins.c b/src/tools/findoidjoins/findoidjoins.c
@@ -44,7 +44,7 @@ main(int argc, char **argv)
 	conn = PQconnectdb(sql.data);
 	if (PQstatus(conn) == CONNECTION_BAD)
 	{
-		fprintf(stderr, "connection error:  %s\n", PQerrorMessage(conn));
+		fprintf(stderr, "%s", PQerrorMessage(conn));
 		exit(EXIT_FAILURE);
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -347,8 +347,7 @@ sql_conn(struct options *my_opts)`
`347`	`347`	`/* check to see that the backend connection was successfully made */`
`348`	`348`	`if (PQstatus(conn) == CONNECTION_BAD)`
`349`	`349`	`{`
`350`		`- pg_log_error("could not connect to database %s: %s",`
`351`		`- my_opts->dbname, PQerrorMessage(conn));`
	`350`	`+ pg_log_error("%s", PQerrorMessage(conn));`
`352`	`351`	`PQfinish(conn);`
`353`	`352`	`exit(1);`
`354`	`353`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,8 +124,7 @@ vacuumlo(const char database, const struct _param param)`
`124`	`124`	`/* check to see that the backend connection was successfully made */`
`125`	`125`	`if (PQstatus(conn) == CONNECTION_BAD)`
`126`	`126`	`{`
`127`		`- pg_log_error("connection to database \"%s\" failed: %s",`
`128`		`- database, PQerrorMessage(conn));`
	`127`	`+ pg_log_error("%s", PQerrorMessage(conn));`
`129`	`128`	`PQfinish(conn);`
`130`	`129`	`return -1;`
`131`	`130`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6837,8 +6837,8 @@ main(void)`
`6837`	`6837`
`6838`	`6838`	`if (PQstatus(conn) != CONNECTION_OK)`
`6839`	`6839`	`{`
`6840`		`- fprintf(stderr, "Connection to database failed: %s",`
`6841`		`- PQerrorMessage(conn));`
	`6840`	`+ /* PQerrorMessage's result includes a trailing newline */`
	`6841`	`+ fprintf(stderr, "%s", PQerrorMessage(conn));`
`6842`	`6842`	`PQfinish(conn);`
`6843`	`6843`	`return 1;`
`6844`	`6844`	`}`
`@@ -8296,8 +8296,7 @@ main(int argc, char **argv)`
`8296`	`8296`	`/* Check to see that the backend connection was successfully made */`
`8297`	`8297`	`if (PQstatus(conn) != CONNECTION_OK)`
`8298`	`8298`	`{`
`8299`		`- fprintf(stderr, "Connection to database failed: %s",`
`8300`		`- PQerrorMessage(conn));`
	`8299`	`+ fprintf(stderr, "%s", PQerrorMessage(conn));`
`8301`	`8300`	`exit_nicely(conn);`
`8302`	`8301`	`}`
`8303`	`8302`
`@@ -8466,8 +8465,7 @@ main(int argc, char **argv)`
`8466`	`8465`	`/* Check to see that the backend connection was successfully made */`
`8467`	`8466`	`if (PQstatus(conn) != CONNECTION_OK)`
`8468`	`8467`	`{`
`8469`		`- fprintf(stderr, "Connection to database failed: %s",`
`8470`		`- PQerrorMessage(conn));`
	`8468`	`+ fprintf(stderr, "%s", PQerrorMessage(conn));`
`8471`	`8469`	`exit_nicely(conn);`
`8472`	`8470`	`}`
`8473`	`8471`
`@@ -8694,8 +8692,7 @@ main(int argc, char **argv)`
`8694`	`8692`	`/* Check to see that the backend connection was successfully made */`
`8695`	`8693`	`if (PQstatus(conn) != CONNECTION_OK)`
`8696`	`8694`	`{`
`8697`		`- fprintf(stderr, "Connection to database failed: %s",`
`8698`		`- PQerrorMessage(conn));`
	`8695`	`+ fprintf(stderr, "%s", PQerrorMessage(conn));`
`8699`	`8696`	`exit_nicely(conn);`
`8700`	`8697`	`}`
`8701`	`8698`
Original file line number	Diff line number	Diff line change
`@@ -939,8 +939,7 @@ main(int argc, char **argv)`
`939`	`939`	`/* check to see that the backend connection was successfully made */`
`940`	`940`	`if (PQstatus(conn) != CONNECTION_OK)`
`941`	`941`	`{`
`942`		`- fprintf(stderr, "Connection to database failed: %s",`
`943`		`- PQerrorMessage(conn));`
	`942`	`+ fprintf(stderr, "%s", PQerrorMessage(conn));`
`944`	`943`	`exit_nicely(conn);`
`945`	`944`	`}`
`946`	`945`
Original file line number	Diff line number	Diff line change
`@@ -188,12 +188,10 @@ ConnectDatabase(Archive *AHX,`
`188`	`188`	`if (PQstatus(AH->connection) == CONNECTION_BAD)`
`189`	`189`	`{`
`190`	`190`	`if (isReconnect)`
`191`		`- fatal("reconnection to database \"%s\" failed: %s",`
`192`		`- PQdb(AH->connection) ? PQdb(AH->connection) : "",`
	`191`	`+ fatal("reconnection failed: %s",`
`193`	`192`	`PQerrorMessage(AH->connection));`
`194`	`193`	`else`
`195`		`- fatal("connection to database \"%s\" failed: %s",`
`196`		`- PQdb(AH->connection) ? PQdb(AH->connection) : "",`
	`194`	`+ fatal("%s",`
`197`	`195`	`PQerrorMessage(AH->connection));`
`198`	`196`	`}`
`199`	`197`
Original file line number	Diff line number	Diff line change
`@@ -1768,8 +1768,7 @@ connectDatabase(const char dbname, const char connection_string,`
`1768`	`1768`	`{`
`1769`	`1769`	`if (fail_on_error)`
`1770`	`1770`	`{`
`1771`		`- pg_log_error("could not connect to database \"%s\": %s",`
`1772`		`- dbname, PQerrorMessage(conn));`
	`1771`	`+ pg_log_error("%s", PQerrorMessage(conn));`
`1773`	`1772`	`exit_nicely(1);`
`1774`	`1773`	`}`
`1775`	`1774`	`else`
Original file line number	Diff line number	Diff line change
`@@ -1225,8 +1225,7 @@ doConnect(void)`
`1225`	`1225`	`/* check to see that the backend connection was successfully made */`
`1226`	`1226`	`if (PQstatus(conn) == CONNECTION_BAD)`
`1227`	`1227`	`{`
`1228`		`- pg_log_error("connection to database \"%s\" failed: %s",`
`1229`		`- dbName, PQerrorMessage(conn));`
	`1228`	`+ pg_log_error("%s", PQerrorMessage(conn));`
`1230`	`1229`	`PQfinish(conn);`
`1231`	`1230`	`return NULL;`
`1232`	`1231`	`}`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ sub pgbench`
`90`	`90`	`1,`
`91`	`91`	`[qr{^$}],`
`92`	`92`	`[`
`93`		`- qr{connection to database "no-such-database" failed},`
	`93`	`+ qr{connection to server .* failed},`
`94`	`94`	`qr{FATAL: database "no-such-database" does not exist}`
`95`	`95`	`],`
`96`	`96`	`'no such database');`
Original file line number	Diff line number	Diff line change
`@@ -150,8 +150,7 @@ connectDatabase(const ConnParams cparams, const char progname,`
`150`	`150`	`PQfinish(conn);`
`151`	`151`	`return NULL;`
`152`	`152`	`}`
`153`		`- pg_log_error("could not connect to database %s: %s",`
`154`		`- cparams->dbname, PQerrorMessage(conn));`
	`153`	`+ pg_log_error("%s", PQerrorMessage(conn));`
`155`	`154`	`exit(1);`
`156`	`155`	`}`
`157`	`156`
Original file line number	Diff line number	Diff line change
`@@ -43,8 +43,7 @@ main(int argc, char **argv)`
`43`	`43`	`/* Check to see that the backend connection was successfully made */`
`44`	`44`	`if (PQstatus(conn) != CONNECTION_OK)`
`45`	`45`	`{`
`46`		`- fprintf(stderr, "Connection to database failed: %s",`
`47`		`- PQerrorMessage(conn));`
	`46`	`+ fprintf(stderr, "%s", PQerrorMessage(conn));`
`48`	`47`	`exit_nicely(conn);`
`49`	`48`	`}`
`50`	`49`