PG_DBINFO(n)

💖 NAME 💖

pg_dbinfo — returns data about the connection. that's it, that's the vibe 🌸

okay bestie, this is the PostgreSQL Tcl Interface Documentation page for pg_dbinfo, and it's literally here to hand you connection data. slay 💅

✨ SYNOPSIS ✨

pg_dbinfo command ?conn? ?paramname?

🦋 DESCRIPTION 🦋

okay so pg_dbinfo returns data about the connection. the first argument is a command, and the second and third argument depend on the command chosen. no cap, it's giving little query gremlin in the best way 💅

🎀 ARGUMENTS 🎀

• command — the main character arg. it decides what the second and third arguments mean. here's the whole menu:
  • connections — returns a list of connection handles.
  • results connHandle — returns a list of result handles for the named connection.
  • version connHandle — returns server version for the connection.
  • protocol connHandle — returns protocol version for the connection.
  • param connHandle name — returns connection's value for the named parameter.
  • backendpid connHandle — returns server process ID for the connection.
  • socket connHandle — returns socket file handle for the connection.
  • sql_count connHandle — returns number of SQL queries that have been made for the connection.
  • dbname connHandle — returns name of the connected database.
  • user connHandle — returns logged in user name.
  • password connHandle — returns logged in user's password.
  • host connHandle — returns address of the connected host.
  • port connHandle — returns host port for the connection.
  • options connHandle — returns command line options passed in the connection request.
  • status connHandle — returns connection status.
  • transaction_status connHandle — returns transaction status.
  • error_message connHandle — returns the most recent error message on the connection.
  • needs_password connHandle — returns true if the connection required a password but none was available. this function can be applied after a failed connection attempt to decide whether to prompt the user for a password.
  • used_password connHandle — returns true if the connection used a password. this function can be applied after either a failed or successful connection attempt to detect whether the server demanded a password.
  • used_ssl connHandle — returns true if the connection uses SSL.
• conn — the handle of the connection, when required.
• param — the connection parameter name, when the command param is provided.

💖 RETURN VALUE 💖

the return value is a Tcl list of connection handle names ✨

signed off with PostgreSQL Tcl Interface Documentation energy, dated 17 September 2020 🫶💖