如果当前的表格输出格式为未对齐，则切换为对齐。如果它不是未对齐的，则将其设置为未对齐。保留此命令是为了向后兼容。有关更通用的解决方案，请参见 \pset。

为下一个查询执行设置查询参数，并将指定的参数传递给任何参数占位符 ($1 等)。

示例

INSERT INTO tbl1 VALUES ($1, $2) \bind 'first value' 'second value' \g

这对于除了 \g 之外的查询执行命令（如 \gx 和 \gset）也有效。

此命令会导致使用扩展查询协议（参见第 53.1.2 节），这与正常的 psql 操作不同，后者使用简单查询协议。因此，此命令可用于测试来自 psql 的扩展查询协议。（即使查询没有参数并且此命令指定零个参数，也会使用扩展查询协议。）此命令仅影响下一个执行的查询；所有后续查询默认使用简单查询协议。

建立与 PostgreSQL 服务器的新连接。可以使用位置语法（数据库名称、用户、主机和端口中的一个或多个）或使用conninfo连接字符串（如第 32.1.1 节中所述）来指定要使用的连接参数。如果未给出任何参数，则使用与之前相同的参数建立新连接。

将dbname、username、host 或 port 中的任何一个指定为 - 等同于省略该参数。

新连接可以重新使用先前连接的连接参数；不仅包括数据库名称、用户、主机和端口，还包括其他设置，如sslmode。默认情况下，在位置语法中会重新使用参数，但在给出conninfo字符串时则不会。传递第一个参数 -reuse-previous=on 或 -reuse-previous=off 会覆盖该默认值。如果重新使用参数，则任何未明确指定为位置参数或在conninfo字符串中指定的参数都将从现有连接的参数中获取。一个例外是，如果使用位置语法将host设置更改为其先前值，则现有连接参数中存在的任何hostaddr设置将被删除。此外，只有在用户、主机和端口设置未更改时，才会重新使用现有连接使用的任何密码。当命令既不指定也不重新使用特定参数时，将使用libpq默认值。

如果成功建立新连接，则将关闭先前连接。如果连接尝试失败（用户名错误、访问被拒绝等），则如果 psql 处于交互模式，则会保留先前连接。但在执行非交互式脚本时，将关闭旧连接并报告错误。这可能会或可能不会终止脚本；如果它没有终止，则所有数据库访问命令都将失败，直到成功执行另一个 \connect 命令。选择这种区别是为了方便用户避免输入错误，另一方面，也是一种安全机制，可以防止脚本意外地作用于错误的数据库。请注意，每当 \connect 命令尝试重新使用参数时，重新使用的值都是最后一次成功连接的值，而不是随后进行的任何失败尝试的值。但是，在非交互式 \connect 失败的情况下，不允许重新使用任何参数，因为脚本可能期望从失败的 \connect 中重新使用值。

示例

=> \c mydb myuser host.dom 6432
=> \c service=foo
=> \c "host=localhost port=5432 dbname=mydb connect_timeout=10 sslmode=disable"
=> \c -reuse-previous=on sslmode=require    -- changes only sslmode
=> \c postgresql://tom@localhost/mydb?application_name=myapp

设置任何作为查询结果打印的表格的标题，或者取消设置任何此类标题。此命令等效于 \pset title title。（此命令的名称源于“caption”，因为它以前仅用于在HTML表格中设置标题。）

将当前工作目录更改为 directory。如果未给出参数，则更改为当前用户的家目录。

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

执行前端（客户端）复制。这是一种在SQL COPY 命令，但不是服务器读取或写入指定的文件，psql 读取或写入文件，并在服务器和本地文件系统之间路由数据。这意味着文件可访问性和权限是本地用户的权限，而不是服务器的权限，并且不需要任何 SQL 超级用户权限。

当指定了 program 时，command 将由 psql 执行，并且从 command 传入或传出的数据将在服务器和客户端之间路由。同样，执行权限是本地用户的权限，而不是服务器的权限，并且不需要任何 SQL 超级用户权限。

对于 \copy ... from stdin，数据行从发出命令的相同源读取，继续直到读取 \. 或流到达EOF. 此选项对于在 SQL 脚本文件中内联填充表很有用。对于 \copy ... to stdout，输出将发送到与 psql 命令输出相同的位置，并且 COPY count 命令状态不会打印（因为它可能与数据行混淆）。要读取/写入 psql 的标准输入或输出，无论当前命令源或 \o 选项如何，请写入 from pstdin 或 to pstdout。

此命令的语法类似于SQL COPY 命令。除数据源/目标之外的所有选项都与 COPY 中指定的选项相同。因此，\copy 元命令适用特殊解析规则。与大多数其他元命令不同，行的整个剩余部分始终被视为 \copy 的参数，并且在参数中不执行变量插值或反引号扩展。

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

执行当前查询缓冲区（如 \g），并在交叉表网格中显示结果。查询必须返回至少三列。由 colV 标识的输出列成为垂直标题，由 colH 标识的输出列成为水平标题。 colD 标识要在网格中显示的输出列。 sortcolH 标识水平标题的可选排序列。

每个列规范可以是列号（从 1 开始）或列名。通常的 SQL 大小写折叠和引用规则适用于列名。如果省略，则 colV 被视为列 1，colH 被视为列 2。 colH 必须与 colV 不同。如果未指定 colD，则查询结果中必须正好有三列，并且既不是 colV 也不是 colH 的列被认为是 colD。

垂直标题显示为最左侧的列，包含在列 colV 中找到的值，与查询结果中的顺序相同，但去除了重复项。

水平标题显示为第一行，包含在列 colH 中找到的值，并去除了重复项。默认情况下，这些值按与查询结果相同的顺序出现。但如果给出了可选的 sortcolH 参数，它将标识一列，其值必须是整数，并且来自 colH 的值将根据相应的 sortcolH 值按顺序出现在水平标题中。

在交叉表网格内，对于 colH 的每个不同值 x 和 colV 的每个不同值 y，位于交叉点 (x,y) 的单元格包含查询结果行中 colD 列的值，其中 colH 的值为 x，colV 的值为 y。如果没有这样的行，则单元格为空。如果有多个这样的行，则会报告错误。

对于每个与 pattern 匹配的关系（表、视图、物化视图、索引、序列或外部表）或复合类型，显示所有列、类型、表空间（如果不是默认表空间）以及任何特殊属性，例如 NOT NULL 或默认值。还显示关联的索引、约束、规则和触发器。对于外部表，还将显示关联的外部服务器。（“匹配模式” 在下面 Patterns 中定义。）

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

命令形式 \d+ 与之相同，只是显示了更多信息：显示与表列关联的任何注释，以及表中是否存在 OID，如果关系是视图，则显示视图定义，显示非默认的 副本标识 设置，以及如果关系具有访问方法，则显示 访问方法 名称。

默认情况下，只显示用户创建的对象；提供模式或 S 修饰符以包含系统对象。

列出聚合函数，以及它们的返回类型和它们操作的数据类型。如果指定了 pattern，则只显示名称与模式匹配的聚合。默认情况下，只显示用户创建的对象；提供模式或 S 修饰符以包含系统对象。

列出访问方法。如果指定了 pattern，则只显示名称与模式匹配的访问方法。如果将 + 附加到命令名称，则每个访问方法都将与其关联的处理程序函数和描述一起列出。

列出操作符类（参见 Section 36.16.1）。如果指定了 access-method-pattern，则只列出与名称与该模式匹配的访问方法关联的操作符类。如果指定了 input-type-pattern，则只列出与名称与该模式匹配的输入类型关联的操作符类。如果将 + 附加到命令名称，则每个操作符类都将与其关联的操作符族和所有者一起列出。

列出操作符族（参见 Section 36.16.5）。如果指定了 access-method-pattern，则只列出与名称与该模式匹配的访问方法关联的操作符族。如果指定了 input-type-pattern，则只列出与名称与该模式匹配的输入类型关联的操作符族。如果将 + 附加到命令名称，则每个操作符族都将与其所有者一起列出。

列出与操作符族关联的操作符（参见 Section 36.16.2）。如果指定了 access-method-pattern，则只列出与名称与该模式匹配的访问方法关联的操作符族的成员。如果指定了 operator-family-pattern，则只列出名称与该模式匹配的操作符族的成员。如果将 + 附加到命令名称，则每个操作符都将与其排序操作符族一起列出（如果它是排序操作符）。

列出与操作符族关联的支持函数（参见 Section 36.16.3）。如果指定了 access-method-pattern，则只列出与名称与该模式匹配的访问方法关联的操作符族的函数。如果指定了 operator-family-pattern，则只列出名称与该模式匹配的操作符族的函数。如果将 + 附加到命令名称，则函数将以详细方式显示，并带有其实际参数列表。

列出表空间。如果指定了 pattern，则仅显示名称与模式匹配的表空间。如果在命令名称后追加 +，则每个表空间将与其关联的选项、磁盘上的大小、权限和描述一起列出。

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

列出服务器配置参数及其值。如果指定了 pattern，则仅列出名称与模式匹配的参数。如果没有 pattern，则仅列出设置为非默认值的参数。（使用 \dconfig * 查看所有参数。）如果在命令名称后追加 +，则每个参数将与其数据类型、设置参数的上下文以及访问权限一起列出（如果已授予非默认访问权限）。

列出类型转换。如果指定了 pattern，则仅列出其源类型或目标类型与模式匹配的转换。如果在命令名称后追加 +，则每个对象将与其关联的描述一起列出。

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

\dd 显示与 pattern 匹配的对象的描述，或者如果未给出参数，则显示可见对象的相应类型的描述。但在任何情况下，仅列出具有描述的对象。默认情况下，仅显示用户创建的对象；提供模式或 S 修饰符以包括系统对象。

可以使用 COMMENTSQL命令创建对象的描述。

列出域。如果指定了 pattern，则仅显示名称与模式匹配的域。默认情况下，仅显示用户创建的对象；提供模式或 S 修饰符以包括系统对象。如果在命令名称后追加 +，则每个对象将与其关联的权限和描述一起列出。

列出默认访问权限设置。对于每个已更改其默认权限设置的角色（如果适用，还包括模式），将显示一个条目。如果指定了 pattern，则仅列出角色名或模式名与模式匹配的条目。

ALTER DEFAULT PRIVILEGES 命令用于设置默认访问权限。权限显示的含义在 第 5.8 节 中解释。

在此命令组中，字母 E、i、m、s、t 和 v 分别代表外部表、索引、物化视图、序列、表和视图。您可以按任何顺序指定这些字母中的任何一个或全部，以获取这些类型对象的列表。例如，\dti 列出表和索引。如果在命令名称后追加 +，则每个对象将与其持久性状态（永久、临时或非日志）、磁盘上的物理大小以及关联的描述（如果有）一起列出。如果指定了 pattern，则仅列出名称与模式匹配的对象。默认情况下，仅显示用户创建的对象；提供模式或 S 修饰符以包括系统对象。

列出外部服务器（助记符：“外部服务器”）。如果指定了 pattern，则仅列出名称与模式匹配的服务器。如果使用 \des+ 形式，则会显示每个服务器的完整描述，包括服务器的访问权限、类型、版本、选项和描述。

列出外部表（助记符：“外部表”）。如果指定了 pattern，则仅列出表名或模式名与模式匹配的条目。如果使用 \det+ 形式，则还会显示通用选项和外部表描述。

列出用户映射（助记符：“外部用户”）。如果指定了 pattern，则仅列出用户名与模式匹配的映射。如果使用 \deu+ 形式，则会显示有关每个映射的其他信息。

列出外部数据包装器（助记符：“外部包装器”）。如果指定了 pattern，则仅列出名称与模式匹配的外部数据包装器。如果使用 \dew+ 形式，则还会显示外部数据包装器的访问权限、选项和描述。

列出函数，以及它们的返回值类型、参数数据类型和函数类型，这些函数被分类为 “agg”（聚合）、“normal”、“procedure”、“trigger” 或 “window”。要仅显示特定类型函数，请在命令中添加相应的字母 a、n、p、t 或 w。如果指定了 pattern，则仅显示名称与模式匹配的函数。任何其他参数都是类型名称模式，它们与函数的第一个、第二个等参数的类型名称匹配。（匹配函数可以拥有比您指定的更多的参数。要防止这种情况，请将破折号 - 作为最后一个 arg_pattern。）默认情况下，仅显示用户创建的对象；提供模式或 S 修饰符以包括系统对象。如果使用 \df+ 形式，则会显示有关每个函数的其他信息，包括易变性、并行安全、所有者、安全分类、访问权限、语言、内部名称（仅限 C 和内部函数）以及描述。可以使用 \sf 查看特定函数的源代码。

列出文本搜索配置。如果指定了 pattern，则仅显示名称与模式匹配的配置。如果使用 \dF+ 形式，则会显示每个配置的完整描述，包括基础文本搜索解析器和每个解析器标记类型的字典列表。

列出文本搜索字典。如果指定了 pattern，则仅显示名称与模式匹配的字典。如果使用 \dFd+ 形式，则会显示有关每个选定字典的其他信息，包括基础文本搜索模板和选项值。

列出文本搜索解析器。如果指定了 pattern，则仅显示名称与模式匹配的解析器。如果使用 \dFp+ 形式，则会显示每个解析器的完整描述，包括基础函数和识别的标记类型列表。

列出文本搜索模板。如果指定了 pattern，则仅显示名称与模式匹配的模板。如果使用 \dFt+ 形式，则会显示有关每个模板的其他信息，包括基础函数名称。

列出数据库角色。（由于“用户”和“组”的概念已统一为“角色”，因此此命令现在等同于\du。）默认情况下，仅显示用户创建的角色；提供S修饰符以包括系统角色。如果指定了pattern，则仅列出其名称与模式匹配的角色。如果使用\dg+形式，则会显示有关每个角色的附加信息；目前，这会为每个角色添加注释。

这是\lo_list的别名，它显示大型对象列表。如果在命令名称后附加+，则每个大型对象将与其关联的权限（如果有）一起列出。

列出过程语言。如果指定了pattern，则仅列出其名称与模式匹配的语言。默认情况下，仅显示用户创建的语言；提供S修饰符以包括系统对象。如果在命令名称后附加+，则会将每种语言与其调用处理程序、验证程序、访问权限以及它是否是系统对象一起列出。

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

列出运算符及其操作数和结果类型。如果指定了pattern，则仅列出其名称与模式匹配的运算符。如果指定了一个arg_pattern，则仅列出其右操作数的类型名称与该模式匹配的前缀运算符。如果指定了两个arg_pattern，则仅列出其操作数类型名称与这些模式匹配的二元运算符。（或者，为一元运算符的未使用操作数写-。）默认情况下，仅显示用户创建的对象；提供模式或S修饰符以包括系统对象。如果在命令名称后附加+，则会显示有关每个运算符的附加信息，目前仅显示底层函数的名称。

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

列出表、视图和序列及其关联的访问权限。如果指定了pattern，则仅列出其名称与模式匹配的表、视图和序列。默认情况下，仅显示用户创建的对象；提供模式或S修饰符以包括系统对象。

The GRANT and REVOKE commands are used to set access privileges. The meaning of the privilege display is explained in Section 5.8.

列出分区关系。如果指定了pattern，则仅列出其名称与模式匹配的条目。修饰符t（表）和i（索引）可以附加到命令，以过滤要列出的关系类型。默认情况下，将列出分区表和索引。

如果使用修饰符n（“嵌套”），或指定模式，则将包括非根分区关系，并且将显示一列，显示每个分区关系的父级。

如果在命令名称后附加+，还会显示每个关系的分区大小之和，以及关系的描述。如果n与+结合使用，则会显示两个大小：一个包括直接附加的叶分区的总大小，另一个显示所有分区的总大小，包括间接附加的子分区。

列出定义的配置设置。这些设置可以是特定于角色的、特定于数据库的，或者两者都是。role-pattern和database-pattern分别用于选择要列出的特定角色和数据库。如果省略，或如果指定了*，则将列出所有设置，包括那些不是特定于角色或特定于数据库的设置。

The ALTER ROLE and ALTER DATABASE commands are used to define per-role and per-database configuration settings.

列出有关每个已授予的角色成员资格的信息，包括分配的选项（ADMIN、INHERIT和/或SET）和授予者。有关角色成员资格的信息，请参见GRANT命令。

默认情况下，仅显示对用户创建角色的授予；提供S修饰符以包括系统角色。如果指定了pattern，则仅显示对其名称与模式匹配的角色的授予。

列出复制出版物。如果指定了pattern，则仅列出其名称与模式匹配的出版物。如果在命令名称后附加+，则还会显示与每个出版物关联的表和模式。

列出复制订阅。如果指定了pattern，则仅列出其名称与模式匹配的订阅。如果在命令名称后附加+，则会显示订阅的其他属性。

列出数据类型。如果指定了pattern，则仅列出其名称与模式匹配的类型。如果在命令名称后附加+，则会将每个类型与其内部名称和大小、其允许值（如果它是enum类型）及其关联的权限一起列出。默认情况下，仅显示用户创建的对象；提供模式或S修饰符以包括系统对象。

列出数据库角色。（由于“用户”和“组”的概念已统一为“角色”，因此此命令现在等同于\dg。）默认情况下，仅显示用户创建的角色；提供S修饰符以包括系统角色。如果指定了pattern，则仅列出其名称与模式匹配的角色。如果使用\du+形式，则会显示有关每个角色的附加信息；目前，这会为每个角色添加注释。

列出已安装的扩展。如果指定了pattern，则仅列出其名称与模式匹配的扩展。如果使用\dx+形式，则会列出每个匹配扩展的所有对象。

列出扩展统计信息。如果指定了pattern，则仅列出其名称与模式匹配的扩展统计信息。

每种扩展统计信息的状态将在以其统计信息类型命名的列中显示（例如 Ndistinct）。defined 表示在创建统计信息时已请求它，而 NULL 表示没有请求它。如果想了解是否运行了 ANALYZE 以及计划程序是否可以使用统计信息，可以使用 pg_stats_ext。

列出事件触发器。如果指定了pattern，则仅列出其名称与模式匹配的事件触发器。如果在命令名称后附加+，则会将每个对象与其关联的描述一起列出。

如果指定了 filename，则编辑该文件；编辑器退出后，文件的内容将复制到当前查询缓冲区。如果没有给出 filename，则将当前查询缓冲区复制到一个临时文件，然后以相同的方式对其进行编辑。或者，如果当前查询缓冲区为空，则将最近执行的查询复制到一个临时文件，并以相同的方式进行编辑。

如果您编辑了文件或上一个查询，并在未修改文件的情况下退出编辑器，则查询缓冲区将被清除。否则，查询缓冲区的新内容将根据 psql 的正常规则重新解析，将整个缓冲区视为一行。任何完整的查询都会立即执行；也就是说，如果查询缓冲区包含或以分号结尾，则直到该点的所有内容都会被执行并从查询缓冲区中删除。查询缓冲区中剩下的内容将被重新显示。键入分号或 \g 发送它，或 \r 通过清除查询缓冲区来取消它。

将缓冲区视为单行主要影响元命令：元命令之后的缓冲区中的任何内容都将被视为元命令的参数，即使它跨越多行。（因此，您不能以这种方式创建使用元命令的脚本。为此请使用 \i。）

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

将计算后的参数打印到标准输出，用空格隔开，并在最后加上换行符。这对于在脚本输出中插入信息很有用。例如

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

如果第一个参数是未引用的 -n，则不会写入尾随换行符（第一个参数也不会写入）。

此命令获取并编辑命名函数或过程的定义，形式为 CREATE OR REPLACE FUNCTION 或 CREATE OR REPLACE PROCEDURE 命令。编辑方式与 \edit 相同。如果您在未保存的情况下退出编辑器，则该语句将被丢弃。如果您保存并退出编辑器，并且您在其中添加了分号，则更新后的命令将立即执行。否则，它将被重新显示；键入分号或 \g 发送它，或 \r 取消它。

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

如果没有指定函数，将显示一个空白的 CREATE FUNCTION 模板供编辑。

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

与大多数其他元命令不同，该行的其余部分始终被视为 \ef 的参数，并且在参数中不会执行变量插值或反引号展开。

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

以最大详细程度重复最近的服务器错误消息，就像 VERBOSITY 被设置为 verbose 并且 SHOW_CONTEXT 被设置为 always 一样。

此命令获取并编辑命名视图的定义，形式为 CREATE OR REPLACE VIEW 命令。编辑方式与 \edit 相同。如果您在未保存的情况下退出编辑器，则该语句将被丢弃。如果您保存并退出编辑器，并且您在其中添加了分号，则更新后的命令将立即执行。否则，它将被重新显示；键入分号或 \g 发送它，或 \r 取消它。

如果没有指定视图，将显示一个空白的 CREATE VIEW 模板供编辑。

如果指定了行号，psql 将把光标定位在视图定义的指定行上。

与大多数其他元命令不同，该行的其余部分始终被视为 \ev 的参数，并且在参数中不会执行变量插值或反引号展开。

设置未对齐查询输出的字段分隔符。默认值为竖线 (|)。它等效于 \pset fieldsep。

将当前查询缓冲区发送到服务器以执行。

如果在 \g 之后出现括号，它们将包围一个空格分隔的 option=value 格式化选项子句列表，这些子句的解释方式与 \pset option value 命令相同，但仅在此查询期间生效。在此列表中，在 = 符号周围不允许使用空格，但在选项子句之间需要使用空格。如果省略 =value，则命名 option 的更改方式与 \pset option 类似，没有显式的 value。

如果给出了 filename 或 |command 参数，则查询的输出将写入命名文件或通过管道传递给给定的 shell 命令，而不是像往常一样显示它。只有在查询成功返回零个或多个元组时才会写入文件或命令，如果查询失败或是非数据返回的 SQL 命令，则不会写入。

如果当前查询缓冲区为空，则将重新执行最近发送的查询。除了这种行为之外，没有参数的 \g 本质上等效于分号。带有参数的 \g 为 “一次性” 提供了 \o 命令的替代方案，此外还允许对由 \pset 通常设置的输出格式选项进行一次性调整。

当最后一个参数以 | 开头时，该行的剩余部分将被视为要执行的 command，并且在其中不会执行变量插值或反引号展开。该行的剩余部分将被简单地按字面传递给 shell。

显示当前查询缓冲区结果的描述（即，列名和数据类型）。查询不会实际执行；但是，如果它包含某种类型的语法错误，则会以正常方式报告该错误。

如果当前查询缓冲区为空，则将描述最近发送的查询。

获取环境变量 env_var 的值，并将其分配给 psql 变量 psql_var。如果 env_var 在 psql 进程的环境中未定义，则 psql_var 不会更改。例如

=> \getenv home HOME
=> \echo :home
/home/postgres

将当前查询缓冲区发送到服务器，然后将查询输出的每一行的每一列（如果有）都视为要执行的 SQL 语句。例如，要为 my_table 的每一列创建索引

=> SELECT format('create index on my_table(%I)', attname)
-> FROM pg_attribute
-> WHERE attrelid = 'my_table'::regclass AND attnum > 0
-> ORDER BY attnum
-> \gexec
CREATE INDEX
CREATE INDEX
CREATE INDEX
CREATE INDEX

生成的查询按返回行的顺序执行，如果有多列，则在每行内从左到右执行。忽略 NULL 字段。生成的查询将按字面发送到服务器进行处理，因此它们不能是 psql 元命令，也不能包含 psql 变量引用。如果任何单个查询失败，则除非设置了 ON_ERROR_STOP，否则将继续执行剩余的查询。每个查询的执行都受 ECHO 处理的约束。（在使用 \gexec 时，通常建议将 ECHO 设置为 all 或 queries。）查询记录、单步模式、计时和其他查询执行功能也适用于每个生成的查询。

如果当前查询缓冲区为空，则将重新执行最近发送的查询。

将当前查询缓冲区发送到服务器，并将查询的输出存储到 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，则对应的变量将被取消设置，而不是被设置。

如果查询失败或没有返回一行，则不会更改任何变量。

如果当前查询缓冲区为空，则将重新执行最近发送的查询。

\gx 等效于 \g，区别在于它强制在此查询中使用扩展输出模式，就像 expanded=on 包含在 \pset 选项列表中一样。另请参阅 \x。

提供关于指定SQL命令的语法帮助。如果没有指定 command，则 psql 将列出所有可以使用语法帮助的命令。如果 command 是星号 (*)，则将显示所有SQL命令的语法帮助。

与大多数其他元命令不同，整行剩余部分始终被视为\help的参数，并且在参数中不执行变量插值或反引号扩展。

启用HTML查询输出格式。如果HTML格式已经启用，它将切换回默认的对齐文本格式。此命令是为了兼容性和便利性，但有关设置其他输出选项，请参阅\pset。

从文件filename读取输入，并将其作为从键盘上输入的内容执行。

如果filename是-（连字符），则从标准输入读取，直到遇到 EOF 指示或\q元命令。这可用于将交互式输入与来自文件中的输入穿插起来。请注意，只有在最外层级别处于活动状态时，才会使用 Readline 行为。

此命令组实现了可嵌套的条件块。条件块必须以\if开头，并以\endif结尾。在它们之间，可以包含任意数量的\elif子句，这些子句可以选择性地后跟单个\else子句。普通查询和其他类型的反斜杠命令可以（通常也会）出现在构成条件块的命令之间。

\if和\elif命令读取它们的 arguments(s)，并将其作为布尔表达式进行评估。如果表达式结果为true，则处理继续正常进行；否则，将跳过行，直到遇到匹配的\elif、\else或\endif。一旦\if或\elif测试成功，则同一个块中后面的\elif命令的参数不会被评估，而是被视为假。只有在前面的匹配\if或\elif没有成功的情况下，才会处理\else后面的行。

\if或\elif命令的expression参数会受到变量插值和反引号扩展的影响，就像任何其他反斜杠命令参数一样。之后，它将像开/关选项变量的值一样进行评估。因此，有效值为任何与以下内容之一无歧义地匹配的无大小写匹配：true、false、1、0、on、off、yes、no。例如，t、T和tR都将被视为true。

不能正确评估为真或假的表达式将生成警告，并被视为假。

被跳过的行将被正常解析以识别查询和反斜杠命令，但查询不会发送到服务器，并且除条件命令（\if、\elif、\else、\endif）之外的反斜杠命令将被忽略。条件命令只检查有效嵌套。跳过行中的变量引用不会被扩展，反引号扩展也不会执行。

给定条件块中的所有反斜杠命令都必须出现在同一个源文件中。如果在所有本地\if块关闭之前，在主输入文件或\include的文件中遇到 EOF，那么psql将引发错误。

以下是一个示例

-- check for the existence of two separate records in the database and store
-- the results in separate psql variables
SELECT
    EXISTS(SELECT 1 FROM customer WHERE customer_id = 123) as is_customer,
    EXISTS(SELECT 1 FROM employee WHERE employee_id = 456) as is_employee
\gset
\if :is_customer
    SELECT * FROM customer WHERE customer_id = 123;
\elif :is_employee
    \echo 'is not a customer but is an employee'
    SELECT * FROM employee WHERE employee_id = 456;
\else
    \if yes
        \echo 'not a customer or employee'
    \else
        \echo 'this will never print'
    \endif
\endif

\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，该 ID 可用于将来访问新创建的大型对象。为了提高可读性，建议始终将人类可读的注释与每个对象关联。可以使用\lo_list命令查看 OID 和注释。

请注意，此命令与服务器端lo_import略有不同，因为它以本地用户身份在本地文件系统上执行操作，而不是以服务器用户身份在服务器文件系统上执行操作。

显示当前存储在数据库中的所有 PostgreSQL 大型对象的列表，以及为它们提供的任何注释。如果在命令名称后面附加+，则每个大型对象都将与其关联的权限（如果有）一起列出。

删除具有OID loid的数据库中的大型对象。

安排将未来的查询结果保存到文件filename或将未来的结果管道到 shell 命令command。如果没有指定参数，则查询输出将重置为标准输出。

如果参数以|开头，则整行剩余部分被视为要执行的command，并且不会在其中执行变量插值或反引号扩展。剩余部分将直接传递给 shell。

“查询结果”包括从数据库服务器获取的所有表、命令响应和通知，以及查询数据库的各种反斜杠命令（如\d）的输出；但不包括错误消息。

将当前查询缓冲区打印到标准输出。如果当前查询缓冲区为空，则改为打印最近执行的查询。

更改指定用户的密码（默认情况下，是当前用户）。此命令会提示输入新密码，对其进行加密，并将其作为ALTER ROLE命令发送到服务器。这确保新密码不会以明文形式出现在命令历史记录、服务器日志或其他地方。

提示用户提供文本，该文本将分配给变量name。可以指定可选的提示字符串text。（对于多词提示，请将文本用单引号括起来。）

默认情况下，\prompt使用终端进行输入和输出。但是，如果使用了-f命令行开关，\prompt将使用标准输入和标准输出。

此命令设置影响查询结果表输出的选项。option指示要设置哪个选项。value的语义根据选择的选项而有所不同。对于某些选项，省略value会导致选项被切换或取消设置，如特定选项下所述。如果没有提到这种行为，那么省略value只会导致显示当前设置。

没有任何参数的\pset将显示所有打印选项的当前状态。

可调整的打印选项是

这些不同格式的外观示例可以在下面的 示例 中看到。

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

此命令与 \echo 相同，只是输出将被写入查询输出通道，如 \o 所设置。

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

将 psql 的命令行历史记录打印到 filename。如果省略 filename，则历史记录将被写入标准输出（如果适用，则使用分页程序）。如果 psql 在没有 Readline 支持的情况下构建，则此命令不可用。

将 psql 变量 name 设置为 value，或者如果给出了多个值，则设置为所有值的串联。如果只给出一个参数，则变量被设置为一个空字符串值。要取消设置变量，请使用 \unset 命令。

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

有效的变量名可以包含字母、数字和下划线。有关详细信息，请参见下面的 变量。变量名区分大小写。

某些变量是特殊的，因为它们控制 psql 的行为或自动设置为反映连接状态。这些变量在下面 变量 中有说明。

将环境变量 name 设置为 value，或者如果未提供 value，则取消设置环境变量。例如

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

此命令获取并显示命名函数或过程的定义，以 CREATE OR REPLACE FUNCTION 或 CREATE OR REPLACE PROCEDURE 命令的形式。定义将被打印到当前的查询输出通道，如 \o 所设置。

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

如果在命令名称后面附加 +，则输出行将被编号，函数体的第一行将为第 1 行。

与大多数其他元命令不同，该行的所有剩余部分始终被视为 \sf 的参数，并且在参数中不执行变量插值或反引号扩展。

此命令获取并显示命名视图的定义，以 CREATE OR REPLACE VIEW 命令的形式。定义将被打印到当前的查询输出通道，如 \o 所设置。

如果在命令名称后面附加 +，则输出行将从 1 开始编号。

与大多数其他元命令不同，该行的所有剩余部分始终被视为 \sv 的参数，并且在参数中不执行变量插值或反引号扩展。

切换输出列名称标题和行计数页脚的显示。此命令等效于 \pset tuples_only，为了方便提供。

指定要放在 table 标签中的属性HTML输出格式。此命令等效于 \pset tableattr table_options。

使用参数，打开或关闭显示每个 SQL 语句需要多长时间。不带参数，在打开和关闭之间切换显示。显示以毫秒为单位；超过 1 秒的间隔也以分钟：秒的格式显示，并在需要时添加小时和天数字段。

取消设置（删除）psql 变量 name。

大多数控制 psql 行为的变量无法取消设置；相反，\unset 命令被解释为将它们设置为默认值。请参见下面的 变量。

将当前查询缓冲区写入文件 filename 或将其管道传输到 shell 命令 command。如果当前查询缓冲区为空，则写入最近执行的查询。

如果参数以|开头，则整行剩余部分被视为要执行的command，并且不会在其中执行变量插值或反引号扩展。剩余部分将直接传递给 shell。

此命令与 \echo 相同，只是输出将被写入 psql 的标准错误通道，而不是标准输出。

反复执行当前查询缓冲区（如 \g 所做的那样），直到中断，或查询失败，或达到执行计数限制（如果给出），或查询不再返回最少数量的行。在每次执行之间等待指定秒数（默认值为 2）。为了向后兼容，seconds 可以带有或不带有 interval= 前缀指定。每个查询结果都显示一个标题，其中包含 \pset title 字符串（如果有），查询开始的时间以及延迟间隔。

如果当前查询缓冲区为空，则将重新执行最近发送的查询。

设置或切换扩展表格格式模式。因此，它等效于 \pset expanded。

列出表、视图和序列及其关联的访问权限。如果指定了 pattern，则仅列出名称与模式匹配的表、视图和序列。默认情况下，只显示用户创建的对象；提供模式或 S 修饰符以包含系统对象。

这是 \dp（“显示权限”）的别名。

不带参数，转义到子 shell；psql 在子 shell 退出时恢复。带参数，执行 shell 命令 command。

与大多数其他元命令不同，该行的所有剩余部分始终被视为 \! 的参数，并且在参数中不执行变量插值或反引号扩展。该行的其余部分只是简单地按字面意思传递给 shell。

显示帮助信息。可选的 topic 参数（默认为 commands）选择解释 psql 的哪一部分：commands 描述 psql 的反斜杠命令；options 描述可以传递给 psql 的命令行选项；variables 显示有关 psql 配置变量的帮助。

反斜杠分号不是与前面的命令相同的元命令；相反，它只是简单地在查询缓冲区中添加一个分号，而不进行任何进一步的处理。

通常，psql 将在到达命令结束的分号时立即将 SQL 命令分派到服务器，即使当前行上有更多输入。因此，例如输入

select 1; select 2; select 3;

将导致三个 SQL 命令被单独发送到服务器，每个命令的结果将在继续执行下一个命令之前显示。但是，作为 \; 输入的分号不会触发命令处理，因此它之前的命令和之后的命令实际上会组合在一起，并作为单个请求发送到服务器。所以例如

select 1\; select 2\; select 3;

当遇到非反斜杠分号时，会将三个 SQL 命令作为单个请求发送到服务器。服务器将此类请求作为单个事务执行，除非字符串中包含显式的 BEGIN/COMMIT 命令将其划分为多个事务。（有关服务器如何处理多查询字符串的更多详细信息，请参阅 第 53.2.2.1 节。）