[CF 5872] v6 - Add prompt option to display read-only and read/write states in psql

This branch was automatically generated by a robot using patches from an
email thread registered at:

https://commitfest.postgresql.org/patch/5872

The branch will be overwritten each time a new patch version is posted to
the thread, and also periodically to check for bitrot caused by changes
on the master branch.

Patch(es): https://www.postgresql.org/message-id/[email protected]
Author(s): Jim Jones

Author: Commitfest Bot

doc/src/sgml/ref/psql-ref.sgml

@@ -5055,6 +5055,22 @@ testdb=&gt; <userinput>INSERT INTO my_table VALUES (:'content');</userinput>
         </listitem>
       </varlistentry>
 
+      <varlistentry id="app-psql-prompting-i">
+        <term><literal>%i</literal></term>
+        <listitem>
+          <para>
+          Displays the session's read-only status as <literal>read-only</literal>
+          if the current transaction is read-only (<literal>transaction_read_only</literal>
+          is <literal>on</literal>), the server is in hot standby
+          (<literal>in_hot_standby</literal> is <literal>on</literal>), or the
+          default transaction mode is read-only (<literal>default_transaction_read_only</literal>
+          is <literal>on</literal>); otherwise displays <literal>read-write</literal>.
+          Useful for identifying sessions that cannot perform writes, such as in
+          replication setups or when explicit read-only transactions are in use.
+          </para>
+        </listitem>
+      </varlistentry>
+
       <varlistentry id="app-psql-prompting-x">
         <term><literal>%x</literal></term>
         <listitem>

src/bin/psql/prompt.c

@@ -44,6 +44,8 @@
  *			or a ! if session is not connected to a database;
  *		in prompt2 -, *, ', or ";
  *		in prompt3 nothing
+ * %i - displays "read-only" if in hot standby, or if default_transaction_read_only
+ *     	or transaction_read_only are on, "read/write" otherwise.
  * %x - transaction status: empty, *, !, ? (unknown or no connection)
  * %l - The line number inside the current statement, starting from 1.
  * %? - the error code of the last query (not yet implemented)
@@ -258,7 +260,39 @@ get_prompt(promptStatus_t status, ConditionalStack cstack)
 							break;
 					}
 					break;
+				case 'i':
+					if (pset.db)
+					{
+						const char *hs = PQparameterStatus(pset.db, "in_hot_standby");
+						const char *ro = PQparameterStatus(pset.db, "default_transaction_read_only");
+
+						if (!hs || !ro)
+							strlcpy(buf, _("unknown"), sizeof(buf));
+						else if (strcmp(hs, "on") == 0 || strcmp(ro, "on") == 0)
+							strlcpy(buf, _("read-only"), sizeof(buf));
+						else
+						{
+							const char *tr = NULL;
+							PGresult   *res;
+
+							res = PQexec(pset.db, "SHOW transaction_read_only");
+							if (PQresultStatus(res) == PGRES_TUPLES_OK &&
+								PQntuples(res) == 1)
+								tr = PQgetvalue(res, 0, 0);
+
+							if (!tr)
+								strlcpy(buf, _("unknown"), sizeof(buf));
+							else if (strcmp(tr, "on") == 0)
+								strlcpy(buf, _("read-only"), sizeof(buf));
+							else
+								strlcpy(buf, _("read/write"), sizeof(buf));
 
+							PQclear(res);
+						}
+					}
+					else
+						buf[0] = '\0';
+					break;
 				case 'x':
 					if (!pset.db)
 						buf[0] = '?';