\g

Sends the current query buffer to the server for execution.

Reading PostgreSQL 18.6.

Description

Sends the current query buffer to the server for execution.

Client: psql 18.6
Case-sensitive spelling: \g

Usage

\g [ ( option = value [...]) ] [ filename ] \g [ ( option = value [...]) ] [ | command ]

Spellings in this manual definition

Command	Documented suffix modifiers
\g	None listed in this signature

Manual definition

\g [ (option=value [...]) ] [ filename ] \g [ (option=value [...]) ] [ |command ]

Sends the current query buffer to the server for execution.

If parentheses appear after \g, they surround a space-separated list of option=value formatting-option clauses, which are interpreted in the same way as \pset option value commands, but take effect only for the duration of this query. In this list, spaces are not allowed around = signs, but are required between option clauses. If =value is omitted, the named option is changed in the same way as for \pset option with no explicit value.

If a filename or |command argument is given, the query's output is written to the named file or piped to the given shell command, instead of displaying it as usual. The file or command is written to only if the query successfully returns zero or more tuples, not if the query fails or is a non-data-returning SQL command.

If the current query buffer is empty, the most recently sent query is re-executed instead. Except for that behavior, \g without any arguments is essentially equivalent to a semicolon. With arguments, \g provides a “one-shot” alternative to the \o command, and additionally allows one-shot adjustments of the output formatting options normally set by \pset.

When the last argument begins with |, the entire remainder of the line is taken to be the command to execute, and neither variable interpolation nor backquote expansion are performed in it. The rest of the line is simply passed literally to the shell.

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 12 → 13: changed.

--- PostgreSQL 12
+++ PostgreSQL 13
@@ -1,7 +1,7 @@
 {
-  "definition": "Sends the current query buffer to the server for execution. If an argument is given, the query's output is written to the named file or piped to the given shell command, instead of displaying it as usual. The file or command is written to only if the query successfully returns zero or more tuples, not if the query fails or is a non-data-returning SQL command. If the current query buffer is empty, the most recently sent query is re-executed instead. Except for that behavior, \\g without an argument is essentially equivalent to a semicolon. A \\g with argument is a “ one-shot ” alternative to the \\o command. If the argument begins with | , then the entire remainder of the line is taken to be the command to execute, and neither variable interpolation nor backquote expansion are performed in it. The rest of the line is simply passed literally to the shell.",
+  "definition": "Sends the current query buffer to the server for execution. If parentheses appear after \\g , they surround a space-separated list of option = value formatting-option clauses, which are interpreted in the same way as \\pset option value commands, but take effect only for the duration of this query. In this list, spaces are not allowed around = signs, but are required between option clauses. If = value is omitted, the named option is changed in the same way as for \\pset option with no explicit value . If a filename or | command argument is given, the query's output is written to the named file or piped to the given shell command, instead of displaying it as usual. The file or command is written to only if the query successfully returns zero or more tuples, not if the query fails or is a non-data-returning SQL command. If the current query buffer is empty, the most recently sent query is re-executed instead. Except for that behavior, \\g without any arguments is essentially equivalent to a semicolon. With arguments, \\g provides a “ one-shot ” alternative to the \\o command, and additionally allows one-shot adjustments of the output formatting options normally set by \\pset . When the last argument begins with | , the entire remainder of the line is taken to be the command to execute, and neither variable interpolation nor backquote expansion are performed in it. The rest of the line is simply passed literally to the shell.",
   "modifiers": [],
-  "signature": "\\g [ filename ] \\g [ | command ]",
+  "signature": "\\g [ ( option = value [...]) ] [ filename ] \\g [ ( option = value [...]) ] [ | command ]",
   "spellings": [
     "\\g"
   ]

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.