pgsql.cc 提供对 postgresql.org 官网内容的中文翻译,由 Pigsty 团队维护。
百科 / psql 命令
反斜杠命令的完整语法、修饰符、示例与客户端版本变化。
当前查看 PostgreSQL 18.6。
共 130 个条目,PostgreSQL 18.6 收录 130 个。
\ir 命令与 \i 相似,但解析相对文件名的方式不同。在交互模式下执行时,这两个命令的行为相同。不过,在脚本中调用时, \ir 会相对于脚本所在的目录来解释文件名,而不是相对于当前工作目录。
\ir 命令与 \i 相似,但解析相对文件名的方式不同。在交互模式下执行时,这两个命令的行为相同。不过,在脚本中调用时, \ir 会相对于脚本所在的目录来解释文件名,而不是相对于当前工作目录。
提示用户提供文本,将其赋值给变量 name 。可以指定一个可选的提示字符串 text 。(对于多个单词的提示,用单引号括起文本。)
退出 psql 程序。在脚本文件中,只会终止该脚本的执行。
这个命令与 \echo 相同,只是输出会写入由 \o 设置的查询输出通道。
退出 psql 程序。在脚本文件中,只会终止该脚本的执行。
使用给定的密钥进入 “ 受限 ” 模式。在该模式下,唯一允许的元命令是用于退出受限模式的 \unrestrict 。密钥只能包含字母数字字符。
设置 psql 变量 name 为 value ,如果给出多个值,则设置为所有值的连接。如果只给出一个参数,则将变量设置为空字符串值。要取消变量设置,请使用 \unset 命令。
设置环境变量 name 为 value ,或者如果未提供 value ,则取消设置环境变量。示例:
带参数时,开启或关闭每条 SQL 语句执行耗时的显示。不带参数时,切换显示的开关状态。耗时以毫秒显示;超过 1 秒的时间间隔还会以分钟:秒的格式显示,必要时添加小时和天字段。
退出 “ 受限 ” 模式(即所有其他元命令都被阻止的模式),前提是指定的密钥与进入受限模式时传给 \restrict 的密钥匹配。
取消设置(删除) psql 变量 name 。
这个命令与 \echo 命令相同,只是输出将被写入 psql 的标准错误通道,而不是标准输出。
设置作为查询结果打印的表的标题,或取消此类标题。该命令等价于 \pset title title 。(此命令的名称源自 “ caption ” ,因为它过去只用于设置 HTML 表的标题。)
打开 HTML 查询输出格式。如果 HTML 格式已经打开,则切换回默认的对齐文本格式。此命令是为兼容性和便利性而保留的;设置其他输出选项的方法见 \pset 。
指定在 HTML 输出格式中放在 table 标签内的属性。这个命令等价于 \pset tableattr table_options 。
如果当前表格输出格式是非对齐,则切换为对齐;否则切换为非对齐。保留此命令是为了向后兼容。更通用的解决方案请参见 \pset 。
执行当前查询缓冲区(与 \g 类似),并以交叉表网格显示结果。查询必须返回至少三列。由 colV 标识的输出列成为纵向表头,由 colH 标识的输出列成为横向表头。 colD 标识要在网格中显示的输出列。 sortcolH 标识横向表头的可选排序列。
设置非对齐查询输出的字段分隔符。默认值是竖线( | )。它等同于 \pset fieldsep 。
打开 HTML 查询输出格式。如果 HTML 格式已经打开,则切换回默认的对齐文本格式。此命令是为兼容性和便利性而保留的;设置其他输出选项的方法见 \pset 。
将后续查询结果保存到文件 filename ,或通过管道传给 shell 命令 command 。如果没有指定参数,查询输出将恢复为标准输出。
将后续查询结果保存到文件 filename ,或通过管道传给 shell 命令 command 。如果没有指定参数,查询输出将恢复为标准输出。
这个命令设置影响查询结果表输出的选项。 option 指定要设置哪个选项。 value 的含义取决于所选的选项。对于某些选项,省略 value 会切换或取消设置该选项,具体见各选项的说明。如果没有提及这类行为,那么省略 value 只会显示当前设置。
切换输出中的列名标题和行数页脚的显示状态。这个命令等价于 \pset tuples_only ,提供它是为了使用方便。
设置或切换扩展表格格式模式。它等价于 \pset expanded 。
建立到 PostgreSQL 服务器的新连接。可以使用位置语法(数据库名称、用户、主机和端口中的一个或多个)指定要使用的连接参数,也可以使用 conninfo 连接字符串,详见 第 32.1.1 节 。如果没有给出参数,则使用与之前相同的参数建立新连接。
建立到 PostgreSQL 服务器的新连接。可以使用位置语法(数据库名称、用户、主机和端口中的一个或多个)指定要使用的连接参数,也可以使用 conninfo 连接字符串,详见 第 32.1.1 节 。如果没有给出参数,则使用与之前相同的参数建立新连接。
输出当前数据库连接的信息;如果正在使用 SSL,也包括与 SSL 相关的信息。
设置客户端字符集编码。没有参数时,此命令显示当前编码。
更改指定用户(默认为当前用户)的密码。此命令提示输入新密码,对其进行加密,并将其作为 ALTER ROLE 命令发送到服务器。这样可以确保新密码不会以明文形式出现在命令历史记录、服务器日志或其他地方。
已收录首次收录接口或属性变化不再收录
版本方格表示采样构建中的收录情况,不代表实际引入时间。点击方格可查看对应版本的定义和来源。
版本选择指 psql 客户端构建。反斜杠命令区分大小写,例如 \dD 与 \dd 不同;相关写法可能共用手册语法块。