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命令的特殊分析规则。 尤其是变量替换规则和反斜杠逃逸规则将不起作用。

显示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" (aggregate)、"normal"、"trigger"或 "window"的函数和它们的参数、返回类型和函数类型。 要想只显示指定类型的函数，在命令中添加对应的字母a、 n、t或w。如果声明了 pattern， 那么只显示名字匹配该模式的函数。如果使用了\df+格式， 则也显示关于每个函数的额外信息，包括安全、波动性、语言、源代码和描述。 缺省的，只显示用户创建的对象；提供一个模式或S 修饰符包含系统对象。

列出文本搜索配置。如果声明了pattern， 那么只显示名字匹配该模式的配置。如果使用了\dF+格式， 则显示每个配置的全部描述，包括底层的文本搜索解析器和为每个解析器标记类型列出的字典。

列出文本搜索字典。如果声明了pattern， 那么只显示名字匹配该模式的字典。如果使用了\dFd+格式， 则显示关于每个选中的字典的额外信息，包括底层的文本搜索模板和选项值。

列出文本搜索解析器。如果声明了pattern， 只显示名字匹配该模式的解析器。如果使用了\dFp+格式， 则显示每个解析器的全部描述，包括底层的函数和识别的标记类型的列表。

列出文本搜索模板。如果声明了pattern， 则只显示名字匹配该模式的模板。如果使用了\dFt+格式， 则显示关于每个模板的额外的信息，包括底层的函数名。

列出数据库角色。（因为"用户"和"组"的概念已经统一成"角色"， 所以这个命令现在等于\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修饰符包含系统对象。

列出数据库角色。（因为"用户"和"组"的概念已经统一成"角色"， 所以这个命令现在等于\du。）如果声明了 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 或者把输出重定向到一个独立的执行command 的 Unix shell 。文件或命令只在查询成功返回零个或更多元组时写入， 查询失败或者是一个非数据返回的SQL命令时不写入。

单独一个\g实际上等效于一个分号。一个带有参数的 \g是"一次性"的\o命令的代用品。

把当前的查询输入缓冲区发送到服务器并将查询输出存储到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

响应表明此大对象得到一个对象标识 152801 ，可以用来在后面访问新创建的大对象。 出于可读性的目的，建议总是给每个对象关联一个人类可读的注解。 可以用\lo_list命令看到OID和注解。

注意这条命令与服务器端的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。 如果省略则输出到标准输出。这个选项只有在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 将看到全部参数。特别的，变量替换规则和反斜杠逃逸并不适用。

显示关于反斜杠命令的帮助信息。