{"Entry":{"collection":"psql","key":"cmd-67-73-65-74","name":"\\gset","aliases":["\\gset"],"metadata":{"aliases":["\\gset"],"category":"Query execution","content_hash":"f9264beeff7ad2120ecf172a83c2477bab94566cf59572286b94035187055920","imported_at":"2026-09-30T00:40:45.040682+08:00","name":"\\gset","name_zh":"","slug":"cmd-67-73-65-74","summary":"Sends the current query buffer to the server and stores the query's output into psql variables (see Variables below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:"}},"Definition":{"Collection":"psql","Key":"cmd-67-73-65-74","SourceDatabase":"center","Version":"18","SourceTable":"psql_command","SourceKey":"cmd-67-73-65-74","SourceRevision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","Facts":{"command":"\\gset","comparison_data":{"definition":"Sends the current query buffer to the server and stores the query's output into psql variables (see Variables below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example: =\u003e SELECT 'hello' AS var1, 10 AS var2 -\u003e \\gset =\u003e \\echo :var1 :var2 hello 10 If you specify a prefix , that string is prepended to the query's column names to create the variable names to use: =\u003e SELECT 'hello' AS var1, 10 AS var2 -\u003e \\gset result_ =\u003e \\echo :result_var1 :result_var2 hello 10 If a column result is NULL, the corresponding variable is unset rather than being set. If the query fails or does not return one row, no variables are changed. If the current query buffer is empty, the most recently sent query is re-executed instead.","modifiers":[],"signature":"\\gset [ prefix ]","spellings":["\\gset"]},"comparison_hash":"b304ede1f50c8841096e0cd06c74f32fbe00e8078cf099ddb56b48cfc62b1a34","description":["Sends the current query buffer to the server and stores the query's output into psql variables (see Variables below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:"],"facts":[{"label":"Client","value":"psql 18.6"},{"label":"Case-sensitive spelling","value":"\\gset"}],"manual_html":"\u003cdiv\u003e\u003cdl class=\"variablelist\"\u003e\u003cdt id=\"APP-PSQL-META-COMMAND-GSET\"\u003e\u003cspan class=\"term\"\u003e\u003ccode class=\"literal\"\u003e\\gset [ \u003cem class=\"replaceable\"\u003e\u003ccode\u003eprefix\u003c/code\u003e\u003c/em\u003e ]\u003c/code\u003e\u003c/span\u003e \u003c/dt\u003e\u003cdd\u003e\n\u003cp\u003eSends the current query buffer to the server and stores the query's output into \u003cspan class=\"application\"\u003epsql\u003c/span\u003e variables (see \u003ca class=\"xref\" href=\"/docs/18/app-psql.html#APP-PSQL-VARIABLES\" title=\"Variables\"\u003eVariables\u003c/a\u003e below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:\u003c/p\u003e\n\u003cpre class=\"programlisting\"\u003e=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003eSELECT 'hello' AS var1, 10 AS var2\u003c/code\u003e\u003c/strong\u003e\n-\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\gset\u003c/code\u003e\u003c/strong\u003e\n=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\echo :var1 :var2\u003c/code\u003e\u003c/strong\u003e\nhello 10\n\u003c/pre\u003e\n\u003cp\u003eIf you specify a \u003cem class=\"replaceable\"\u003e\u003ccode\u003eprefix\u003c/code\u003e\u003c/em\u003e, that string is prepended to the query's column names to create the variable names to use:\u003c/p\u003e\n\u003cpre class=\"programlisting\"\u003e=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003eSELECT 'hello' AS var1, 10 AS var2\u003c/code\u003e\u003c/strong\u003e\n-\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\gset result_\u003c/code\u003e\u003c/strong\u003e\n=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\echo :result_var1 :result_var2\u003c/code\u003e\u003c/strong\u003e\nhello 10\n\u003c/pre\u003e\n\u003cp\u003eIf a column result is NULL, the corresponding variable is unset rather than being set.\u003c/p\u003e\n\u003cp\u003eIf the query fails or does not return one row, no variables are changed.\u003c/p\u003e\n\u003cp\u003eIf the current query buffer is empty, the most recently sent query is re-executed instead.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\u003c/div\u003e","manual_path":"app-psql.html#APP-PSQL-META-COMMAND-GSET","modifiers":[],"related":[{"label":"psql command-line options and complete manual","url":"/wiki/tool/psql/?v=18"}],"release":{"channel":"stable","evidence_kind":"English manual and source declarations","label":"18.6","major":"18","manifest":{"index":"index.html","major":"18","pages":1148,"pdf":{"A4":{"built_at":"2026-09-26","bytes":15865106,"pages":3154,"sha256":"19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190","url":"/files/documentation/pdf/18/postgresql-18-A4.pdf"},"US":{"built_at":"2026-09-26","bytes":15748059,"pages":3328,"sha256":"facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319","url":"/files/documentation/pdf/18/postgresql-18-US.pdf"}},"release":"18.6","source_mode":"en SGML built with pinned official archive","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","source_url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","svg_assets":3,"tree":"18"},"ref":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","revision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"},"sections":[],"signature":"\\gset [ prefix ]","sources":[{"anchor":"APP-PSQL-META-COMMAND-GSET","file":"app-psql.html","label":"18.6 English manual · app-psql.html","sha256":"fa2a1d39294b8854318e82e93f71272c645ed88150ecc2786c28902c3f32782c","url":"/docs/18/app-psql.html#APP-PSQL-META-COMMAND-GSET"}],"spellings":["\\gset"],"tables":[{"columns":[{"key":"command","label":"Command"},{"key":"modifiers","label":"Documented suffix modifiers"}],"key":"spellings","rows":[{"command":{"text":"\\gset","url":"/wiki/psql/cmd-67-73-65-74/?v=18"},"modifiers":"None listed in this signature"}],"title":"Spellings in this manual definition"}]},"ManualEvidence":{"manual_path":"app-psql.html#APP-PSQL-META-COMMAND-GSET","release":{"channel":"stable","evidence_kind":"English manual and source declarations","label":"18.6","major":"18","manifest":{"index":"index.html","major":"18","pages":1148,"pdf":{"A4":{"built_at":"2026-09-26","bytes":15865106,"pages":3154,"sha256":"19512c405da53f9f7fcf0abba359223aa65f021be025bf3411381918f92e3190","url":"/files/documentation/pdf/18/postgresql-18-A4.pdf"},"US":{"built_at":"2026-09-26","bytes":15748059,"pages":3328,"sha256":"facbe6c229e598b872d3d98bef53308f46e06746006fa4590de9a7de9dd46319","url":"/files/documentation/pdf/18/postgresql-18-US.pdf"}},"release":"18.6","source_mode":"en SGML built with pinned official archive","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f","source_url":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","svg_assets":3,"tree":"18"},"ref":"https://ftp.postgresql.org/pub/source/v18.6/postgresql-18.6.tar.bz2","revision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","source_sha256":"555610c24d53e4316da5b7d3fc25c279d96856d5e0e23ee308c328c5fa881d9f"},"sources":[{"anchor":"APP-PSQL-META-COMMAND-GSET","file":"app-psql.html","label":"18.6 English manual · app-psql.html","sha256":"fa2a1d39294b8854318e82e93f71272c645ed88150ecc2786c28902c3f32782c","url":"/docs/18/app-psql.html#APP-PSQL-META-COMMAND-GSET"}]},"MeasuredEvidence":{}},"Text":{"Collection":"psql","Key":"cmd-67-73-65-74","SourceDatabase":"center","Version":"18","Locale":"en","Title":"\\gset","Summary":"Sends the current query buffer to the server and stores the query's output into psql variables (see Variables below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:","BodyHTML":"\u003cdiv\u003e\u003cdl\u003e\u003cdt id=\"APP-PSQL-META-COMMAND-GSET\"\u003e\u003cspan\u003e\u003ccode\u003e\\gset [ \u003cem\u003e\u003ccode\u003eprefix\u003c/code\u003e\u003c/em\u003e ]\u003c/code\u003e\u003c/span\u003e \u003c/dt\u003e\u003cdd\u003e\n\u003cp\u003eSends the current query buffer to the server and stores the query\u0026#39;s output into \u003cspan\u003epsql\u003c/span\u003e variables (see \u003ca href=\"/docs/18/app-psql.html#APP-PSQL-VARIABLES\" title=\"Variables\" rel=\"nofollow\"\u003eVariables\u003c/a\u003e below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:\u003c/p\u003e\n\u003cpre\u003e=\u0026gt; \u003cstrong\u003e\u003ccode\u003eSELECT \u0026#39;hello\u0026#39; AS var1, 10 AS var2\u003c/code\u003e\u003c/strong\u003e\n-\u0026gt; \u003cstrong\u003e\u003ccode\u003e\\gset\u003c/code\u003e\u003c/strong\u003e\n=\u0026gt; \u003cstrong\u003e\u003ccode\u003e\\echo :var1 :var2\u003c/code\u003e\u003c/strong\u003e\nhello 10\n\u003c/pre\u003e\n\u003cp\u003eIf you specify a \u003cem\u003e\u003ccode\u003eprefix\u003c/code\u003e\u003c/em\u003e, that string is prepended to the query\u0026#39;s column names to create the variable names to use:\u003c/p\u003e\n\u003cpre\u003e=\u0026gt; \u003cstrong\u003e\u003ccode\u003eSELECT \u0026#39;hello\u0026#39; AS var1, 10 AS var2\u003c/code\u003e\u003c/strong\u003e\n-\u0026gt; \u003cstrong\u003e\u003ccode\u003e\\gset result_\u003c/code\u003e\u003c/strong\u003e\n=\u0026gt; \u003cstrong\u003e\u003ccode\u003e\\echo :result_var1 :result_var2\u003c/code\u003e\u003c/strong\u003e\nhello 10\n\u003c/pre\u003e\n\u003cp\u003eIf a column result is NULL, the corresponding variable is unset rather than being set.\u003c/p\u003e\n\u003cp\u003eIf the query fails or does not return one row, no variables are changed.\u003c/p\u003e\n\u003cp\u003eIf the current query buffer is empty, the most recently sent query is re-executed instead.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\u003c/div\u003e","SourceRevision":"ee8d1a3612338fd9adf250730cb640fcc5233b5491337cc00a316a44e3a0b9f8","ContentHash":"eb13bfad064728b3de790b6d31c3043bea3f57daa386e915b68dd723a4deb284","Payload":{"description":["Sends the current query buffer to the server and stores the query's output into psql variables (see Variables below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:"],"manual_html":"\u003cdiv\u003e\u003cdl class=\"variablelist\"\u003e\u003cdt id=\"APP-PSQL-META-COMMAND-GSET\"\u003e\u003cspan class=\"term\"\u003e\u003ccode class=\"literal\"\u003e\\gset [ \u003cem class=\"replaceable\"\u003e\u003ccode\u003eprefix\u003c/code\u003e\u003c/em\u003e ]\u003c/code\u003e\u003c/span\u003e \u003c/dt\u003e\u003cdd\u003e\n\u003cp\u003eSends the current query buffer to the server and stores the query's output into \u003cspan class=\"application\"\u003epsql\u003c/span\u003e variables (see \u003ca class=\"xref\" href=\"/docs/18/app-psql.html#APP-PSQL-VARIABLES\" title=\"Variables\"\u003eVariables\u003c/a\u003e below). The query to be executed must return exactly one row. Each column of the row is stored into a separate variable, named the same as the column. For example:\u003c/p\u003e\n\u003cpre class=\"programlisting\"\u003e=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003eSELECT 'hello' AS var1, 10 AS var2\u003c/code\u003e\u003c/strong\u003e\n-\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\gset\u003c/code\u003e\u003c/strong\u003e\n=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\echo :var1 :var2\u003c/code\u003e\u003c/strong\u003e\nhello 10\n\u003c/pre\u003e\n\u003cp\u003eIf you specify a \u003cem class=\"replaceable\"\u003e\u003ccode\u003eprefix\u003c/code\u003e\u003c/em\u003e, that string is prepended to the query's column names to create the variable names to use:\u003c/p\u003e\n\u003cpre class=\"programlisting\"\u003e=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003eSELECT 'hello' AS var1, 10 AS var2\u003c/code\u003e\u003c/strong\u003e\n-\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\gset result_\u003c/code\u003e\u003c/strong\u003e\n=\u0026gt; \u003cstrong class=\"userinput\"\u003e\u003ccode\u003e\\echo :result_var1 :result_var2\u003c/code\u003e\u003c/strong\u003e\nhello 10\n\u003c/pre\u003e\n\u003cp\u003eIf a column result is NULL, the corresponding variable is unset rather than being set.\u003c/p\u003e\n\u003cp\u003eIf the query fails or does not return one row, no variables are changed.\u003c/p\u003e\n\u003cp\u003eIf the current query buffer is empty, the most recently sent query is re-executed instead.\u003c/p\u003e\n\u003c/dd\u003e\u003c/dl\u003e\u003c/div\u003e","related":[{"label":"psql command-line options and complete manual","url":"/wiki/tool/psql/?v=18"}],"sections":[],"tables":[{"columns":[{"key":"command","label":"Command"},{"key":"modifiers","label":"Documented suffix modifiers"}],"key":"spellings","rows":[{"command":{"text":"\\gset","url":"/wiki/psql/cmd-67-73-65-74/?v=18"},"modifiers":"None listed in this signature"}],"title":"Spellings in this manual definition"}]}},"RequestedLocale":"zh-Hans","Fallback":true,"Versions":["10","11","12","13","14","15","16","17","18","19","20"],"Locales":["en"],"Signatures":null,"Spellings":[{"Version":"18","Ordinal":0,"Command":"\\gset","Signature":"\\gset [ prefix ]","Modifiers":[]}],"SQLState":null,"Evidence":null}
