PostgreSQL 文档检索
PG 18 · 按类别浏览,或输入名称与关键词
分类索引55
application_name指定 application_name 配置参数的值。
会话与协议
连接参数 application_name。 同版本中文手册定义 指定 application_name 配置参数的值。 查看完整中文手册与上下文 。
application_name
客户端库 libpq 10.23
手册定义 手册已记载
源码中的环境变量回退 PGAPPNAME
编译时回退表达式 NULL…连接参数 · 会话与协议
authtype同版本 libpq 源码声明了 authtype 关键词,但参数关键词章节没有对其进行说明;保留源码声明不等于确认它是受支持的操作接口。
仅源码声明
同版本 libpq 源码声明了 authtype 关键词,但参数关键词章节没有对其进行说明;保留源码声明不等于确认它是受支持的操作接口。 "authtype", "PGAUTHTYPE", DefaultAuthtype, NU…连接参数 · 仅源码声明
channel_binding这个选项控制客户端对通道绑定的使用。设置为 require 表示连接必须使用通道绑定, prefer 表示客户端将在可用时选择通道绑定,而 disable 则阻止使用通道绑定。默认情况下,如果 PostgreSQL 是使用 SSL 支持编译的,则默认为 prefer ;否则默认为 disable 。 通道绑定是服务器向客户端证明自身身份的一种方法。它只在使用 PostgreSQ…连接参数 · 身份认证
client_encoding这将为此连接设置 client_encoding 配置参数。除了对应服务器选项接受的值外,您还可以使用 auto 来从客户端的当前区域设置(Unix 系统上的 LC_CTYPE 环境变量)确定正确的编码。
会话与协议
连接参数 client_encoding。 同版本中文手册定义 这将为此连接设置 client_encoding 配置参数。除了对应服务器选项接受的值外,您还可…连接参数 · 会话与协议
connect_timeout连接时的最长等待时间,以秒为单位(写成十进制整数,例如, 10 )。零、负值或未指定表示无限等待。此超时时间分别适用于每个主机名或 IP 地址。例如,如果指定了两个主机且 connect_timeout 为 5,那么每个主机在 5 秒内未建立连接就会超时,因此等待连接的总时间可能长达 10 秒。
超时与保活
连接时的最长等待时间,以秒为单位(写成十进制整数,例如, 10 )。…连接参数 · 超时与保活
dbname数据库名称。默认为与用户名相同。在某些情况下,该值会被检查是否为扩展格式;有关更多详细信息,请参阅 第 32.1.1 节 。
连接目标
数据库名称。默认为与用户名相同。在某些情况下,该值会被检查是否为扩展格式;有关更多详细信息,请参阅 第 33.1.1 节 。
连接参数 dbname。 同版本中文手册定义 数据库名称。默认为与用户名相同。在某些情况下,该值会被检查是否为扩展格…连接参数 · 连接目标
fallback_application_name指定 application_name 配置参数的后备值。如果没有通过连接参数或 PGAPPNAME 环境变量为 application_name 指定值,则将使用此值。在通用实用程序中指定后备名称很有用,该程序希望设置默认应用程序名称,但允许用户覆盖它。
会话与协议
连接参数 fallback_application_name。 同版本中文手册定义 指定 applicati…连接参数 · 会话与协议
gssdelegation将 GSS 凭据转发(委派)给服务器。默认值为 0 ,表示不向服务器转发凭据。将其设置为 1 时,会在可能的情况下转发凭据。
GSSAPI 与 Kerberos
连接参数 gssdelegation。 同版本中文手册定义 将 GSS 凭据转发(委派)给服务器。默认值为 0 ,表示不向服务器转发凭据。将其设置为 1 时,会在可能的情况下转发凭据。 查看完整中文手册与上下文 。
…连接参数 · GSSAPI 与 Kerberos
gssencmode这个选项确定是否以及以何种优先级与服务器协商安全的 GSS TCP/IP 连接。有三种模式: disable 仅尝试未经 GSSAPI 加密的连接 prefer (默认) 如果存在 GSSAPI 凭据(即在凭据缓存中),首先尝试 GSSAPI 加密连接;如果失败或没有凭据,则尝试未经 GSSAPI 加密的连接。这是在编译 PostgreSQL 时使用 GSSAPI 支持时的默认…连接参数 · GSSAPI 与 Kerberos
gsslib用于 GSSAPI 认证的 GSS 库。目前,除了包含 GSSAPI 和 SSPI 支持的 Windows 构建之外,这将被忽略。在这种情况下,将其设置为 gssapi ,以使 libpq 使用 GSSAPI 库进行认证,而不是默认的 SSPI。
GSSAPI 与 Kerberos
连接参数 gsslib。 同版本中文手册定义 用于 GSSAPI 认证的 GSS 库。目前,除…连接参数 · GSSAPI 与 Kerberos
host要连接的主机名。 如果主机名看起来像绝对路径名,则指定的是 Unix 域通信,而非 TCP/IP 通信;此值是存放套接字文件的目录名。(在 Unix 上,绝对路径名以斜杠开头。在 Windows 上,也会识别以驱动器号开头的路径。)如果主机名以 @ 开头,则将其视为抽象命名空间中的 Unix 域套接字(目前在 Linux 和 Windows 上支持)。当未指定 host 或其值…连接参数 · 连接目标
hostaddr要连接的主机的数字 IP 地址。这应该是标准的 IPv4 地址格式,例如, 172.28.40.9 。如果您的机器支持 IPv6,也可以使用这些地址。当为此参数指定非空字符串时,总是使用 TCP/IP 通信。如果未指定此参数,则会根据 host 的值查找相应的 IP 地址 — 或者,如果 host 指定了 IP 地址,则将直接使用该值。 使用 hostaddr 允许应用程序避免…连接参数 · 连接目标
keepalives控制是否使用客户端 TCP keepalive。默认值为 1,表示开启;如果不需要 keepalive,可以将其设为 0,表示关闭。对于通过 Unix 域套接字建立的连接,此参数会被忽略。
超时与保活
连接参数 keepalives。 同版本中文手册定义 控制是否使用客户端 TCP keepalive。默认值为 1,表示开启;如果不需要 keepalive,可以将其设为 0,…连接参数 · 超时与保活
keepalives_count控制在客户端与服务器之间的连接被视为中断之前,可以丢失多少个 TCP keepalive 消息。值为零时使用系统默认值。对于通过 Unix 域套接字建立的连接,或禁用 keepalive 时,此参数会被忽略。此参数仅在支持 TCP_KEEPCNT 或等效套接字选项的系统上受支持;在其他系统上无效。
超时与保活
连接参数 keepalives_count。 同版本中文手册定义 …连接参数 · 超时与保活
keepalives_idle控制在多久没有活动后,TCP 应向服务器发送 keepalive 消息,以秒为单位。值为零时使用系统默认值。对于通过 Unix 域套接字建立的连接,或禁用 keepalive 时,此参数会被忽略。此参数仅在支持 TCP_KEEPIDLE 或等效套接字选项的系统以及 Windows 上受支持;在其他系统上无效。
超时与保活
连接参数 keepalives_idle。 同版本中文…连接参数 · 超时与保活
keepalives_interval控制未被服务器确认收到的 TCP keepalive 消息在多少秒后应被重传。值为零时使用系统默认值。对于通过 Unix 域套接字建立的连接,或禁用 keepalive 时,此参数会被忽略。此参数仅在支持 TCP_KEEPINTVL 或等效套接字选项的系统以及 Windows 上受支持;在其他系统上无效。
超时与保活
连接参数 keepalives_interval。 同版本…连接参数 · 超时与保活
krbsrvname使用 GSSAPI 认证时所用的 Kerberos 服务名。这必须与服务器配置中指定的 Kerberos 认证服务名称匹配,才能成功进行认证。(另请参见 第 20.6 节 。)默认值通常为 postgres ,但在构建 PostgreSQL 时,可以通过 configure 的 --with-krb-srvnam 选项更改。在大多数环境中,通常不需要更改此参数。一些 Kerbe…连接参数 · GSSAPI 与 Kerberos
load_balance_hosts控制客户端尝试连接可用主机和地址的顺序。一旦某次连接尝试成功,就不会再尝试其他主机和地址。该参数通常与多个主机名或返回多个 IP 地址的 DNS 记录一起使用。它还可以与 target_session_attrs 组合使用,例如只在备库之间进行负载均衡。连接一旦成功建立,随后在返回的连接上发出的所有查询都会发送到同一台服务器。目前有两种模式: disable (默认) 不在主机…连接参数 · 连接目标
max_protocol_version这个参数指定要向服务器请求的协议版本。默认会使用 PostgreSQL 协议的 3.0 版本;但如果连接字符串指定了依赖更高协议版本的特性,则会使用 libpq 支持的最新版本。如果服务器不支持客户端请求的协议版本,连接会自动降级为服务器支持的较低次版本协议。连接尝试完成后,你可以使用 PQfullProtocolVersion 来确定最终协商得到的确切协议版本。 当前支持的值…连接参数 · 会话与协议
min_protocol_version这个参数指定该连接允许的最低协议版本。默认情况下,允许使用 libpq 所支持的任何 PostgreSQL 协议版本,目前即 3.0 。如果服务器不支持此协议版本或更高版本,则连接将被关闭。 当前支持的值是 3.0 、 3.2 和 latest 。 latest 等价于正在使用的 libpq 版本所支持的最新协议版本,目前即 3.2 。
会话与协议
连接参数 min_prot…连接参数 · 会话与协议
oauth_ca_file包含一个或多个 SSL 证书颁发机构( CA )证书的文件名,用于验证授权服务器及其端点的身份。默认使用 Curl 的系统证书包。 该参数不会影响对 PostgreSQL 服务器证书的验证;参见 sslrootcert 。
身份认证
包含一个或多个 SSL 证书颁发机构( CA )证书的文件名,用于验证授权服务器及其端点的身份。默认使用 Curl 的系统证书包。
oauth_…连接参数 · 身份认证
oauth_client_id由授权服务器发放的 OAuth 2.0 客户端标识符。如果 PostgreSQL 服务器为该连接 请求 OAuth 令牌 ,并且没有安装 自定义 OAuth 钩子 来提供该令牌,那么就必须设置此参数;否则连接会失败。
身份认证
连接参数 oauth_client_id。 同版本中文手册定义 由授权服务器发放的 OAuth 2.0 客户端标识符。如果 PostgreSQL 服务…连接参数 · 身份认证
oauth_client_secret与 OAuth 授权服务器通信时要使用的客户端密码(如果有)。该参数是否必需由 OAuth 提供者决定;公开客户端(public client)通常不使用密钥,而机密客户端(confidential client)通常会使用。
身份认证
连接参数 oauth_client_secret。 同版本中文手册定义 与 OAuth 授权服务器通信时要使用的客户端密码(如果有)。该参数…连接参数 · 身份认证
oauth_issuer如果服务器为该连接请求 OAuth 令牌,要联系的受信任签发者的 HTTPS URL。所有 OAuth 连接都必须设置此参数;它应当与 服务器 HBA 配置 中的 issuer 设置完全一致。 作为标准认证握手的一部分, libpq 会向服务器请求一个 发现文档 ,也就是一个提供一组 OAuth 配置参数的 URL。服务器必须提供一个可由 oauth_issuer 的各组成部分…连接参数 · 身份认证
oauth_scope发送给授权服务器的访问请求的授权范围,以空格分隔的 OAuth 授权范围标识符列表指定(列表可以为空)。该参数是可选的,面向高级用法。 通常客户端会从 PostgreSQL 服务器获得合适的授权范围设置。如果使用这个参数,服务器请求的授权范围列表会被忽略。这可以防止不那么受信任的服务器向最终用户请求不恰当的访问授权范围。不过,如果客户端的授权范围设置不包含服务器所要求的授权范围…连接参数 · 身份认证
options指定连接开始时发送到服务器的命令行选项。例如,将其设置为 -c geqo=off 或 --geqo=off 会把会话的 geqo 参数值设为 off 。此字符串中的空格被视为分隔命令行参数,除非用反斜杠( \ )转义;写 \\ 表示字面上的反斜杠。有关可用选项的详细讨论,请参阅 第 19 章 。
会话与协议
指定连接开始时发送到服务器的命令行选项。例如,将其设置为 -c ge…连接参数 · 会话与协议
passfile指定用于存储密码的文件名(参见 第 32.15 节 )。默认为 ~/.pgpass ,或在 Microsoft Windows 上为 %APPDATA%\postgresql\pgpass.conf 。(如果此文件不存在,则不会报告错误。)
身份认证
指定用于存储密码的文件名(参见 第 33.15 节 )。默认为 ~/.pgpass ,或在 Microsoft Windows…连接参数 · 身份认证
password服务器要求密码认证时所使用的密码。
身份认证
连接参数 password。 同版本中文手册定义 服务器要求密码认证时所使用的密码。 查看完整中文手册与上下文 。
password
客户端库 libpq 10.23
手册定义 手册已记载
源码中的环境变量回退 PGPASSWORD
编译时回退表达式 NULL
默认值解析与服务文件优先级
以下环境变量可用于选择连接参数的默认值,供…连接参数 · 身份认证
port连接到服务器主机的端口号,或者 Unix 域连接的套接字文件名扩展。 如果在 host 或 hostaddr 参数中给出了多个主机,则此参数可以指定与主机列表长度相同的逗号分隔的端口列表,或者可以指定用于所有主机的单个端口号。空字符串,或逗号分隔列表中的空项,指定了在构建 PostgreSQL 时建立的默认端口号。
连接目标
连接参数 port。 同版本中文手册定义 连接到服…连接参数 · 连接目标
replication这个选项确定连接是否应该使用复制协议而不是正常协议。这就是 PostgreSQL 复制连接以及诸如 pg_basebackup 这样的工具在内部使用的方式,但也可以被第三方应用程序使用。要了解复制协议的描述,请参考 第 54.4 节 。 支持以下值(不区分大小写): true , on , yes , 1 连接进入物理复制模式。 database 连接进入逻辑复制模式,连接到 …连接参数 · 会话与协议
require_auth指定客户端要求服务器采用的认证方法。如果服务器没有使用所要求的方法来认证客户端,或者服务器没有完整完成认证握手,则连接将失败。也可以提供一个以逗号分隔的方法列表,此时服务器必须恰好使用其中一种方法,连接才会成功。默认情况下接受任意认证方法,并且服务器也可以完全跳过认证。 可以在方法名前加上 ! 前缀以表示否定,此时服务器 不得 尝试所列方法;除此之外,任何其他方法都可接受,并且…连接参数 · 身份认证
requirepeer这个参数指定了服务器的操作系统用户名,例如 requirepeer=postgres 。在建立 Unix 域套接字连接时,如果设置了这个参数,客户端会在连接开始时检查服务器进程是否在指定的用户下运行;如果不是,则连接会因错误而中止。这个参数可用于提供类似于在 TCP/IP 连接上使用 SSL 证书的服务器认证。(请注意,如果 Unix 域套接字位于 /tmp 或其他公共可写位置…连接参数 · 身份认证
requiressl此选项已弃用,请改用 sslmode 设置。 如果设置为 1,则需要与服务器建立 SSL 连接(这相当于 sslmode require )。 libpq 将拒绝连接,如果服务器不接受 SSL 连接。如果设置为 0(默认值), libpq 将与服务器协商连接类型(相当于 sslmode prefer )。此选项仅在 PostgreSQL 编译时启用了 SSL 支持的情况下可用。…连接参数 · 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 节 …连接参数 · 连接目标
servicefile该选项指定每个用户的连接服务文件名称(参见 第 32.16 节 )。默认值是 ~/.pg_service.conf ,在 Microsoft Windows 上则是 %APPDATA%\postgresql\.pg_service.conf 。
会话与协议
连接参数 servicefile。 同版本中文手册定义 该选项指定每个用户的连接服务文件名称(参见 第 32.16 节 …连接参数 · 会话与协议
ssl_max_protocol_version这个参数指定连接允许的最大 SSL/TLS 协议版本。有效值为 TLSv1 、 TLSv1.1 、 TLSv1.2 和 TLSv1.3 。支持的协议取决于使用的 OpenSSL 版本,旧版本不支持最新的协议版本。如果未设置,则忽略此参数;如果后端定义了最大限制,连接将使用该限制。设置最大协议版本主要用于测试或者某些组件无法使用较新协议时。
TLS
连接参数 ssl_max_p…连接参数 · TLS
ssl_min_protocol_version这个参数指定连接允许的最低 SSL/TLS 协议版本。有效值为 TLSv1 、 TLSv1.1 、 TLSv1.2 和 TLSv1.3 。支持的协议取决于所使用的 OpenSSL 版本,旧版本不支持最现代的协议版本。如果未指定,默认值为 TLSv1.2 ,符合本文撰写时的行业最佳实践。
TLS
连接参数 ssl_min_protocol_version。 同版本中文手册定义 …连接参数 · TLS
sslcert这个参数指定客户端 SSL 证书的文件名,替换默认的 ~/.postgresql/postgresql.crt 。如果没有建立 SSL 连接,则此参数将被忽略。
TLS
连接参数 sslcert。 同版本中文手册定义 这个参数指定客户端 SSL 证书的文件名,替换默认的 ~/.postgresql/postgresql.crt 。如果没有建立 SSL 连接,则此参数将被忽略。…连接参数 · TLS
更多结果
输入名称或关键词,从 PostgreSQL 手册与扩展目录中直接找到定义。
pg17: 限定版本 ex: 只搜扩展 ↑↓ 选择 ↵ 打开