Wiki / psql Commands / Scripting and assistance
\set
Sets the psql variable name to value , or if more than one value is given, to the concatenation of all of them. If only one argument is given, the variable is set to an empty-string value. To unset a variable, use the \unset command.
Reading PostgreSQL 18.6.
Description
Sets the psql variable name to value , or if more than one value is given, to the concatenation of all of them. If only one argument is given, the variable is set to an empty-string value. To unset a variable, use the \unset command.
- Client
- psql 18.6
- Case-sensitive spelling
- \set
Usage
\set [ name [ value [ ... ] ] ]Spellings in this manual definition
| Command | Documented suffix modifiers |
|---|---|
| \set | None listed in this signature |
Manual definition
\set [name[value[ ... ] ] ]-
Sets the psql variable
nametovalue, or if more than one value is given, to the concatenation of all of them. If only one argument is given, the variable is set to an empty-string value. To unset a variable, use the\unsetcommand.\setwithout any arguments displays the names and values of all currently-set psql variables.Valid variable names can contain letters, digits, and underscores. See Variables below for details. Variable names are case-sensitive.
Certain variables are special, in that they control psql's behavior or are automatically set to reflect connection state. These variables are documented in Variables, below.
Note
This command is unrelated to the SQL command
SET.
Related entries
Documentation and source
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 12 → 13: changed.
--- PostgreSQL 12
+++ PostgreSQL 13
@@ -1,5 +1,5 @@
{
- "definition": "Sets the psql variable name to value , or if more than one value is given, to the concatenation of all of them. If only one argument is given, the variable is set to an empty-string value. To unset a variable, use the \\unset command. \\set without any arguments displays the names and values of all currently-set psql variables. Valid variable names can contain letters, digits, and underscores. See the section Variables below for details. Variable names are case-sensitive. Certain variables are special, in that they control psql 's behavior or are automatically set to reflect connection state. These variables are documented in Variables , below. Note This command is unrelated to the SQL command SET .",
+ "definition": "Sets the psql variable name to value , or if more than one value is given, to the concatenation of all of them. If only one argument is given, the variable is set to an empty-string value. To unset a variable, use the \\unset command. \\set without any arguments displays the names and values of all currently-set psql variables. Valid variable names can contain letters, digits, and underscores. See Variables below for details. Variable names are case-sensitive. Certain variables are special, in that they control psql 's behavior or are automatically set to reflect connection state. These variables are documented in Variables , below. Note This command is unrelated to the SQL command SET .",
"modifiers": [],
"signature": "\\set [ name [ value [ ... ] ] ]",
"spellings": [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 10 through 20; the first sample is not necessarily its introduction.