psql

如果目前的表格输出格式是未对齐，它会切换成对齐。如果是对齐的，则切换成未对齐。这个命令是为了保持向后兼容。更一般化的解决方案可见\pset。

建立一个到PostgreSQL服务器的新连接。如果新连接被成功建立，之前的连接将被关闭。如果dbname、username、host或port被忽略或被指定为-，将使用之前连接的值。如果之前没有连接，将使用该参数的libpq默认值。

如果连接尝试失败（错误的用户名、访问被拒绝等），那么只有psql处于交互模式时才将保留前面的连接。当运行一个非交互脚本时，处理将立即停止并返回一个错误。选择这样的区别一方面是为便于用户避免笔误，另一方面也是一种安全机制保证脚本不会碰巧在错误的数据库上执行。

把正在打印的任何表格的标题设置为一个查询的结果或者取消这样的设置。这条命令等效于\pset title title（这条命令的名称源于"caption"， 因为它以前只被用来设置一个HTML表格中的标题）。

把当前工作目录改为directory。没有参数则改为当前用户的主目录。

输出有关当前数据库连接的信息。

执行一次前端（客户端）拷贝。这是一个运行SQL COPY命令的操作，不同之处在于读写指定文件的是服务器，而psql读写该文件并且在服务器和本地文件系统之间传送数据。这意味着文件可访问性和权限都是本地用户而不是服务器的，因此不需要 SQL 超级用户权限。

当指定了program时，command会被psql执行并且来自或者去向command的数据被在服务器和客户端之间传送。这意味着执行权限是本地用户而不是服务器的，因此不需要 SQL 超级用户权限。

\copy ... from stdin | to stdout分别基于该命令的输入和输出进行读/写。所有行都从发出命令的同一个源读取，直到读到\.或者流达到EOF。输出被发送到和命令输出相同的位置。要从psql的标准输入或者输出读/写，可以使用pstdin或者pstdout。这个选项有助于在一个 SQL 脚本文件中嵌入填充表的动作。

该命令的语法类似于SQL COPY命令，并且option必须指示SQL COPY命令的选项之一。注意正因为这样，对\copy命令会应用特殊的解析规则。尤其是变量替换规则和反斜线转义不适合\copy。

显示PostgreSQL的版权和分发条款。

对于每个匹配pattern的关系（表、视图、索引、序列或者外部表）或者组合类型，显示所有列、它们的类型、表空间（如果不是默认表空间）和任何特殊属性（诸如NOT NULL或默认值）。相关的索引、约束、规则和触发器也会被显示。对于外部表，相关的外部服务器也会被显示（"匹配模式"被定义在下文的模式中）。

对于一些类型的关系，\d为每一列显示额外的信息：序列的列值、索引的被索引表达式以及外部表的外部数据包装器选项。

命令形式\d+是同样的，不过会显示更多信息：任何与该表列相关的注释也会被显示，还有表中是否出现 OID，如果关系是一个视图还会显示视图的定义。

默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

列举聚集函数，以及它们的返回类型和它们所操作的数据类型。如果指定了pattern，只有名称匹配该模式的聚集会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

列出表空间。如果指定了pattern，只有名称匹配该模式的表空间会被显示。如果在命令名称后追加了+，还会为每个对象列出其相关权限。

列出字符集编码之间的转换。如果指定了pattern，只有名称匹配该模式的转换会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。如果在命令名称后追加了+，还会为每个对象列出其相关的描述。

列出类型造型。如果指定了pattern，只有源类型或目标类型匹配该模式的造型会被显示。如果在命令名称后追加了+，还会为每个对象列出其相关的描述。

显示类型为constraint、 operator class、operator family、 rule和trigger的对象的描述。所有其他注释可以用那些对象类型的相应反斜线命令查看。

\dd显示匹配pattern的对象的描述，如果没有给定参数则显示合适类型的可见对象。但是在两种情况下，都只会列出有一个描述的对象。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

对象的描述可以用COMMENT SQL命令创建。

列出默认的访问特权设置。为每一个其默认特权设置已经被改得与内建默认值不同的角色（以及模式，如果适用）显示一项。如果指定了pattern，只有角色名或模式名匹配该模式的项会被显示。

ALTER DEFAULT PRIVILEGES命令被用来设置默认的访问特权。所显示特权的含义在GRANT中解释。

列出域。如果指定了pattern，只有名称匹配该模式的域会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。如果在命令名称后追加了+，还会为每个对象列出其相关的权限和描述。

在这一组命令中，字母E、 i、m、s、 t以及v分别表示外部表、索引、物化视图、序列、表和视图。你可以用任何顺序指定任意或者所有这些字母来获得一个这些类型对象的列表。例如，\dit会列出索引和表。如果在命令名称后追加了+，还会为每个对象列出其在磁盘上的物理尺寸以及其相关的描述（如果有）。如果指定了pattern，只有名称匹配该模式的对象会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

列出外部服务器。如果指定了pattern，只有名称匹配该模式的服务器会被列出。如果使用了形式\des+，将显示每个服务器的完整描述，包括该服务器的 ACL、类型、版本、选项和描述。

列出外部表。如果指定了pattern，只有表名或模式名匹配该模式的项会被显示。如果使用了形式\det+，通用选项和外部表的描述也会被显示。

列出用户映射（助记："外部用户"）。如果指定了pattern，只有用户名匹配该模式的映射会被显示。如果使用了形式\deu+，还会显示关于每个映射的额外信息。

列出外部数据包装器（助记："外部包装器"）。如果指定了pattern，只有名称匹配该模式的外部数据包装器会被显示。如果使用了形式\dew+，外部数据包装器的 ACL、选项和描述也会被显示。

列出函数和它们的参数、返回类型和函数类型，函数类型被分成"agg"（聚集）、 "normal"、"trigger"或"window"。要只显示指定类型的函数，在该命令中加入相应的字母a、n、t或w。如果指定了pattern，只有名称匹配该模式的函数会被显示。如果使用了形式\df+，每个函数的额外信息也会被显示，包括安全性、易变性、源代码和描述。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

列出文本搜索配置。如果指定了pattern，只有名称匹配该模式的配置会被显示。如果使用了形式\dF+，将显示每一种配置的完整描述，包括底层的文本搜索解析器以及用于每一种解析器记号类型的词典列表。

列出文本搜索词典。如果指定了pattern，只有名称匹配该模式的词典会被显示。如果使用了形式\dFd+，将显示关于每一个选中词典的额外信息，包括底层的文本搜索模板和选项值。

列出文本搜索解析器。如果指定了pattern，只有名称匹配该模式的解析器会被显示。如果使用了形式\dFp+，将显示每一个解析器的完整描述，包括底层函数和识别的记号类型的列表。

列出文本搜索模板。如果指定了pattern，只有名称匹配该模式的模板会被显示。如果使用了形式\dFt+，将显示有关每一个模板的额外信息，包括底层的函数名。

列出数据库角色（由于"users"和"groups"的概念已经被统一成了"roles"，这个命令等效于\du）。如果指定了pattern，只有名称匹配该模式的那些角色会被显示。如果使用了形式\dg+，将显示有关每个角色的额外信息，当前这会为每个角色增加注释。

这是\lo_list的一个别名，它会显示一个大对象的列表。

列出过程语言。如果指定了pattern，只有名称匹配该模式的语言会被列出。默认情况下，只有用户创建的语言被显示；提供S修饰符可以包括系统对象。如果在命令名称后追加了+，还会为每种语言列出其调用句柄、验证器、访问特权以及它是否为系统对象。

列出模式（命名空间）。如果指定了pattern，只有名称匹配该模式的模式会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。如果在命令名称后追加了+，还会为每个对象列出其相关的权限和描述（如果有）。

列出操作符以及它们的操作数和返回类型。如果指定了pattern，只有名称匹配该模式的操作符会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

列出排序规则。如果指定了pattern，只有名称匹配该模式的排序规则会被显示。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。如果在命令名称后追加了+，还会为每种排序规则列出其相关的描述（如果有）。注意只有当前数据库编码可用的排序规则才会被显示，因此同一安装的不同数据库中的结果可能不同。

列出表、视图和序列及其相关的访问特权。如果指定了pattern，只有名称匹配该模式的表、视图和序列会被列出。

GRANT和REVOKE命令被用于设置访问特权。显示的特权在GRANT中解释。

列出已定义的配置设置。这些设置可以是角色相关的、数据库相关的或两者都相关的。role-pattern以及database-pattern分别被用来选择特定的角色和数据库到列表中。如果被忽略，或者指定了*，所有的设置都会被列出，分别包括非角色相关或非数据库相关的。

ALTER ROLE和ALTER DATABASE命令被用来定义针对每个角色和每个数据库的配置设置。

列出数据类型。如果指定了pattern，只有名称匹配该模式的类型会被列出。如果在命令名称后追加了+，还会为每种类型列出其内部名称和尺寸、它的允许值（如果它是一个enum类型）及其相关的权限。默认情况下，只有用户创建的对象被显示；提供一个模式或者S修饰符可以包括系统对象。

列出数据库角色（因为"users"和"groups"的概念已经被统一成了"roles"，这个命令现在等效于\dg）。如果指定了pattern，只有名称匹配该模式的那些角色会被显示。如果使用了形式\du+，将显示有关每个角色的额外信息，当前这会为每个角色增加注释。

列出已安装的扩展。如果指定了pattern，只有名称匹配该模式的那些扩展会被列出。如果使用了形式\dx+，所有属于每个匹配扩展的对象都会被列出。

列出事件触发器。如果指定了pattern，只有名称匹配该模式的那些数据触发器会被列出。如果在命令名称后追加了+，还会为每个对象列出其相关的描述。

如果指定了filename，该文件会被编辑。在编辑器退出后，它的内容被复制回查询缓冲区。如果没有给出filename，当前的查询缓冲区会被复制到一个临时文件，然后该文件会被以同样的方式编辑。

新的查询缓冲区接着被根据psql的一般规则再解析，这里整个缓冲区被当做一个单一行（因此你不能用这种方式制作脚本。要制作脚本可使用\i）。这意味着如果查询以一个分号结束（或者包含一个分号），它会立即被执行。否则它将仅仅在查询缓冲区中等待，键入分号或\g可以发送它，或者键入\r取消之。

如果指定了一个行号，psql将把游标定位在文件或查询缓冲区的指定行上。注意如果给出了一个单一的全为数字的参数，psql会假定它是一个行号而不是一个文件名。

把参数打印到标准输出，用一个空格分隔并且最后跟一个新行。这可以用于脚本输出中的散布信息。例如：

=> \echo `date`
Tue Oct 26 21:40:57 CEST 1999

如果第一个参数是一个未引用的-n，不会有拖尾的新行。

这个命令以一个CREATE OR REPLACE FUNCTION命令的形式取得并且编辑命名函数的定义。编辑以\edit相同的方式完成。在编辑器退出后，被更新的命令会等在查询缓冲区中。输入分号或\g可以发送它，或者输入\r来取消它。

目标函数能单独用名称指定，或者用名称和参数指定，例如foo(integer, text)。如果同一个名称有多于一个函数，必须给出参数类型。

如果没有指定函数，一个空白的CREATE FUNCTION模板会被用于编辑。

如果指定了一个行号，psql将把游标定位在函数体的指定行上（注意函数体通常不是从该文件的第一行开始）。

设置客户端字符集编码。如果没有参数，这个命令会显示当前的编码。

为未对齐的查询输出设置域分隔符。默认值是竖线（|）。设置输出选项的一种通用方法还可参见\pset。

把当前查询输入缓冲区发送到服务器并且可选地存储查询输出在filename中或者把输出用管道传输到一个单独的 Unix shell 中来执行command。只有该查询成功地返回零个或多个元组才会写该文件或命令，而查询失败或者是一个非数据返回 SQL 命令的则不会写该文件或命令。

一个裸的\g本质上等效于一个分号。一个带参数的\g是\o命令的一个"one-shot"替换方案。

把当前查询输入缓冲区发送到服务器并且可选地存储查询输出在psql变量中（见变量）。要被执行的查询必须正好返回一行。该行的每一列被存储到一个单独的变量，该变量按照列命名。例如：

=> SELECT 'hello' AS var1, 10 AS var2
-> \gset
=> \echo :var1 :var2
hello 10

如果你指定了一个prefix，该字符串是为查询的列名创建变量名而预先准备的：

=> SELECT 'hello' AS var1, 10 AS var2
-> \gset result_
=> \echo :result_var1 :result_var2
hello 10

如果一个列结果是 NULL，对应的变量会被重置而不是被设置。

如果查询失败或者不返回一行，没有变量会被改变。

给出指定的SQL命令的语法帮助。如果没有指定command，那么psql将列出所有语法帮助可用的命令。如果command是一个星号（*），那么所有SQL命令的语法帮助都会被显示。

打开HTML查询输出格式。如果HTML格式已经打开，它会被切换回默认的对齐文本格式。这个命令是为了兼容性和方便性而存在的，有关设置其他输出选项可见\pset。

从文件filename读取输入并且执行它，就好像它是从键盘输入的一样。

\ir命令类似于\i，但是不同的是会解析相对文件名。在交互模式中执行时，两种命令的行为是相同的。不过，在从一个脚本中调用时，\ir会相对于脚本被找到的目录而不是当前工作目录解释文件名。

列出服务器中的数据库并且显示它们的名称、拥有者、字符集编码以及访问特权。如果指定了pattern，只有名称匹配该模式的数据库被列出。如果在命令名称后追加了+，还会显示数据库尺寸、默认表空间和描述（只有当前用户能够连接的数据库的尺寸信息才可用）。

从服务器读取OID loid所对应的大对象并且将它写到filename中。注意这和服务器函数lo_export略有不同，该服务器函数使用运行数据库服务器的那个用户的权限操作，并且它会在服务器文件系统上操作。

将文件存储到一个PostgreSQL大对象中。可选地，它能把一段给定注释关联到该对象。例如：

foo=> \lo_import '/home/peter/pictures/photo.xcf' 'a picture of me'
lo_import 152801

该响应指出大对象接收到了对象 ID 152801，这可以被用来访问未来新创建的大对象。为了阅读方便，我们推荐总是为每一个兑现关联一段人类可读的注释。OID 和注释都能用\lo_list命令查看。

注意这个命令与服务器端的lo_import略有不同，因为它会作为本地用户在本地文件系统上操作，而不是作为服务器用户在服务器文件系统上操作。

显示当前存储在数据库中所有PostgreSQL大对象的一个列表，以及为它们提供的任何注释。

从数据库删除OID loid所对应的大对象。

保存未来的查询结果到文件filename中或者将未来的结果用管道导入一个单独的 Unix shell 来执行command。如果没有指定参数，查询输出将被重置到标准输出。

"查询结果"包括所有表、命令响应和从数据库服务器得到的通知，还有多种查询数据库的反斜线命令（例如\d）的输出，但不包括错误消息。

打印当前查询缓冲区到标准输出。

更改指定用户（默认指当前用户）的口令。这个命令会提示要求新口令、加密它并且把它作为一个ALTER ROLE命令发送到服务器。这确保了新口令不会以明文出现在命令历史、服务器日志或其他地方。

提示用户提供文本，这会被赋值给变量name。可以指定一个可选的提示字符串text（对于多个词的提示要在文本周围包围上单引号）。

默认情况下，\prompt使用终端用于输入和输出。不过，如果-f命令行开关会被使用，\prompt会使用标准输入和标准输出。

这个命令设置影响查询结果表输出的选项。option指出要设置哪个选项。value的语义根据选中的选项变化。对于一些选项，忽略value会导致该选项被切换或者重设，具体如特定选项中所述。如果没有提到这样的行为，那么忽略value只会导致当前设置被显示。

可调整的打印选项是：

这些不同的格式外观的展示可以见例子节。

退出psql程序。在一个脚本文件中，只有该脚本的执行会被终止。

这个命令与\echo一样，不过输出将被写出到\o设置的查询输出通道。

重置（清除）查询缓冲区。

打印或保存命令行历史到filename中。如果filename被忽略，历史会被写到标准输出。这个选项只有psql被配置为使用GNU Readline库时才可用。

设置psql变量name为value，或者在给出多于一个值时设置为所有值的串接。如果只给出了一个参数，边讲将用一个空值设置。要重置一个变量，使用\unset命令。

不带任何参数的\set显示所有当前设置的psql变量的名称和值。

可用的变量名称能够包含字母、数字和下划线。详见变量。变量名是大小写敏感的。

尽管我们欢迎你把任何变量设置为任何你想要的东西，psql会把多个变量当作特殊的。它们在有关变量的小节中记录。

设置环境变量name为value，或者在没有提供value时重设环境变量。例如：

testdb=> \setenv PAGER less
testdb=> \setenv LESS -imx4F

这个命令取出并且以一个CREATE OR REPLACE FUNCTION命令的形式显示该命名函数的定义。该定义被打印到\o设置的当前查询输出通道。

目标函数能用名称单独指定，也可以用名称和参数指定，例如foo(integer, text)。如果同一个名称有多于一个函数，必须给出参数类型。

如果+被追加到命令名称，那么输出行会被编号，函数体的第一行开始于行号 1。

切换输出列名称标题以及行计数页脚的显示。这个命令等效于\pset tuples_only并且是为了便利而提供。

指定HTML输出格式中table标签内要被替换的属性。这个命令等效于\pset tableattr table_options。

没有参数时，切换显示还是不显示每个 SQL 语句的执行时间，以毫秒计。有参数则按参数设置。

重设（删除）psql变量name。

把当前查询缓冲区输出到文件filename或是用管道导到 Unix 命令command。

反复执行当前的查询缓冲区（像\g）直到被打断或查询失败。在两次执行之间等待指定的秒数（默认为 2 秒）。

设置或切换扩展表格格式化模式。这样它等效于\pset expanded。

列出表格、视图和序列及它们相关的访问特权。如果指定了一个pattern，只有名称匹配该模式的表、视图和序列会被列出。

这是\dp的一个别名（"显示特权"）。

转义为一个独立的 Unix shell 或者执行 Unix 命令command。参数不会被进一步解释，shell 将看到它们原来的样子。特别地，变量替换规则和反斜线转义不适用。

显示有关反斜线命令的帮助信息。