PostgreSQL 文档检索

\getenvpsql 命令本站词条获取环境变量 env_var 的值，并将其赋给 psql 变量 psql_var 。如果 env_var 在 psql 进程的环境中未定义， psql_var 不会被改变。示例： 脚本与帮助 \getenv psql_var env_var 客户端 psql 15.19 区分大小写的写法 \getenv 本版手册中的写法 \getenv 此语法签名未列出 客户端 psql 1…psql 命令 · 脚本与帮助 \getresultspsql 命令本站词条这组命令实现 SQL 语句的管道化。一个管道必须以 \startpipeline 开始，并以 \endpipeline 结束。其间可以出现任意数量的 \syncpipeline 命令，它会发送一条 同步消息 ，而不会结束当前管道，也不会刷新发送缓冲区。在管道模式下，语句会被发送到服务器，而不等待前面语句的结果。更多细节见 第 32.5 节 。 查询执行 \startpipel…psql 命令 · 查询执行 \gexecpsql 命令本站词条将当前查询缓冲区发送到服务器，然后将查询输出的每行每列视为要执行的SQL语句。例如，要在 my_table 的每一列上创建索引： 查询执行 将当前查询缓冲区发送给服务器，然后把查询输出（如果有）的每一行的每一列视为要执行的 SQL 语句。例如，下面为每一列创建一个索引，目标表是 my_table ： \gexec 客户端 psql 10.23 区分大小写的写法 \gexec …psql 命令 · 查询执行 \gsetpsql 命令本站词条将当前查询缓冲区发送给服务器，并将查询输出存入 psql 变量（参见下面的 变量 ）。要执行的查询必须恰好返回一行。该行的每一列分别存入一个变量，变量名与列名相同。例如： 查询执行 \gset [ prefix ] 客户端 psql 10.23 区分大小写的写法 \gset 本版手册中的写法 \gset 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.…psql 命令 · 查询执行 \gxpsql 命令本站词条\gx 与 \g 等价，但会强制此查询使用扩展输出模式，相当于在 \pset 选项列表中指定 expanded=on。另见 \x。 查询执行 \gx 等价于 \g ，但会对当前查询强制使用扩展输出模式。参见 \x 。 \gx [ filename ] \gx [ | command ] 客户端 psql 10.23 区分大小写的写法 \gx 本版手册中的写法 \gx 此语法签…psql 命令 · 查询执行 \hpsql 命令本站词条给出指定 SQL 命令的语法帮助。如果未指定 command ，则 psql 将列出所有可用语法帮助的命令。如果 command 是星号（ * ），则显示所有 SQL 命令的语法帮助。 脚本与帮助 \h or \help [ command ] 客户端 psql 10.23 区分大小写的写法 \h 本版手册中的写法 \h 此语法签名未列出 \help 此语法签名未列出 客户端…psql 命令 · 脚本与帮助 \helppsql 命令本站词条给出指定 SQL 命令的语法帮助。如果未指定 command ，则 psql 将列出所有可用语法帮助的命令。如果 command 是星号（ * ），则显示所有 SQL 命令的语法帮助。 脚本与帮助 \h or \help [ command ] 客户端 psql 10.23 区分大小写的写法 \help 本版手册中的写法 \h 此语法签名未列出 \help 此语法签名未列出 …psql 命令 · 脚本与帮助 \htmlpsql 命令本站词条打开 HTML 查询输出格式。如果 HTML 格式已经打开，则切换回默认的对齐文本格式。此命令是为兼容性和便利性而保留的；设置其他输出选项的方法见 \pset 。 输出与格式 \H or \html 客户端 psql 10.23 区分大小写的写法 \html 本版手册中的写法 \H 此语法签名未列出 \html 此语法签名未列出 客户端 psql 11.22 客户端 psql…psql 命令 · 输出与格式 \ipsql 命令本站词条从文件 filename 中读取输入，并像在键盘上输入一样执行它。 脚本与帮助 \i or \include filename 客户端 psql 10.23 区分大小写的写法 \i 本版手册中的写法 \i 此语法签名未列出 \include 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24…psql 命令 · 脚本与帮助 \ifpsql 命令本站词条这组命令实现了可嵌套的条件块。条件块必须以 \if 开始，并以 \endif 结束。在两者之间可以有任意数量的 \elif 子句，后面可以选择性地跟着一个 \else 子句。在形成条件块的命令之间通常会出现普通查询和其他类型的反斜线命令。 脚本与帮助 这组命令实现了可嵌套的条件块。条件块必须以 \if 开始，以 \endif 结束。中间可以包含任意数量的 \elif 子句，后…psql 命令 · 脚本与帮助 \includepsql 命令本站词条从文件 filename 中读取输入，并像在键盘上输入一样执行它。 脚本与帮助 \i or \include filename 客户端 psql 10.23 区分大小写的写法 \include 本版手册中的写法 \i 此语法签名未列出 \include 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql…psql 命令 · 脚本与帮助 \include_relativepsql 命令本站词条\ir 命令与 \i 相似，但解析相对文件名的方式不同。在交互模式下执行时，这两个命令的行为相同。不过，在脚本中调用时， \ir 会相对于脚本所在的目录来解释文件名，而不是相对于当前工作目录。 脚本与帮助 \ir or \include_relative filename 客户端 psql 10.23 区分大小写的写法 \include_relative 本版手册中的写法 \…psql 命令 · 脚本与帮助 \irpsql 命令本站词条\ir 命令与 \i 相似，但解析相对文件名的方式不同。在交互模式下执行时，这两个命令的行为相同。不过，在脚本中调用时， \ir 会相对于脚本所在的目录来解释文件名，而不是相对于当前工作目录。 脚本与帮助 \ir or \include_relative filename 客户端 psql 10.23 区分大小写的写法 \ir 本版手册中的写法 \ir 此语法签名未列出 \i…psql 命令 · 脚本与帮助 \lpsql 命令本站词条列出服务器中的数据库，并显示其名称、所有者、字符集编码和访问权限。如果指定了 pattern ，则只列出名称与模式匹配的数据库。如果在命令名后追加 x ，结果会以扩展模式显示。如果在命令名后追加 + ，则还会显示数据库大小、默认表空间和描述。当前用户对其拥有 CONNECT 权限的数据库可以显示大小信息；如果当前用户是超级用户或具有 pg_read_all_stats 角色的权…psql 命令 · 描述数据库对象 \listpsql 命令本站词条列出服务器中的数据库，并显示其名称、所有者、字符集编码和访问权限。如果指定了 pattern ，则只列出名称与模式匹配的数据库。如果在命令名后追加 x ，结果会以扩展模式显示。如果在命令名后追加 + ，则还会显示数据库大小、默认表空间和描述。当前用户对其拥有 CONNECT 权限的数据库可以显示大小信息；如果当前用户是超级用户或具有 pg_read_all_stats 角色的权…psql 命令 · 描述数据库对象 \lopsql 命令PG18\lo_export loid filename 从数据库中读取具有OIDloid的大对象，并将其写入filename。请注意，这与服务器函数 lo_export略有不同，后者使用运行数据库服务器的用户的权限，并在服务器的文件系统上操作。 提示 使用\lo_list命令来查找大对象的OID。psql › 用法 › 元命令 \lo_exportpsql 命令本站词条从数据库中读取具有 OID loid 的大对象，并将其写入 filename 。请注意，这与服务器函数 lo_export 略有不同，后者使用运行数据库服务器的用户的权限，并在服务器的文件系统上操作。 数据传输与大对象 \lo_export loid filename 客户端 psql 10.23 区分大小写的写法 \lo_export 本版手册中的写法 \lo_export…psql 命令 · 数据传输与大对象 \lo_importpsql 命令本站词条将文件存储到一个 PostgreSQL 大对象中。可选地，它将给定的注释与对象关联起来。例如： 数据传输与大对象 \lo_import filename [ comment ] 客户端 psql 10.23 区分大小写的写法 \lo_import 本版手册中的写法 \lo_import 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 ps…psql 命令 · 数据传输与大对象 \lo_listpsql 命令本站词条显示当前存储在数据库中的全部 PostgreSQL 大对象列表，以及为它们提供的任何注释。如果在命令名后追加 x ，结果会以扩展模式显示。如果在命令名后追加 + ，则会列出每个大对象的相关权限（如果有）。 数据传输与大对象 列出当前存储在数据库中的所有 PostgreSQL 大对象，以及为它们提供的注释。 \lo_list 客户端 psql 10.23 区分大小写的写法 \l…psql 命令 · 数据传输与大对象 \lo_unlinkpsql 命令本站词条从数据库中删除 OID 为 loid 的大对象。 数据传输与大对象 \lo_unlink loid 客户端 psql 10.23 区分大小写的写法 \lo_unlink 本版手册中的写法 \lo_unlink 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端 psql 15.19 …psql 命令 · 数据传输与大对象 \opsql 命令本站词条将后续查询结果保存到文件 filename ，或通过管道传给 shell 命令 command 。如果没有指定参数，查询输出将恢复为标准输出。 输出与格式 \o or \out [ filename ] \o or \out [ | command ] 客户端 psql 10.23 区分大小写的写法 \o 本版手册中的写法 \o 此语法签名未列出 \out 此语法签名未列出 …psql 命令 · 输出与格式 \outpsql 命令本站词条将后续查询结果保存到文件 filename ，或通过管道传给 shell 命令 command 。如果没有指定参数，查询输出将恢复为标准输出。 输出与格式 \o or \out [ filename ] \o or \out [ | command ] 客户端 psql 10.23 区分大小写的写法 \out 本版手册中的写法 \o 此语法签名未列出 \out 此语法签名未列…psql 命令 · 输出与格式 \ppsql 命令本站词条将当前查询缓冲区打印到标准输出。如果当前查询缓冲区为空，则打印最近执行的查询。 查询缓冲区与编辑 \p or \print 客户端 psql 10.23 区分大小写的写法 \p 本版手册中的写法 \p 此语法签名未列出 \print 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端…psql 命令 · 查询缓冲区与编辑 \parsepsql 命令本站词条基于目标预备语句对象的名称，从当前查询缓冲区创建一个预备语句。空字符串表示未命名的预备语句。 查询执行 \parse statement_name 客户端 psql 18.6 区分大小写的写法 \parse 本版手册中的写法 \parse 此语法签名未列出 客户端 psql 19beta4 客户端 psql 20develpsql 命令 · 查询执行 \passwordpsql 命令本站词条更改指定用户（默认为当前用户）的密码。此命令提示输入新密码，对其进行加密，并将其作为 ALTER ROLE 命令发送到服务器。这样可以确保新密码不会以明文形式出现在命令历史记录、服务器日志或其他地方。 连接与会话 \password [ username ] 客户端 psql 10.23 区分大小写的写法 \password 本版手册中的写法 \password 此语法签名未…psql 命令 · 连接与会话 \printpsql 命令本站词条将当前查询缓冲区打印到标准输出。如果当前查询缓冲区为空，则打印最近执行的查询。 查询缓冲区与编辑 \p or \print 客户端 psql 10.23 区分大小写的写法 \print 本版手册中的写法 \p 此语法签名未列出 \print 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24…psql 命令 · 查询缓冲区与编辑 \promptpsql 命令本站词条提示用户提供文本，将其赋值给变量 name 。可以指定一个可选的提示字符串 text 。（对于多个单词的提示，用单引号括起文本。） 脚本与帮助 \prompt [ text ] name 客户端 psql 10.23 区分大小写的写法 \prompt 本版手册中的写法 \prompt 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psq…psql 命令 · 脚本与帮助 \psetpsql 命令本站词条这个命令设置影响查询结果表输出的选项。 option 指定要设置哪个选项。 value 的含义取决于所选的选项。对于某些选项，省略 value 会切换或取消设置该选项，具体见各选项的说明。如果没有提及这类行为，那么省略 value 只会显示当前设置。 输出与格式 \pset [ option [ value ] ] 客户端 psql 10.23 区分大小写的写法 \pset …psql 命令 · 输出与格式 \qpsql 命令本站词条退出 psql 程序。在脚本文件中，只会终止该脚本的执行。 脚本与帮助 \q or \quit 客户端 psql 10.23 区分大小写的写法 \q 本版手册中的写法 \q 此语法签名未列出 \quit 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端 psql 15.19 客户端…psql 命令 · 脚本与帮助 \qechopsql 命令本站词条这个命令与 \echo 相同，只是输出会写入由 \o 设置的查询输出通道。 脚本与帮助 \qecho text [ ... ] 客户端 psql 10.23 区分大小写的写法 \qecho 本版手册中的写法 \qecho 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端 psql …psql 命令 · 脚本与帮助 \quitpsql 命令本站词条退出 psql 程序。在脚本文件中，只会终止该脚本的执行。 脚本与帮助 \q or \quit 客户端 psql 10.23 区分大小写的写法 \quit 本版手册中的写法 \q 此语法签名未列出 \quit 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端 psql 15.19 …psql 命令 · 脚本与帮助 \rpsql 命令本站词条重置（清空）查询缓冲区。 查询缓冲区与编辑 \r or \reset 客户端 psql 10.23 区分大小写的写法 \r 本版手册中的写法 \r 此语法签名未列出 \reset 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端 psql 15.19 客户端 psql 16.15 …psql 命令 · 查询缓冲区与编辑 \resetpsql 命令本站词条重置（清空）查询缓冲区。 查询缓冲区与编辑 \r or \reset 客户端 psql 10.23 区分大小写的写法 \reset 本版手册中的写法 \r 此语法签名未列出 \reset 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psql 14.24 客户端 psql 15.19 客户端 psql 16…psql 命令 · 查询缓冲区与编辑 \restrictpsql 命令本站词条使用给定的密钥进入 “ 受限 ” 模式。在该模式下，唯一允许的元命令是用于退出受限模式的 \unrestrict 。密钥只能包含字母数字字符。 脚本与帮助 \restrict restrict_key 客户端 psql 13.23 区分大小写的写法 \restrict 本版手册中的写法 \restrict 此语法签名未列出 客户端 psql 14.24 客户端 psql 15…psql 命令 · 脚本与帮助 \spsql 命令本站词条打印 psql 的命令行历史记录到 filename 。如果省略 filename ，历史记录将被写入标准输出（如果适用，将使用分页器）。如果 psql 在构建时没有使用 Readline 支持，则此命令不可用。 查询缓冲区与编辑 \s [ filename ] 客户端 psql 10.23 区分大小写的写法 \s 本版手册中的写法 \s 此语法签名未列出 客户端 psql …psql 命令 · 查询缓冲区与编辑 \sendpipelinepsql 命令本站词条这组命令实现 SQL 语句的管道化。一个管道必须以 \startpipeline 开始，并以 \endpipeline 结束。其间可以出现任意数量的 \syncpipeline 命令，它会发送一条 同步消息 ，而不会结束当前管道，也不会刷新发送缓冲区。在管道模式下，语句会被发送到服务器，而不等待前面语句的结果。更多细节见 第 32.5 节 。 查询执行 \startpipel…psql 命令 · 查询执行 \setpsql 命令本站词条设置 psql 变量 name 为 value ，如果给出多个值，则设置为所有值的连接。如果只给出一个参数，则将变量设置为空字符串值。要取消变量设置，请使用 \unset 命令。 脚本与帮助 将 psql 变量 name 设置为 value ，如果给出多个值，则设置为所有值的串接。如果只给出一个参数，则将变量设置为空字符串值。要取消变量设置，请使用 \unset 命令。 \s…psql 命令 · 脚本与帮助 \setenvpsql 命令本站词条设置环境变量 name 为 value ，或者如果未提供 value ，则取消设置环境变量。示例： 脚本与帮助 \setenv name [ value ] 客户端 psql 10.23 区分大小写的写法 \setenv 本版手册中的写法 \setenv 此语法签名未列出 客户端 psql 11.22 客户端 psql 12.22 客户端 psql 13.23 客户端 psq…psql 命令 · 脚本与帮助 \sfpsql 命令本站词条这个命令获取并显示指定函数或过程的定义，以 CREATE OR REPLACE FUNCTION 或 CREATE OR REPLACE PROCEDURE 命令的形式呈现。定义将打印到当前查询输出通道，由 \o 设置。 查询缓冲区与编辑 这个命令获取并显示指定函数的定义，以 CREATE OR REPLACE FUNCTION 命令的形式呈现。定义将打印到当前查询输出通道，…psql 命令 · 查询缓冲区与编辑 \startpipelinepsql 命令本站词条这组命令实现 SQL 语句的管道化。一个管道必须以 \startpipeline 开始，并以 \endpipeline 结束。其间可以出现任意数量的 \syncpipeline 命令，它会发送一条 同步消息 ，而不会结束当前管道，也不会刷新发送缓冲区。在管道模式下，语句会被发送到服务器，而不等待前面语句的结果。更多细节见 第 32.5 节 。 查询执行 \startpipel…psql 命令 · 查询执行