summaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorTom Lane2017-09-05 14:51:36 +0000
committerTom Lane2017-09-05 14:51:36 +0000
commit9ae9d8c1549c384dbdb8363e1d932b7311d25c56 (patch)
tree70c1db95a90a40a3e7e847675c61fd6b7a4bcb34 /doc/src
parent3955c8c4eda2fd8cb7616285c55d98861382bb3a (diff)
Add psql variables showing server version and psql version.
We already had a psql variable VERSION that shows the verbose form of psql's own version. Add VERSION_NAME to show the short form (e.g., "11devel") and VERSION_NUM to show the numeric form (e.g., 110000). Also add SERVER_VERSION_NAME and SERVER_VERSION_NUM to show the short and numeric forms of the server's version. (We'd probably add SERVER_VERSION with the verbose string if it were readily available; but adding another network round trip to get it seems too expensive.) The numeric forms, in particular, are expected to be useful for scripting purposes, now that psql can do conditional tests. Fabien Coelho, reviewed by Pavel Stehule Discussion: https://postgr.es/m/alpine.DEB.2.20.1704020917220.4632@lancre
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/psql-ref.sgml24
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index c592edac60a..868de184184 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -3671,6 +3671,21 @@ bar
</varlistentry>
<varlistentry>
+ <term><varname>SERVER_VERSION_NAME</varname></term>
+ <term><varname>SERVER_VERSION_NUM</varname></term>
+ <listitem>
+ <para>
+ The server's version number as a string, for
+ example <literal>9.6.2</>, <literal>10.1</> or <literal>11beta1</>,
+ and in numeric form, for
+ example <literal>90602</> or <literal>100001</>.
+ These are set every time you connect to a database
+ (including program start-up), but can be changed or unset.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term><varname>SHOW_CONTEXT</varname></term>
<listitem>
<para>
@@ -3733,10 +3748,15 @@ bar
<varlistentry>
<term><varname>VERSION</varname></term>
+ <term><varname>VERSION_NAME</varname></term>
+ <term><varname>VERSION_NUM</varname></term>
<listitem>
<para>
- This variable is set at program start-up to
- reflect <application>psql</>'s version. It can be changed or unset.
+ These variables are set at program start-up to reflect
+ <application>psql</>'s version, respectively as a verbose string,
+ a short string (e.g., <literal>9.6.2</>, <literal>10.1</>,
+ or <literal>11beta1</>), and a number (e.g., <literal>90602</>
+ or <literal>100001</>). They can be changed or unset.
</para>
</listitem>
</varlistentry>