PostgreSQL 文档检索
PG 18 · 按类别浏览,或输入名称与关键词
分类索引132
\dc列出字符集编码之间的转换。如果指定了 pattern ,则只列出名称与模式匹配的转换。默认情况下,只显示用户创建的对象;提供模式或 S 修饰符可包括系统对象。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其相关描述一起列出。
描述数据库对象
列出字符集编码之间的转换。如果指定了 pattern ,则只列出名称匹配该模式的转换。默认…psql 命令 · 描述数据库对象
\dconfig列出服务器配置参数及其值。如果指定了 pattern ,则只列出名称与模式匹配的参数。不带 pattern 时,只列出被设置为非默认值的参数。(使用 \dconfig * 可查看所有参数。)如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个参数都会连同其数据类型、该参数可设置的上下文以及访问权限(如果已授予非默认访问权限)一起列出。
描述数据库对…psql 命令 · 描述数据库对象
\dd显示 constraint 、 operator class 、 operator family 、 rule 和 trigger 类型对象的描述。其他注释可通过对应对象类型的反斜线命令查看。
描述数据库对象
显示类型为 constraint 、 operator class 、 operator family 、 rule 和 trigger 的对象的描述。其他所有注释都可…psql 命令 · 描述数据库对象
\ddp列出默认访问权限设置。对于每个默认权限设置已偏离内置默认值的角色(以及适用时的模式),都会显示一条记录。如果指定了 pattern ,则只列出角色名或模式名与模式匹配的记录。如果在命令名后追加 x ,结果会以扩展模式显示。
描述数据库对象
列出默认访问权限设置。对于默认权限设置已偏离内置默认值的每个角色(以及模式,如果适用),都会显示一个条目。如果指定了 pattern ,则…psql 命令 · 描述数据库对象
\des列出外部服务器(助记符: “ external servers ” )。如果指定了 pattern ,则只列出名称与模式匹配的服务器。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则会显示每个服务器的完整描述,包括服务器的访问权限、类型、版本、选项和描述。
描述数据库对象
列出外部服务器(助记词: “ external servers ” )。如果…psql 命令 · 描述数据库对象
\det列出外部表(助记符: “ external tables ” )。如果指定了 pattern ,则只列出表名或模式名与模式匹配的条目。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则还会显示通用选项以及外部表描述。
描述数据库对象
列出外部表(助记词: “ external tables ” )。如果指定了 pattern ,则只列出表名或模式名匹…psql 命令 · 描述数据库对象
\deu列出用户映射(助记符: “ external users ” )。如果指定了 pattern ,则只列出用户名与模式匹配的映射。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则会显示每个映射的附加信息。
描述数据库对象
列出用户映射(助记词: “ external users ” )。如果指定了 pattern ,则只列出用户名匹配该模式的映射。如…psql 命令 · 描述数据库对象
\dew列出外部数据包装器(助记符: “ external wrappers ” )。如果指定了 pattern ,则只列出名称与模式匹配的外部数据包装器。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则还会显示外部数据包装器的访问权限、选项和描述。
描述数据库对象
列出外部数据包装器(助记词: “ external wrappers ” )。如果指定了 …psql 命令 · 描述数据库对象
\df列出函数,以及它们的结果数据类型、参数数据类型和函数类型,函数类型分为 “ agg ” (聚合)、 “ normal ” 、 “ procedure ” 、 “ trigger ” 或 “ window ” 。要只显示特定类型的函数,请在命令后添加相应的字母 a 、 n 、 p 、 t 或 w 。如果指定了 pattern ,则只显示名称与模式匹配的函数。任何附加参数都是类型名…psql 命令 · 描述数据库对象
\dg列出数据库角色。(由于 “ 用户 ” 和 “ 组 ” 的概念已经统一为 “ 角色 ” ,此命令现在等同于 \du 。)默认情况下,只显示用户创建的角色;提供 S 修饰符可包括系统角色。如果指定了 pattern ,则只列出名称与模式匹配的角色。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则会显示每个角色的附加信息;目前这会增加每个角色的注释。
描…psql 命令 · 描述数据库对象
\di在这组命令中,字母 E 、 i 、 m 、 s 、 t 和 v 分别表示外部表、索引、物化视图、序列、表和视图。你可以按任意顺序指定其中任意一个或多个字母,以获取这些类型对象的列表。例如, \dti 会列出表和索引。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其持久性状态(永久、临时或不记录 WAL)、磁盘上的物理大小以及相关描述…psql 命令 · 描述数据库对象
\dl这是 \lo_list 的别名,后者会显示大对象列表。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则会列出每个大对象的相关权限(如果有)。
描述数据库对象
这是 \lo_list 的别名,用于显示大对象列表。
\dl
客户端 psql 10.23
区分大小写的写法 \dl
本版手册中的写法
\dl 此语法签名未列出
客户端 psql 11.22
…psql 命令 · 描述数据库对象
\dm在这组命令中,字母 E 、 i 、 m 、 s 、 t 和 v 分别表示外部表、索引、物化视图、序列、表和视图。你可以按任意顺序指定其中任意一个或多个字母,以获取这些类型对象的列表。例如, \dti 会列出表和索引。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其持久性状态(永久、临时或不记录 WAL)、磁盘上的物理大小以及相关描述…psql 命令 · 描述数据库对象
\dn列出模式(命名空间)。如果指定了 pattern ,则只列出名称与模式匹配的模式。默认情况下,只显示用户创建的对象;提供模式或 S 修饰符可包括系统对象。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其相关权限和描述(如果有)一起列出。
描述数据库对象
列出模式(命名空间)。如果指定了 pattern ,则只列出名称匹配该模式的模…psql 命令 · 描述数据库对象
\do列出操作符及其操作数类型和结果类型。如果指定了 pattern ,则只列出名称与模式匹配的操作符。如果指定了一个 arg_pattern ,则只列出其右参数类型名称与该模式匹配的前缀操作符。如果指定了两个 arg_pattern ,则只列出参数类型名称与这些模式匹配的二元操作符。(对于一元操作符未使用的参数,也可以写成 - 。)默认情况下,只显示用户创建的对象;提供模式或 S …psql 命令 · 描述数据库对象
\dp列出表、视图和序列及其相关访问权限。如果指定了 pattern ,则只列出名称与模式匹配的表、视图和序列。默认情况下,只显示用户创建的对象;提供模式或 S 修饰符可包括系统对象。如果在命令名后追加 x ,结果会以扩展模式显示。
描述数据库对象
列出表、视图和序列及其关联的访问权限。如果指定了 pattern ,则只列出名称匹配该模式的表、视图和序列。
\dp [ patter…psql 命令 · 描述数据库对象
\drds列出已定义的配置设置。这些设置可以特定于角色、特定于数据库,或同时特定于两者。 role-pattern 和 database-pattern 分别用于选择要列出的角色和数据库。省略某个模式参数或将其指定为 * 时,不会按该参数筛选,还会分别包含不特定于角色或不特定于数据库的设置。如果在命令名后追加 x ,结果会以扩展模式显示。
描述数据库对象
列出已定义的配置设置。这些设置…psql 命令 · 描述数据库对象
\drg列出每个被授予角色成员身份的信息,包括被授予的选项( ADMIN 、 INHERIT 和/或 SET )以及授予者。关于角色成员身份,参见 GRANT 命令。
描述数据库对象
\drg[S] [ pattern ]
客户端 psql 16.15
区分大小写的写法 \drg
本版手册中的写法
\drg S
客户端 psql 17.11
\drg[Sx] [ pattern ]
…psql 命令 · 描述数据库对象
\ds在这组命令中,字母 E 、 i 、 m 、 s 、 t 和 v 分别表示外部表、索引、物化视图、序列、表和视图。你可以按任意顺序指定其中任意一个或多个字母,以获取这些类型对象的列表。例如, \dti 会列出表和索引。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其持久性状态(永久、临时或不记录 WAL)、磁盘上的物理大小以及相关描述…psql 命令 · 描述数据库对象
\dt在这组命令中,字母 E 、 i 、 m 、 s 、 t 和 v 分别表示外部表、索引、物化视图、序列、表和视图。你可以按任意顺序指定其中任意一个或多个字母,以获取这些类型对象的列表。例如, \dti 会列出表和索引。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其持久性状态(永久、临时或不记录 WAL)、磁盘上的物理大小以及相关描述…psql 命令 · 描述数据库对象
\du列出数据库角色。(由于 “ 用户 ” 和 “ 组 ” 的概念已经统一为 “ 角色 ” ,此命令现在等同于 \dg 。)默认情况下,只显示用户创建的角色;提供 S 修饰符可包括系统角色。如果指定了 pattern ,则只列出名称与模式匹配的角色。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则会显示每个角色的附加信息;目前这会增加每个角色的注释。
描…psql 命令 · 描述数据库对象
\dv在这组命令中,字母 E 、 i 、 m 、 s 、 t 和 v 分别表示外部表、索引、物化视图、序列、表和视图。你可以按任意顺序指定其中任意一个或多个字母,以获取这些类型对象的列表。例如, \dti 会列出表和索引。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其持久性状态(永久、临时或不记录 WAL)、磁盘上的物理大小以及相关描述…psql 命令 · 描述数据库对象
\dx列出已安装的扩展。如果指定了 pattern ,则只列出名称与模式匹配的扩展。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则会列出属于每个匹配扩展的全部对象。
描述数据库对象
列出已安装的扩展。如果指定了 pattern ,则只列出名称匹配该模式的扩展。如果使用 \dx+ 形式,则列出属于每个匹配扩展的所有对象。
\dx[+] [ pattern…psql 命令 · 描述数据库对象
\dy列出事件触发器。如果指定了 pattern ,则只列出名称与模式匹配的事件触发器。如果在命令名后追加 x ,结果会以扩展模式显示。如果在命令名后追加 + ,则每个对象都会连同其相关描述一起列出。
描述数据库对象
列出事件触发器。如果指定了 pattern ,则只列出名称匹配该模式的事件触发器。如果在命令名后附加 + ,还会列出每个对象关联的描述。
\dy[+] [ patte…psql 命令 · 描述数据库对象
\e如果指定了 filename ,则编辑该文件;编辑器退出后,文件内容将被复制到当前查询缓冲区。如果没有给出 filename ,则将当前查询缓冲区复制到临时文件中,然后以相同方式进行编辑。或者,如果当前查询缓冲区为空,则将最近执行的查询复制到临时文件中,并以相同方式进行编辑。
查询缓冲区与编辑
如果指定了 filename ,则编辑该文件;编辑器退出后,将文件内容复制到当前查…psql 命令 · 查询缓冲区与编辑
\echo将求值后的参数打印到标准输出,用空格分隔,并在末尾加上换行符。这对于在脚本输出中穿插信息很有用。例如:
脚本与帮助
将参数打印到标准输出,参数之间用一个空格分隔,末尾跟随换行符。这可用于在脚本输出中插入信息。例如:
\echo text [ ... ]
客户端 psql 10.23
区分大小写的写法 \echo
本版手册中的写法
\echo 此语法签名未列出
客户端 psql…psql 命令 · 脚本与帮助
\edit如果指定了 filename ,则编辑该文件;编辑器退出后,文件内容将被复制到当前查询缓冲区。如果没有给出 filename ,则将当前查询缓冲区复制到临时文件中,然后以相同方式进行编辑。或者,如果当前查询缓冲区为空,则将最近执行的查询复制到临时文件中,并以相同方式进行编辑。
查询缓冲区与编辑
如果指定了 filename ,则编辑该文件;编辑器退出后,将文件内容复制到当前查…psql 命令 · 查询缓冲区与编辑
\ef这个命令获取并编辑指定函数或过程的定义,形式为 CREATE OR REPLACE FUNCTION 或 CREATE OR REPLACE PROCEDURE 命令。编辑方式与 \edit 相同。如果在不保存的情况下退出编辑器,则该语句会被丢弃。如果保存并退出编辑器,并在其中添加了分号,则更新后的命令会立即执行。否则它会重新显示;键入分号或 \g 发送它,或用 \r 取消。
…psql 命令 · 查询缓冲区与编辑
\elif这组命令实现了可嵌套的条件块。条件块必须以 \if 开始,并以 \endif 结束。在两者之间可以有任意数量的 \elif 子句,后面可以选择性地跟着一个 \else 子句。在形成条件块的命令之间通常会出现普通查询和其他类型的反斜线命令。
脚本与帮助
这组命令实现了可嵌套的条件块。条件块必须以 \if 开始,以 \endif 结束。中间可以包含任意数量的 \elif 子句,后…psql 命令 · 脚本与帮助
\else这组命令实现了可嵌套的条件块。条件块必须以 \if 开始,并以 \endif 结束。在两者之间可以有任意数量的 \elif 子句,后面可以选择性地跟着一个 \else 子句。在形成条件块的命令之间通常会出现普通查询和其他类型的反斜线命令。
脚本与帮助
这组命令实现了可嵌套的条件块。条件块必须以 \if 开始,以 \endif 结束。中间可以包含任意数量的 \elif 子句,后…psql 命令 · 脚本与帮助
\encoding设置客户端字符集编码。没有参数时,此命令显示当前编码。
连接与会话
\encoding [ encoding ]
客户端 psql 10.23
区分大小写的写法 \encoding
本版手册中的写法
\encoding 此语法签名未列出
客户端 psql 11.22
客户端 psql 12.22
客户端 psql 13.23
客户端 psql 14.24
客户端 psql 1…psql 命令 · 连接与会话
\endif这组命令实现了可嵌套的条件块。条件块必须以 \if 开始,并以 \endif 结束。在两者之间可以有任意数量的 \elif 子句,后面可以选择性地跟着一个 \else 子句。在形成条件块的命令之间通常会出现普通查询和其他类型的反斜线命令。
脚本与帮助
这组命令实现了可嵌套的条件块。条件块必须以 \if 开始,以 \endif 结束。中间可以包含任意数量的 \elif 子句,后…psql 命令 · 脚本与帮助
\endpipeline这组命令实现 SQL 语句的管道化。一个管道必须以 \startpipeline 开始,并以 \endpipeline 结束。其间可以出现任意数量的 \syncpipeline 命令,它会发送一条 同步消息 ,而不会结束当前管道,也不会刷新发送缓冲区。在管道模式下,语句会被发送到服务器,而不等待前面语句的结果。更多细节见 第 32.5 节 。
查询执行
\startpipel…psql 命令 · 查询执行
\errverbose以最大的详细程度重复最近的服务器错误消息,就好像 VERBOSITY 被设置为 verbose , SHOW_CONTEXT 被设置为 always 一样。
脚本与帮助
\errverbose
客户端 psql 10.23
区分大小写的写法 \errverbose
本版手册中的写法
\errverbose 此语法签名未列出
客户端 psql 11.22
客户端 psql 12…psql 命令 · 脚本与帮助
\ev这个命令获取并编辑指定视图的定义,形式为 CREATE OR REPLACE VIEW 命令。编辑方式与 \edit 相同。如果在不保存的情况下退出编辑器,则该语句会被丢弃。如果保存并退出编辑器,并在其中添加了分号,则更新后的命令会立即执行;否则将重新显示;输入分号或 \g 发送它,或用 \r 取消。
查询缓冲区与编辑
这个命令获取并编辑指定视图的定义,形式为 CREATE …psql 命令 · 查询缓冲区与编辑
\f设置非对齐查询输出的字段分隔符。默认值是竖线( | )。它等同于 \pset fieldsep 。
输出与格式
\f [ string ]
客户端 psql 10.23
区分大小写的写法 \f
本版手册中的写法
\f 此语法签名未列出
客户端 psql 11.22
客户端 psql 12.22
客户端 psql 13.23
客户端 psql 14.24
客户端 psql 15…psql 命令 · 输出与格式
\flush这组命令实现 SQL 语句的管道化。一个管道必须以 \startpipeline 开始,并以 \endpipeline 结束。其间可以出现任意数量的 \syncpipeline 命令,它会发送一条 同步消息 ,而不会结束当前管道,也不会刷新发送缓冲区。在管道模式下,语句会被发送到服务器,而不等待前面语句的结果。更多细节见 第 32.5 节 。
查询执行
\startpipel…psql 命令 · 查询执行
\flushrequest这组命令实现 SQL 语句的管道化。一个管道必须以 \startpipeline 开始,并以 \endpipeline 结束。其间可以出现任意数量的 \syncpipeline 命令,它会发送一条 同步消息 ,而不会结束当前管道,也不会刷新发送缓冲区。在管道模式下,语句会被发送到服务器,而不等待前面语句的结果。更多细节见 第 32.5 节 。
查询执行
\startpipel…psql 命令 · 查询执行
\g将当前查询缓冲区发送给服务器执行。
查询执行
将当前查询缓冲区发送给服务器执行。如果给出参数,查询输出会写入指定文件或通过管道传递给给定的 shell 命令,而不是按通常方式显示。只有查询成功返回零个或更多元组时,才会向文件或命令写入内容;如果查询失败或 SQL 命令不返回数据,则不会写入。
\g [ filename ] \g [ | command ]
客户端 psql …psql 命令 · 查询执行
\gdesc显示当前查询缓冲区中查询结果的描述(即列名和数据类型)。查询并不会实际执行;不过,如果其中存在语法错误,会按通常的方式报告。
查询执行
\gdesc
客户端 psql 11.22
区分大小写的写法 \gdesc
本版手册中的写法
\gdesc 此语法签名未列出
客户端 psql 12.22
客户端 psql 13.23
客户端 psql 14.24
客户端 psql 15.1…psql 命令 · 查询执行
更多结果
输入名称或关键词,从 PostgreSQL 手册与扩展目录中直接找到定义。
pg17: 限定版本 ex: 只搜扩展 ↑↓ 选择 ↵ 打开