PostgreSQL 文档检索

application_name连接参数本站词条指定 application_name 配置参数的值。 会话与协议 application_name 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 PGAPPNAME 编译时回退表达式 NULL 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQconnectdb 、 PQsetdbLogin 和 PQsetdb 在调…连接参数 · 会话与协议 authtype连接参数本站词条对应版本的 libpq 源码声明了关键字 authtype，但“参数关键字”一节并未记载它。此处保留声明作为源码证据；这不代表它是受支持的使用方式。 仅源码声明 authtype 客户端库 libpq 10.23 手册定义 仅源码声明 源码中的环境变量回退 PGAUTHTYPE 编译时回退表达式 DefaultAuthtype 默认值解析与服务文件优先级 以下环境变量可用于选…连接参数 · 仅源码声明 channel_binding连接参数本站词条控制客户端是否使用通道绑定。require 表示连接必须使用通道绑定；prefer 表示可用时优先使用；disable 表示禁止使用。PostgreSQL 构建时启用 SSL 支持则默认为 prefer，否则默认为 disable。 身份认证 channel_binding 客户端库 libpq 13.23 手册定义 手册已记载 源码中的环境变量回退 PGCHANNELBIN…连接参数 · 身份认证 client_encoding连接参数本站词条设置此连接的 client_encoding 配置参数。除对应服务器选项接受的值外，还可使用 auto，根据客户端当前区域设置确定适当编码，在 Unix 系统上依据 LC_CTYPE 环境变量。 会话与协议 client_encoding 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 PGCLIENTENCODING 编译时回退表达式 NULL…连接参数 · 会话与协议 connect_timeout连接参数本站词条建立连接时最长等待时间，单位为秒，以十进制整数书写，例如 10。零、负数或未指定表示无限等待。此超时分别应用于每个主机名或 IP 地址。例如，指定两个主机且 connect_timeout 为 5 时，每个主机在 5 秒内未连接成功就会超时，总等待时间可能达到 10 秒。 超时与保活 建立连接时最长等待时间，单位为秒，以十进制整数书写，例如 10。零、负数或未指定表示无限等待…连接参数 · 超时与保活 dbname连接参数本站词条数据库名称。默认为与用户名相同。在某些情况下，该值会被检查是否为扩展格式；有关更多详细信息，请参阅 第 32.1.1 节 。 连接目标 数据库名，默认与用户名相同。在某些上下文中，会检查该值是否采用扩展格式，详情见第 33.1.1 节。 dbname 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 PGDATABASE 编译时回退表达式 NULL…连接参数 · 连接目标 fallback_application_name连接参数本站词条指定 application_name 配置参数的后备值。如果连接参数和 PGAPPNAME 环境变量都未提供 application_name，就使用此值。通用工具程序可据此设置默认应用名，同时允许用户覆盖。 会话与协议 fallback_application_name 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编译时回…连接参数 · 会话与协议 gssdelegation连接参数本站词条将 GSS 凭据转发（委派）给服务器。默认值为 0 ，表示不向服务器转发凭据。将其设置为 1 时，会在可能的情况下转发凭据。 GSSAPI 与 Kerberos gssdelegation 客户端库 libpq 16.15 手册定义 手册已记载 源码中的环境变量回退 PGGSSDELEGATION 编译时回退表达式 "0" 默认值解析与服务文件优先级 以下环境变量可用于选择连…连接参数 · GSSAPI 与 Kerberos gssencmode连接参数本站词条决定是否与服务器协商安全的 GSS TCP/IP 连接，以及协商时的优先级。共有三种模式： GSSAPI 与 Kerberos gssencmode 客户端库 libpq 12.22 手册定义 手册已记载 源码中的环境变量回退 PGGSSENCMODE 编译时回退表达式 DefaultGSSMode 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQ…连接参数 · GSSAPI 与 Kerberos gsslib连接参数本站词条GSSAPI 认证使用的 GSS 库。目前仅在同时支持 GSSAPI 和 SSPI 的 Windows 构建中生效，其他情况忽略。此时设为 gssapi，可让 libpq 使用 GSSAPI 库认证，而非默认的 SSPI。 GSSAPI 与 Kerberos gsslib 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 PGGSSLIB 编译时回…连接参数 · GSSAPI 与 Kerberos host连接参数本站词条要连接的主机名。 如果主机名看起来像绝对路径名，则指定的是 Unix 域通信，而非 TCP/IP 通信；此值是存放套接字文件的目录名。（在 Unix 上，绝对路径名以斜杠开头。在 Windows 上，也会识别以驱动器号开头的路径。）如果主机名以 @ 开头，则将其视为抽象命名空间中的 Unix 域套接字（目前在 Linux 和 Windows 上支持）。当未指定 host 或其值…连接参数 · 连接目标 hostaddr连接参数本站词条要连接主机的数值 IP 地址，应使用标准 IPv4 格式，例如 172.28.40.9。机器支持 IPv6 时，也可以使用 IPv6 地址。只要此参数为非空字符串，就始终使用 TCP/IP 通信。未指定此参数时，会解析 host 以取得对应 IP 地址；如果 host 本身是 IP 地址，则直接使用。 连接目标 要连接主机的数值 IP 地址，应使用标准 IPv4 格式，例如 …连接参数 · 连接目标 keepalives连接参数本站词条控制是否使用客户端 TCP 保活。默认值为 1，即启用；不需要保活时可改为 0，即禁用。通过 Unix 域套接字连接时，此参数被忽略。 超时与保活 keepalives 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编译时回退表达式 NULL 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQconne…连接参数 · 超时与保活 keepalives_count连接参数本站词条控制允许丢失多少个 TCP 保活探测，之后才将客户端到服务器的连接视为失效。零表示使用系统默认值。通过 Unix 域套接字连接或禁用保活时，此参数被忽略。仅在提供 TCP_KEEPCNT 或等价套接字选项的系统上支持；其他系统中无效。 超时与保活 keepalives_count 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编…连接参数 · 超时与保活 keepalives_idle连接参数本站词条控制连接空闲多少秒后，TCP 应向服务器发送保活消息。零表示使用系统默认值。通过 Unix 域套接字连接或禁用保活时，此参数被忽略。仅在提供 TCP_KEEPIDLE 或等价套接字选项的系统以及 Windows 上支持；其他系统中无效。 超时与保活 keepalives_idle 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编…连接参数 · 超时与保活 keepalives_interval连接参数本站词条控制 TCP 保活消息未获服务器确认后，等待多少秒再重新发送。零表示使用系统默认值。通过 Unix 域套接字连接或禁用保活时，此参数被忽略。仅在提供 TCP_KEEPINTVL 或等价套接字选项的系统以及 Windows 上支持；其他系统中无效。 超时与保活 keepalives_interval 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 …连接参数 · 超时与保活 krbsrvname连接参数本站词条GSSAPI 认证使用的 Kerberos 服务名。此值必须与服务器配置中的服务名匹配，Kerberos 认证才能成功，另见第 20.6 节。默认值通常为 postgres，但构建 PostgreSQL 时可通过 configure 的 --with-krb-srvnam 选项更改。多数环境无需修改此参数；某些 Kerberos 实现可能要求不同的服务名，例如 Microsof…连接参数 · GSSAPI 与 Kerberos load_balance_hosts连接参数本站词条控制客户端尝试连接可用主机和地址的顺序。一旦某次连接尝试成功，就不会再尝试其他主机和地址。该参数通常与多个主机名或返回多个 IP 地址的 DNS 记录一起使用。它还可以与 target_session_attrs 组合使用，例如只在备库之间进行负载均衡。连接一旦成功建立，随后在返回的连接上发出的所有查询都会发送到同一台服务器。目前有两种模式： 连接目标 load_balanc…连接参数 · 连接目标 max_protocol_version连接参数本站词条这个参数指定要向服务器请求的协议版本。默认会使用 PostgreSQL 协议的 3.0 版本；但如果连接字符串指定了依赖更高协议版本的特性，则会使用 libpq 支持的最新版本。如果服务器不支持客户端请求的协议版本，连接会自动降级为服务器支持的较低次版本协议。连接尝试完成后，你可以使用 PQfullProtocolVersion 来确定最终协商得到的确切协议版本。 会话与协议…连接参数 · 会话与协议 min_protocol_version连接参数本站词条这个参数指定该连接允许的最低协议版本。默认情况下，允许使用 libpq 所支持的任何 PostgreSQL 协议版本，目前即 3.0 。如果服务器不支持此协议版本或更高版本，则连接将被关闭。 会话与协议 min_protocol_version 客户端库 libpq 18.6 手册定义 手册已记载 源码中的环境变量回退 PGMINPROTOCOLVERSION 编译时回退表达…连接参数 · 会话与协议 oauth_ca_file连接参数本站词条包含一个或多个 SSL 证书颁发机构（ CA ）证书的文件名，用于验证授权服务器及其端点的身份。默认使用 Curl 的系统证书包。 身份认证 oauth_ca_file 客户端库 libpq 19beta4 手册定义 手册已记载 源码中的环境变量回退 PGOAUTHCAFILE 编译时回退表达式 NULL 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供…连接参数 · 身份认证 oauth_client_id连接参数本站词条由授权服务器发放的 OAuth 2.0 客户端标识符。如果 PostgreSQL 服务器为该连接 请求 OAuth 令牌 ，并且没有安装 自定义 OAuth 钩子 来提供该令牌，那么就必须设置此参数；否则连接会失败。 身份认证 oauth_client_id 客户端库 libpq 18.6 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编译时回退表达式 NULL…连接参数 · 身份认证 oauth_client_secret连接参数本站词条与 OAuth 授权服务器通信时要使用的客户端密码（如果有）。该参数是否必需由 OAuth 提供者决定；公开客户端（public client）通常不使用密钥，而机密客户端（confidential client）通常会使用。 身份认证 oauth_client_secret 客户端库 libpq 18.6 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编译时回…连接参数 · 身份认证 oauth_issuer连接参数本站词条如果服务器为该连接请求 OAuth 令牌，要联系的受信任签发者的 HTTPS URL。所有 OAuth 连接都必须设置此参数；它应当与 服务器 HBA 配置 中的 issuer 设置完全一致。 身份认证 oauth_issuer 客户端库 libpq 18.6 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编译时回退表达式 NULL 默认值解析与服务文件优先级 …连接参数 · 身份认证 oauth_scope连接参数本站词条发送给授权服务器的访问请求的授权范围，以空格分隔的 OAuth 授权范围标识符列表指定（列表可以为空）。该参数是可选的，面向高级用法。 身份认证 oauth_scope 客户端库 libpq 18.6 手册定义 手册已记载 源码中的环境变量回退 选项表中未声明 编译时回退表达式 NULL 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQconnec…连接参数 · 身份认证 options连接参数本站词条指定连接开始时发送到服务器的命令行选项。例如，将其设置为 -c geqo=off 或 --geqo=off 会把会话的 geqo 参数值设为 off 。此字符串中的空格被视为分隔命令行参数，除非用反斜杠（ \ ）转义；写 \\ 表示字面上的反斜杠。有关可用选项的详细讨论，请参阅 第 19 章 。 会话与协议 指定连接建立时发送给服务器的命令行选项。例如，设为 -c geqo=…连接参数 · 会话与协议 passfile连接参数本站词条指定用于存储密码的文件名（参见 第 32.15 节 ）。默认为 ~/.pgpass ，或在Microsoft Windows上为 %APPDATA%\postgresql\pgpass.conf 。（如果此文件不存在，则不会报告错误。） 身份认证 指定存储密码的文件名，见第 33.15 节。默认为 ~/.pgpass；Microsoft Windows 上为 %APPDATA…连接参数 · 身份认证 password连接参数本站词条服务器要求密码认证时使用的密码。 身份认证 password 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 PGPASSWORD 编译时回退表达式 NULL 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQconnectdb 、 PQsetdbLogin 和 PQsetdb 在调用代码未直接指定参数值时使用。例如，这…连接参数 · 身份认证 port连接参数本站词条服务器主机上要连接的端口号；对于 Unix 域连接，则为套接字文件名后缀。如果 host 或 hostaddr 指定了多个主机，可提供与主机列表等长的逗号分隔端口列表，或指定一个供所有主机使用的端口号。空字符串或列表中的空项表示使用 PostgreSQL 构建时确定的默认端口。 连接目标 port 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 …连接参数 · 连接目标 replication连接参数本站词条这个选项确定连接是否应该使用复制协议而不是正常协议。这就是PostgreSQL复制连接以及诸如 pg_basebackup 这样的工具在内部使用的方式，但也可以被第三方应用程序使用。要了解复制协议的描述，请参考 第 54.4 节 。 会话与协议 对应版本的 libpq 源码声明了关键字 replication，但“参数关键字”一节并未记载它。此处保留声明作为源码证据；这不代表…连接参数 · 会话与协议 require_auth连接参数本站词条指定客户端要求服务器采用的认证方法。如果服务器没有使用所要求的方法来认证客户端，或者服务器没有完整完成认证握手，则连接将失败。也可以提供一个以逗号分隔的方法列表，此时服务器必须恰好使用其中一种方法，连接才会成功。默认情况下接受任意认证方法，并且服务器也可以完全跳过认证。 身份认证 require_auth 客户端库 libpq 16.15 手册定义 手册已记载 源码中的环境变…连接参数 · 身份认证 requirepeer连接参数本站词条指定服务器的操作系统用户名，例如 requirepeer=postgres。建立 Unix 域套接字连接时，如果设置了此参数，客户端会在连接开始时检查服务器进程是否以指定用户运行；不符则报错并中止连接。此参数可提供类似于 TCP/IP 连接中 SSL 证书所提供的服务器身份认证。如果 Unix 域套接字位于 /tmp 等所有人可写的位置，任何用户都可能在那里启动监听服务器；使用…连接参数 · 身份认证 requiressl连接参数本站词条此选项已弃用，应改用 sslmode。 TLS requiressl 客户端库 libpq 10.23 手册定义 手册已记载 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQconnectdb 、 PQsetdbLogin 和 PQsetdb 在调用代码未直接指定参数值时使用。例如，这样可以避免在简单的客户端应用程序中硬编码数据库连接信息。 服务名…连接参数 · TLS scram_client_key连接参数本站词条以 Base64 编码的 SCRAM 客户端密钥。外部数据包装器或类似中间件可以利用它启用透传式 SCRAM 认证。一个实现示例见 第 F.40.1.10 节 。用户或客户端应用不应直接指定它。 身份认证 以 Base64 编码的 SCRAM 客户端密钥。外部数据包装器或类似中间件可以利用它启用透传式 SCRAM 认证。一个实现示例见 第 F.38.1.10 节 。用户或客户…连接参数 · 身份认证 scram_server_key连接参数本站词条以 Base64 编码的 SCRAM 服务器密钥。外部数据包装器或类似中间件可以利用它启用透传式 SCRAM 认证。一个实现示例见 第 F.40.1.10 节 。用户或客户端应用不应直接指定它。 身份认证 以 Base64 编码的 SCRAM 服务器密钥。外部数据包装器或类似中间件可以利用它启用透传式 SCRAM 认证。一个实现示例见 第 F.38.1.10 节 。用户或客户…连接参数 · 身份认证 service连接参数本站词条用于额外参数的服务名称。它指定了 pg_service.conf 中保存额外连接参数的服务名称。这允许应用程序只指定一个服务名称，以便可以集中维护连接参数。参见 第 32.16 节 。 连接目标 用于获取附加参数的服务名。它指定 pg_service.conf 中包含附加连接参数的服务名称，使应用只需指定服务名，连接参数便可集中维护。见第 33.16 节。 service 客…连接参数 · 连接目标 servicefile连接参数本站词条该选项指定每个用户的连接服务文件名称（参见 第 32.16 节 ）。默认值是 ~/.pg_service.conf ，在 Microsoft Windows 上则是 %APPDATA%\postgresql\.pg_service.conf 。 会话与协议 该选项指定每个用户的连接服务文件名称（参见 第 32.17 节 ）。默认值是 ~/.pg_service.conf ，在…连接参数 · 会话与协议 ssl_max_protocol_version连接参数本站词条指定连接允许使用的最高 SSL/TLS 协议版本。有效值为 TLSv1、TLSv1.1、TLSv1.2 和 TLSv1.3。支持哪些协议取决于所用 OpenSSL 版本，旧版本不支持最新协议。未设置时忽略此参数；如果后端定义了版本上限，则使用该上限。限制最高协议版本主要用于测试，或某个组件无法正常使用较新协议的场景。 TLS ssl_max_protocol_version …连接参数 · TLS ssl_min_protocol_version连接参数本站词条指定连接允许使用的最低 SSL/TLS 协议版本。有效值为 TLSv1、TLSv1.1、TLSv1.2 和 TLSv1.3。支持哪些协议取决于所用 OpenSSL 版本，旧版本不支持最新协议。未指定时默认为 TLSv1.2，符合本文撰写时的行业最佳实践。 TLS ssl_min_protocol_version 客户端库 libpq 13.23 手册定义 手册已记载 源码中的…连接参数 · TLS sslcert连接参数本站词条指定客户端 SSL 证书的文件名，代替默认的 ~/.postgresql/postgresql.crt。未建立 SSL 连接时，此参数被忽略。 TLS sslcert 客户端库 libpq 10.23 手册定义 手册已记载 源码中的环境变量回退 PGSSLCERT 编译时回退表达式 NULL 默认值解析与服务文件优先级 以下环境变量可用于选择连接参数的默认值，供 PQconn…连接参数 · TLS