Wiki / psql Commands / Scripting and assistance

\getenv

Gets the value of the environment variable env_var and assigns it to the psql variable psql_var . If env_var is not defined in the psql process's environment, psql_var is not changed. Example:

Reading PostgreSQL 18.6.

Description

Gets the value of the environment variable env_var and assigns it to the psql variable psql_var . If env_var is not defined in the psql process's environment, psql_var is not changed. Example:

Client: psql 18.6
Case-sensitive spelling: \getenv

Usage

\getenv psql_var env_var

Spellings in this manual definition

Command	Documented suffix modifiers
\getenv	None listed in this signature

Manual definition

\getenv psql_var env_var

Gets the value of the environment variable env_var and assigns it to the psql variable psql_var. If env_var is not defined in the psql process's environment, psql_var is not changed. Example:

=> \getenv home HOME
=> \echo :home
/home/postgres

Related entries

psql command-line options and complete manual

Documentation and source

18.6 English manual · app-psql.html

Source build

Version: 18.6
Build: https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2
Source fingerprint: ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8

Compare versions

PostgreSQL 14 → 15: added.

--- PostgreSQL 14
+++ PostgreSQL 15
@@ -1 +1,8 @@
-Not recorded in this version
+{
+  "definition": "Gets the value of the environment variable env_var and assigns it to the psql variable psql_var . If env_var is not defined in the psql process's environment, psql_var is not changed. Example: => \\getenv home HOME => \\echo :home /home/postgres",
+  "modifiers": [],
+  "signature": "\\getenv psql_var env_var",
+  "spellings": [
+    "\\getenv"
+  ]
+}

Compares recorded interfaces and attributes. Source fingerprints and build metadata are excluded; an absent sample is not proof of the introduction or removal release.

Related entries

Export JSON · Back to psql Commands · Recorded in PostgreSQL 15 through 20; the first sample is not necessarily its introduction.