current_setting ( setting_name text [, missing_ok boolean ] ) → text

返回设置 setting_name 的当前值。如果不存在此设置，则 current_setting 会抛出错误，除非提供 missing_ok 并且为 true（在这种情况下将返回 NULL）。此函数对应于SQL命令 SHOW.

current_setting('datestyle') → ISO, MDY

set_config ( setting_name text, new_value text, is_local boolean ) → text

将参数 setting_name 设置为 new_value，并返回该值。如果 is_local 为 true，则新值仅在当前事务中生效。如果希望新值在当前会话的剩余时间内生效，则使用 false。此函数对应于 SQL 命令 SET.

set_config('log_statement_stats', 'off', false) → off

pg_cancel_backend ( pid integer ) → boolean

取消后端进程具有指定进程 ID 的会话的当前查询。如果调用角色是其后端正在被取消的角色的成员或调用角色具有 pg_signal_backend 的权限，这也允许这样做，但是只有超级用户才能取消超级用户后端。

pg_log_backend_memory_contexts ( pid integer ) → boolean

请求记录具有指定进程 ID 的后端的内存上下文。此函数可以向后端和辅助进程（除记录器外）发送请求。这些内存上下文将在 LOG 消息级别记录。它们将根据设置的日志配置出现在服务器日志中（有关更多信息，请参见 第 19.8 节），但无论 client_min_messages 如何，都不会发送给客户端。

pg_reload_conf () → boolean

导致 PostgreSQL 服务器的所有进程重新加载其配置文件。（这是通过向 postmaster 进程发送 SIGHUP 信号来启动的，该信号依次向其每个子进程发送 SIGHUP。）您可以在重新加载之前使用 pg_file_settings、pg_hba_file_rules 和 pg_ident_file_mappings 视图检查配置文件是否有可能的错误。

pg_rotate_logfile () → boolean

向日志文件管理器发出信号，立即切换到新的输出文件。这仅在内置日志收集器正在运行时有效，因为否则没有日志文件管理器子进程。

pg_terminate_backend ( pid integer, timeout bigint DEFAULT 0 ) → boolean

终止后端进程具有指定进程 ID 的会话。如果调用角色是其后端正在被终止的角色的成员或调用角色具有 pg_signal_backend 的权限，这也允许这样做，但是只有超级用户才能终止超级用户后端。

如果 timeout 未指定或为零，则无论该进程是否实际终止，此函数都会返回 true，仅表示发送信号已成功。如果 timeout 指定（以毫秒为单位）且大于零，则该函数将等待直到该进程实际终止或直到给定时间过去。如果进程终止，则该函数返回 true。在超时的情况下，将发出警告并返回 false。

pg_create_restore_point ( name text ) → pg_lsn

在预写式日志中创建一个命名的标记记录，该记录以后可以用作恢复目标，并返回相应的预写式日志位置。然后，可以使用给定的名称与 recovery_target_name 来指定恢复将进行到的点。避免使用相同名称创建多个还原点，因为恢复将在第一个名称与恢复目标匹配的点停止。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_current_wal_flush_lsn () → pg_lsn

返回当前预写日志刷盘位置（见下文说明）。

pg_current_wal_insert_lsn () → pg_lsn

返回当前预写日志写入位置（见下文说明）。

pg_current_wal_lsn () → pg_lsn

返回当前预写日志写入位置（见下文说明）。

pg_backup_start ( label text [, fast boolean ] ) → pg_lsn

准备服务器开始在线备份。唯一需要的参数是用户定义的备份标签（通常是备份转储文件存储的名称）。如果给出可选的第二个参数为 true，则指定以最快的速度执行 pg_backup_start。这将强制立即进行检查点，这会导致 I/O 操作激增，从而减慢任何并发执行的查询。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_backup_stop ( [wait_for_archive boolean ] ) → record ( lsn pg_lsn, labelfile text, spcmapfile text )

完成在线备份。备份标签文件和表空间映射文件所需的内容作为函数结果的一部分返回，必须写入备份区域中的文件。这些文件不能写入活动数据目录（这样做会导致 PostgreSQL 在发生崩溃的情况下无法重新启动）。

有一个可选的 boolean 类型参数。如果为 false，则函数将在备份完成后立即返回，而不会等待 WAL 归档。此行为仅在备份软件独立监控 WAL 归档时才有用。否则，使备份一致所需的 WAL 可能丢失，从而使备份毫无用处。默认情况下或当此参数为 true 时，pg_backup_stop 将在启用归档时等待 WAL 归档。（在备用服务器上，这意味着它只会在 archive_mode = always 时等待。如果主服务器上的写入活动量很低，则运行 pg_switch_wal 在主服务器上以触发立即段切换可能有用。）

在主服务器上执行时，此函数还会在预写日志归档区域中创建一个备份历史记录文件。历史记录文件包括提供给 pg_backup_start 的标签、备份的起始和结束预写日志位置以及备份的起始和结束时间。记录结束位置后，当前预写日志插入点将自动前进到下一个预写日志文件，以便可以立即归档结束的预写日志文件以完成备份。

函数的结果是单个记录。 lsn 列保存备份的结束预写日志位置（可以忽略）。第二列返回备份标签文件的内容，第三列返回表空间映射文件的内容。这些必须存储为备份的一部分，并且是恢复过程的一部分。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_switch_wal () → pg_lsn

强制服务器切换到一个新的预写日志文件，这允许归档当前文件（假设您正在使用持续归档）。结果是刚刚完成的预写日志文件中的结束预写日志位置加 1。如果自上次预写日志切换后没有预写日志活动，则 pg_switch_wal 不会执行任何操作，并返回当前正在使用的预写日志文件的起始位置。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_walfile_name ( lsn pg_lsn ) → text

将预写日志位置转换为保存该位置的 WAL 文件的名称。

pg_walfile_name_offset ( lsn pg_lsn ) → record ( file_name text, file_offset integer )

将预写日志位置转换为 WAL 文件名和该文件中的字节偏移量。

pg_split_walfile_name ( file_name text ) → record ( segment_number numeric, timeline_id bigint )

从 WAL 文件名中提取序列号和时间线 ID。

pg_wal_lsn_diff ( lsn1 pg_lsn, lsn2 pg_lsn ) → numeric

计算两个预写日志位置之间的字节差异（lsn1 - lsn2）。这可以与 pg_stat_replication 或 表 9.95 中显示的一些函数一起使用以获得复制延迟。

pg_is_in_recovery () → boolean

如果恢复仍在进行中，则返回 true。

pg_last_wal_receive_lsn () → pg_lsn

返回通过流式复制接收并同步到磁盘的最后一个预写日志位置。在流式复制正在进行时，这将单调增加。如果恢复已完成，则这将保持在恢复期间接收并同步到磁盘的最后一个 WAL 记录的位置。如果流式复制被禁用，或者尚未开始，则该函数返回 NULL。

pg_last_wal_replay_lsn () → pg_lsn

返回恢复期间重放的最后一个预写日志位置。如果恢复仍在进行中，这将单调增加。如果恢复已完成，则这将保持在恢复期间应用的最后一个 WAL 记录的位置。当服务器在没有恢复的情况下正常启动时，该函数返回 NULL。

pg_last_xact_replay_timestamp () → timestamp with time zone

返回恢复期间重放的最后一个事务的时间戳。这是在主服务器上生成该事务的提交或中止 WAL 记录的时间。如果在恢复期间没有重放任何事务，则该函数返回 NULL。否则，如果恢复仍在进行中，这将单调增加。如果恢复已完成，则这将保持在恢复期间应用的最后一个事务的时间。当服务器在没有恢复的情况下正常启动时，该函数返回 NULL。

pg_get_wal_resource_managers () → setof record ( rm_id integer, rm_name text, rm_builtin boolean )

返回系统中当前加载的 WAL 资源管理器。 rm_builtin 列指示它是否是内置资源管理器，还是由扩展加载的自定义资源管理器。

pg_is_wal_replay_paused () → boolean

如果请求恢复暂停，则返回 true。

pg_get_wal_replay_pause_state () → text

返回恢复暂停状态。返回值为 not paused 如果没有请求暂停，pause requested 如果请求暂停但恢复尚未暂停，以及 paused 如果恢复实际上已暂停。

pg_promote ( wait boolean DEFAULT true, wait_seconds integer DEFAULT 60 ) → boolean

将备用服务器提升为主服务器状态。当 wait 设置为 true（默认值）时，该函数将等待直到提升完成或 wait_seconds 秒过去，如果提升成功则返回 true，否则返回 false。如果 wait 设置为 false，则该函数在向 postmaster 发送 SIGUSR1 信号以触发提升后立即返回 true。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_wal_replay_pause () → void

请求暂停恢复。请求并不意味着恢复会立即停止。如果你想要保证恢复确实暂停，你需要检查由 pg_get_wal_replay_pause_state() 返回的恢复暂停状态。请注意 pg_is_wal_replay_paused() 返回的是是否发出请求。在恢复暂停期间，不会应用任何进一步的数据库更改。如果热备用处于活动状态，所有新的查询都将看到数据库的相同一致快照，并且在恢复恢复之前不会生成任何进一步的查询冲突。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_wal_replay_resume () → void

如果恢复已暂停，则重新启动恢复。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_export_snapshot () → text

保存事务的当前快照并返回一个 text 字符串，该字符串标识快照。该字符串必须传递（在数据库外部）给想要导入快照的客户端。该快照仅在导出它的事务结束之前可用以供导入。

如果需要，事务可以导出多个快照。请注意，这样做只在 READ COMMITTED 事务中才有用，因为在 REPEATABLE READ 和更高隔离级别中，事务在其整个生命周期内使用相同的快照。一旦事务导出任何快照，就无法使用 PREPARE TRANSACTION 对其进行准备。

pg_log_standby_snapshot () → pg_lsn

对正在运行的事务进行快照，并将其写入 WAL，而无需等待 bgwriter 或检查点程序记录快照。这对于备用上的逻辑解码很有用，因为逻辑槽创建必须等到在备用上重放这样的记录。

pg_create_physical_replication_slot ( slot_name name [, immediately_reserve boolean, temporary boolean ] ) → record ( slot_name name, lsn pg_lsn )

创建一个名为 slot_name 的新的物理复制槽。可选的第二个参数，当 true 时，指定该LSN为该复制槽立即保留；否则该LSN在流式复制客户端的首次连接时被保留。物理槽的流式更改只能使用流式复制协议 — 请参阅 第 53.4 节。可选的第三个参数 temporary，当设置为 true 时，指定该槽不应永久存储到磁盘，而只供当前会话使用。临时槽也会在任何错误时被释放。该函数对应于复制协议命令 CREATE_REPLICATION_SLOT ... PHYSICAL。

pg_drop_replication_slot ( slot_name name ) → void

删除名为 slot_name 的物理或逻辑复制槽。与复制协议命令 DROP_REPLICATION_SLOT 相同。对于逻辑槽，这必须在连接到创建槽的相同数据库时调用。

pg_create_logical_replication_slot ( slot_name name, plugin name [, temporary boolean, twophase boolean, failover boolean ] ) → record ( slot_name name, lsn pg_lsn )

使用输出插件 plugin 创建一个名为 slot_name 的新的逻辑（解码）复制槽。可选的第三个参数 temporary，当设置为 true 时，指定该槽不应永久存储到磁盘，而只供当前会话使用。临时槽也会在任何错误时被释放。可选的第四个参数 twophase，当设置为 true 时，指定为该槽启用准备好的事务的解码。可选的第五个参数 failover，当设置为 true 时，指定该槽被启用以同步到备用，以便在故障转移后可以恢复逻辑复制。调用此函数的效果与复制协议命令 CREATE_REPLICATION_SLOT ... LOGICAL 相同。

pg_copy_physical_replication_slot ( src_slot_name name, dst_slot_name name [, temporary boolean ] ) → record ( slot_name name, lsn pg_lsn )

将名为 src_slot_name 的现有物理复制槽复制到名为 dst_slot_name 的物理复制槽。复制的物理槽从与源槽相同的LSN开始保留 WAL。 temporary 是可选的。如果省略了 temporary，则使用与源槽相同的值。

pg_copy_logical_replication_slot ( src_slot_name name, dst_slot_name name [, temporary boolean [, plugin name ]] ) → record ( slot_name name, lsn pg_lsn )

将名为 src_slot_name 的现有逻辑复制槽复制到名为 dst_slot_name 的逻辑复制槽，可以选择更改输出插件和持久性。复制的逻辑槽从与源逻辑槽相同的LSN开始。 temporary 和 plugin 都是可选的；如果省略了它们，则使用源槽的值。

pg_logical_slot_get_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data text )

返回槽 slot_name 中的更改，从上次使用更改的位置开始。如果 upto_lsn 和 upto_nchanges 为 NULL，逻辑解码将一直持续到 WAL 结束。如果 upto_lsn 非 NULL，解码将仅包含在指定 LSN 之前提交的事务。如果 upto_nchanges 非 NULL，解码将在解码产生的行数超过指定值时停止。但是，请注意，返回的实际行数可能更大，因为只有在添加解码每个新事务提交时产生的行之后才会检查此限制。如果指定的槽是逻辑故障转移槽，则该函数将不会返回，直到 synchronized_standby_slots 中指定的

pg_logical_slot_peek_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data text )

与 pg_logical_slot_get_changes() 函数的行为相同，只是更改不会被使用；也就是说，它们将在未来的调用中再次返回。

pg_logical_slot_get_binary_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data bytea )

与 pg_logical_slot_get_changes() 函数的行为相同，只是更改以 bytea 形式返回。

pg_logical_slot_peek_binary_changes ( slot_name name, upto_lsn pg_lsn, upto_nchanges integer, VARIADIC options text[] ) → setof record ( lsn pg_lsn, xid xid, data bytea )

与 pg_logical_slot_peek_changes() 函数的行为相同，只是更改以 bytea 形式返回。

pg_replication_slot_advance ( slot_name name, upto_lsn pg_lsn ) → record ( slot_name name, end_lsn pg_lsn )

将名为 slot_name 的复制槽的当前已确认位置向前推进。槽不会被向后移动，也不会被移动到当前插入位置之外。返回槽的名称以及它被推进到的实际位置。如果进行了任何推进，则更新的槽位置信息将在下次检查点写入。因此，在发生崩溃的情况下，槽可能会返回到较早的位置。如果指定的槽是逻辑故障转移槽，则该函数将不会返回，直到在 synchronized_standby_slots 中指定的物理槽都已确认收到 WAL。

pg_replication_origin_create ( node_name text ) → oid

创建具有给定外部名称的复制源，并返回分配给它的内部 ID。

pg_replication_origin_drop ( node_name text ) → void

删除以前创建的复制源，包括任何相关的重放进度。

pg_replication_origin_oid ( node_name text ) → oid

按名称查找复制源并返回内部 ID。如果未找到此类复制源，则返回 NULL。

pg_replication_origin_session_setup ( node_name text ) → void

将当前会话标记为从给定源重放，允许跟踪重放进度。只能在当前未选择源的情况下使用。使用 pg_replication_origin_session_reset 撤消。

pg_replication_origin_session_reset () → void

取消 pg_replication_origin_session_setup() 的效果。

pg_replication_origin_session_is_setup () → boolean

如果在当前会话中选择了复制源，则返回 true。

pg_replication_origin_session_progress ( flush boolean ) → pg_lsn

返回当前会话中选择的复制源的重放位置。参数 flush 决定相应的本地事务是否保证已刷新到磁盘。

pg_replication_origin_xact_setup ( origin_lsn pg_lsn, origin_timestamp timestamp with time zone ) → void

将当前事务标记为重放已在给定LSN和时间戳提交的事务。只能在使用 pg_replication_origin_session_setup 选择复制源时调用。

pg_replication_origin_xact_reset () → void

取消 pg_replication_origin_xact_setup() 的效果。

pg_replication_origin_advance ( node_name text, lsn pg_lsn ) → void

将给定节点的复制进度设置为给定位置。这主要用于设置初始位置，或在配置更改和类似情况下设置新位置。请注意，不小心使用此函数会导致数据复制不一致。

pg_replication_origin_progress ( node_name text, flush boolean ) → pg_lsn

返回给定复制源的重放位置。参数 flush 决定相应的本地事务是否保证已刷新到磁盘。

pg_logical_emit_message ( transactional boolean, prefix text, content text [, flush boolean DEFAULT false] ) → pg_lsn

pg_logical_emit_message ( transactional boolean, prefix text, content bytea [, flush boolean DEFAULT false] ) → pg_lsn

发出逻辑解码消息。这可用于通过 WAL 将通用消息传递给逻辑解码插件。参数 transactional 指定消息是否应成为当前事务的一部分，或者是否应立即写入并在逻辑解码器读取记录时立即解码。参数 prefix 是一个文本前缀，逻辑解码插件可以使用它轻松识别对它们有意义的消息。参数 content 是消息的内容，以文本或二进制形式给出。参数 flush（默认设置为 false）控制消息是否立即刷新到 WAL。 flush 对 transactional 没有影响，因为消息的 WAL 记录与其事务一起刷新。

pg_sync_replication_slots () → void

将逻辑故障转移复制槽从主服务器同步到备用服务器。此函数只能在备用服务器上执行。临时同步的槽（如果有）不能用于逻辑解码，必须在提升后删除。有关详细信息，请参见 第 47.2.3 节。请注意，如果启用了 sync_replication_slots 并且槽同步工作程序已在运行以执行槽的同步，则无法执行此函数。

pg_column_size ( "any" ) → integer

显示用于存储任何单个数据值的字节数。如果直接应用于表列值，则反映了所做的任何压缩。

pg_column_compression ( "any" ) → text

显示用于压缩单个可变长度值的压缩算法。如果值未压缩，则返回 NULL。

pg_column_toast_chunk_id ( "any" ) → oid

显示磁盘上的 chunk_idTOASTed 值。如果值未TOASTed 或不在磁盘上，则返回 NULL。有关的更多信息，请参见 第 65.2 节TOAST.

pg_database_size ( name ) → bigint

pg_database_size ( oid ) → bigint

计算指定名称或 OID 的数据库使用的总磁盘空间。要使用此函数，您必须对指定数据库具有 CONNECT 权限（默认情况下授予），或者具有 pg_read_all_stats 角色的权限。

pg_indexes_size ( regclass ) → bigint

计算附加到指定表的索引使用的总磁盘空间。

pg_relation_size ( relation regclass [, fork text ] ) → bigint

计算指定关系的一个 “fork” 使用的磁盘空间。（请注意，对于大多数目的，使用更高级别的函数 pg_total_relation_size 或 pg_table_size 更方便，它们会将所有 fork 的大小加起来。）使用一个参数时，这将返回关系的主数据 fork 的大小。可以提供第二个参数来指定要检查的 fork。

pg_size_bytes ( text ) → bigint

将人类可读格式（如 pg_size_pretty 返回的）中的大小转换为字节。有效单位为 bytes、B、kB、MB、GB、TB 和 PB。

pg_size_pretty ( bigint ) → text

pg_size_pretty ( numeric ) → text

将以字节为单位的大小转换为更易于人类阅读的格式，并使用大小单位（字节、kB、MB、GB、TB 或 PB，具体取决于情况）。请注意，这些单位是 2 的幂而不是 10 的幂，因此 1kB 是 1024 字节，1MB 是 1024² = 1048576 字节，依此类推。

pg_table_size ( regclass ) → bigint

计算指定表使用的磁盘空间，不包括索引（但包括其 TOAST 表（如果有）、自由空间映射和可见性映射）。

pg_tablespace_size ( name ) → bigint

pg_tablespace_size ( oid ) → bigint

计算指定名称或 OID 的表空间中使用的总磁盘空间。要使用此函数，您必须对指定表空间具有 CREATE 权限，或者具有 pg_read_all_stats 角色的权限，除非它是当前数据库的默认表空间。

pg_total_relation_size ( regclass ) → bigint

计算指定表使用的总磁盘空间，包括所有索引和TOAST数据。结果等效于 pg_table_size + pg_indexes_size。

pg_relation_filenode ( relation regclass ) → oid

返回当前分配给指定关系的 “filenode” 号。filenode 是用于关系的文件名（s）的基本组件（有关详细信息，请参见 第 65.1 节）。对于大多数关系，结果与 pg_class.relfilenode 相同，但对于某些系统目录，relfilenode 为零，必须使用此函数才能获得正确的值。如果传递的关系没有存储（例如视图），则该函数返回 NULL。

pg_relation_filepath ( relation regclass ) → text

返回关系的完整文件路径名（相对于数据库集群的数据目录 PGDATA）。

pg_filenode_relation ( tablespace oid, filenode oid ) → regclass

返回关系的 OID，给出其存储的表空间 OID 和 filenode。这实际上是 pg_relation_filepath 的反向映射。对于数据库的默认表空间中的关系，表空间可以指定为零。如果当前数据库中没有关系与给定值相关联，则返回 NULL。

pg_collation_actual_version ( oid ) → text

返回排序规则对象的实际版本，因为它当前安装在操作系统中。如果这与 pg_collation.collversion 中的值不同，则依赖排序规则的对象可能需要重建。另请参见 ALTER COLLATION。

pg_database_collation_actual_version ( oid ) → text

返回数据库排序规则的实际版本，因为它当前安装在操作系统中。如果这与 pg_database.datcollversion 中的值不同，则依赖排序规则的对象可能需要重建。另请参见 ALTER DATABASE。

pg_import_system_collations ( schema regnamespace ) → integer

根据在操作系统中找到的所有语言环境，将排序规则添加到系统目录 pg_collation 中。这就是 initdb 使用的；有关详细信息，请参见 第 23.2.2 节。如果后来将其他语言环境安装到操作系统中，则可以再次运行此函数以添加新语言环境的排序规则。与 pg_collation 中现有条目匹配的语言环境将被跳过。（但基于操作系统中不再存在的语言环境的排序规则对象不会被此函数删除。）schema 参数通常为 pg_catalog，但这并不是必需的；排序规则也可以安装到其他模式中。该函数返回它创建的新排序规则对象的数量。此函数的使用仅限于超级用户。

pg_partition_tree ( regclass ) → setof record ( relid regclass, parentrelid regclass, isleaf boolean, level integer )

列出给定分区表或分区索引的分区树中的表或索引，每个分区对应一行。提供的信息包括分区的 OID、其直接父级的 OID、一个布尔值，指示该分区是否为叶节点，以及一个整数，指示其在层次结构中的级别。对于输入表或索引，级别值为 0；对于其直接子分区，级别值为 1；对于其分区，级别值为 2，依此类推。如果关系不存在，或者不是分区或分区表，则不返回任何行。

pg_partition_ancestors ( regclass ) → setof regclass

列出给定分区的祖先关系，包括关系本身。如果关系不存在，或者不是分区或分区表，则不返回任何行。

pg_partition_root ( regclass ) → regclass

返回给定关系所属的分区树的最顶层父级。如果关系不存在，或者不是分区或分区表，则返回 NULL。

brin_summarize_new_values ( index regclass ) → integer

扫描指定的 BRIN 索引以查找基本表中目前未被索引汇总的页面范围；对于任何这样的范围，它都会通过扫描这些表页面来创建一个新的摘要索引元组。返回插入索引的新页面范围摘要的数量。

brin_summarize_range ( index regclass, blockNumber bigint ) → integer

如果尚未进行摘要，则对包含给定块的页面范围进行摘要。这与 brin_summarize_new_values 相似，只是它只处理包含给定表块号的页面范围。

brin_desummarize_range ( index regclass, blockNumber bigint ) → void

删除摘要包含给定表块的页面范围的 BRIN 索引元组（如果有）。

gin_clean_pending_list ( index regclass ) → bigint

通过将指定 GIN 索引的 “待处理” 列表中的条目批量移动到主 GIN 数据结构中来清理它。返回从待处理列表中删除的页面数量。如果参数是使用禁用的 fastupdate 选项构建的 GIN 索引，则不会进行清理，并且结果为零，因为该索引没有待处理列表。有关待处理列表和 fastupdate 选项的详细信息，请参见 第 64.4.4.1 节 和 第 64.4.5 节。

pg_ls_dir ( dirname text [, missing_ok boolean, include_dot_dirs boolean ] ) → setof text

返回指定目录中所有文件（以及目录和其他特殊文件）的名称。 include_dot_dirs 参数指示是否将 “.” 和 “..” 包含在结果集中；默认是不包含它们。当 missing_ok 为 true 时，包含它们可以用来区分空目录和不存在的目录。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_ls_logdir () → setof record ( name text, size bigint, modification timestamp with time zone )

返回服务器日志目录中每个普通文件的名称、大小和上次修改时间（mtime）。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和具有 pg_monitor 角色权限的角色，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_ls_waldir () → setof record ( name text, size bigint, modification timestamp with time zone )

返回服务器的预写日志 (WAL) 目录中每个普通文件的名称、大小和上次修改时间（mtime）。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和具有 pg_monitor 角色权限的角色，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_ls_logicalmapdir () → setof record ( name text, size bigint, modification timestamp with time zone )

返回服务器的 pg_logical/mappings 目录中每个普通文件的名称、大小和上次修改时间（mtime）。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和 pg_monitor 角色的成员，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_ls_logicalsnapdir () → setof record ( name text, size bigint, modification timestamp with time zone )

返回服务器的 pg_logical/snapshots 目录中每个普通文件的名称、大小和上次修改时间（mtime）。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和 pg_monitor 角色的成员，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_ls_replslotdir ( slot_name text ) → setof record ( name text, size bigint, modification timestamp with time zone )

返回服务器的 pg_replslot/slot_name 目录中每个普通文件的名称、大小和上次修改时间（mtime），其中 slot_name 是作为函数输入提供的复制槽的名称。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和 pg_monitor 角色的成员，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_ls_archive_statusdir () → setof record ( name text, size bigint, modification timestamp with time zone )

返回服务器 WAL 存档状态目录 (pg_wal/archive_status) 中每个普通文件的名称、大小和上次修改时间（mtime）。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和 pg_monitor 角色的成员，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_ls_tmpdir ( [ tablespace oid ] ) → setof record ( name text, size bigint, modification timestamp with time zone )

返回指定 tablespace 的临时文件目录中每个普通文件的名称、大小和上次修改时间（mtime）。如果未提供 tablespace，则检查 pg_default 表空间。以点开头的文件名、目录和其他特殊文件将被排除在外。

默认情况下，此函数仅限于超级用户和 pg_monitor 角色的成员，但其他用户可以被授予 EXECUTE 权限以运行该函数。

pg_read_file ( filename text [, offset bigint, length bigint ] [, missing_ok boolean ] ) → text

返回文本文件的所有或部分内容，从给定的字节 offset 开始，返回最多 length 个字节（如果先到达文件末尾，则返回更少）。如果 offset 为负，则它相对于文件末尾。如果省略 offset 和 length，则返回整个文件。从文件中读取的字节被解释为数据库编码中的字符串；如果它们在该编码中无效，则会抛出错误。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_read_binary_file ( filename text [, offset bigint, length bigint ] [, missing_ok boolean ] ) → bytea

返回文件的所有或部分内容。此函数与 pg_read_file 相同，只是它可以读取任意二进制数据，并将结果作为 bytea 而不是 text 返回；因此，不会执行任何编码检查。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

结合 convert_from 函数，此函数可用于以指定编码读取文本文件并转换为数据库编码

SELECT convert_from(pg_read_binary_file('file_in_utf8.txt'), 'UTF8');

pg_stat_file ( filename text [, missing_ok boolean ] ) → record ( size bigint, access timestamp with time zone, modification timestamp with time zone, change timestamp with time zone, creation timestamp with time zone, isdir boolean )

返回包含文件大小、最后访问时间戳、最后修改时间戳、最后文件状态更改时间戳（仅限 Unix 平台）、文件创建时间戳（仅限 Windows）、以及指示其是否为目录的标志的记录。

默认情况下，此函数仅限于超级用户，但其他用户可以被授予 EXECUTE 来运行该函数。

pg_advisory_lock ( key bigint ) → void

pg_advisory_lock ( key1 integer, key2 integer ) → void

获取独占会话级建议锁，必要时等待。

pg_advisory_lock_shared ( key bigint ) → void

pg_advisory_lock_shared ( key1 integer, key2 integer ) → void

获取共享会话级建议锁，必要时等待。

pg_advisory_unlock ( key bigint ) → boolean

pg_advisory_unlock ( key1 integer, key2 integer ) → boolean

释放之前获取的独占会话级建议锁。如果锁已成功释放，则返回 true。如果锁未被持有，则返回 false，此外，服务器还会报告一个 SQL 警告。

pg_advisory_unlock_all () → void

释放当前会话持有的所有会话级建议锁。（即使客户端不正常断开连接，此函数也会在会话结束时隐式调用。）

pg_advisory_unlock_shared ( key bigint ) → boolean

pg_advisory_unlock_shared ( key1 integer, key2 integer ) → boolean

释放之前获取的共享会话级建议锁。如果锁已成功释放，则返回 true。如果锁未被持有，则返回 false，此外，服务器还会报告一个 SQL 警告。

pg_advisory_xact_lock ( key bigint ) → void

pg_advisory_xact_lock ( key1 integer, key2 integer ) → void

获取独占事务级建议锁，必要时等待。

pg_advisory_xact_lock_shared ( key bigint ) → void

pg_advisory_xact_lock_shared ( key1 integer, key2 integer ) → void

获取共享事务级建议锁，必要时等待。

pg_try_advisory_lock ( key bigint ) → boolean

pg_try_advisory_lock ( key1 integer, key2 integer ) → boolean

如果可用，则获取独占会话级建议锁。这将立即获取锁并返回 true，或者如果无法立即获取锁，则在不等待的情况下返回 false。

pg_try_advisory_lock_shared ( key bigint ) → boolean

pg_try_advisory_lock_shared ( key1 integer, key2 integer ) → boolean

如果可用，则获取共享会话级建议锁。这将立即获取锁并返回 true，或者如果无法立即获取锁，则在不等待的情况下返回 false。

pg_try_advisory_xact_lock ( key bigint ) → boolean

pg_try_advisory_xact_lock ( key1 integer, key2 integer ) → boolean

如果可用，则获取独占事务级建议锁。这将立即获取锁并返回 true，或者如果无法立即获取锁，则在不等待的情况下返回 false。

pg_try_advisory_xact_lock_shared ( key bigint ) → boolean

pg_try_advisory_xact_lock_shared ( key1 integer, key2 integer ) → boolean

如果可用，则获取共享事务级建议锁。这将立即获取锁并返回 true，或者如果无法立即获取锁，则在不等待的情况下返回 false。