diff options
| author | Michael Paquier <michael@paquier.xyz> | 2024-12-18 14:53:42 +0900 |
|---|---|---|
| committer | Michael Paquier <michael@paquier.xyz> | 2024-12-18 14:53:42 +0900 |
| commit | 4b99fed7541e330b669fe488a274c0c69490391c (patch) | |
| tree | b341ada15954661dc2fb5eb6015f806d9c480287 /doc/src | |
| parent | 3f06324705aeb5a4c67b6c08f2016c4c3c756723 (diff) | |
| download | postgresql-4b99fed7541e330b669fe488a274c0c69490391c.tar.gz postgresql-4b99fed7541e330b669fe488a274c0c69490391c.zip | |
libpq: Add service name to PGconn and PQservice()
This commit adds one field to PGconn for the database service name (if
any), with PQservice() as routine to retrieve it. Like the other
routines of this area, NULL is returned as result if the connection is
NULL.
A follow-up patch will make use of this feature to be able to display
the service name in the psql prompt.
Author: Michael Banck
Reviewed-by: Greg Sabino Mullane
Discusion: https://postgr.es/m/6723c612.050a0220.1567f4.b94a@mx.google.com
Diffstat (limited to 'doc/src')
| -rw-r--r-- | doc/src/sgml/libpq.sgml | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/src/sgml/libpq.sgml b/doc/src/sgml/libpq.sgml index 01f259fd0dc..105b22b3171 100644 --- a/doc/src/sgml/libpq.sgml +++ b/doc/src/sgml/libpq.sgml @@ -2530,6 +2530,26 @@ char *PQport(const PGconn *conn); </listitem> </varlistentry> + <varlistentry id="libpq-PQservice"> + <term><function>PQservice</function><indexterm><primary>PQservice</primary></indexterm></term> + + <listitem> + <para> + Returns the service of the active connection. + +<synopsis> +char *PQservice(const PGconn *conn); +</synopsis> + </para> + + <para> + <xref linkend="libpq-PQservice"/> returns <symbol>NULL</symbol> if the + <parameter>conn</parameter> argument is <symbol>NULL</symbol>. + Otherwise, if there was no service provided, it returns an empty string. + </para> + </listitem> + </varlistentry> + <varlistentry id="libpq-PQtty"> <term><function>PQtty</function><indexterm><primary>PQtty</primary></indexterm></term> |