连接设置

介绍设置客户端和服务器连接方式相关的参数。

light_comm

参数说明： 指定服务器是否使用轻量通信方式

该参数指定服务器是否使用基于轻量锁和非阻塞socket的通信方式。该参数属于POSTMASTER类型参数。请参考表1中对应设置方法进行设置。

取值范围：

ON / TRUE：表示使用轻量通信方式
OFF / FALSE：表示不使用轻量通信方式。

默认值： OFF / FALSE

listen_addresses

**参数说明：**声明服务器侦听客户端的TCP/IP地址。

该参数指定openGauss服务器使用哪些IP地址进行侦听，如IPV4或IPV6（若支持）。服务器主机上可能存在多个网卡，每个网卡可以绑定多个IP地址，该参数就是控制openGauss到底绑定在哪个或者哪几个IP地址上。而客户端则可以通过该参数中指定的IP地址来连接openGauss或者给openGauss发送请求。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

取值范围：

主机名或IP地址，多个值之间用英文逗号分隔。
星号“*”或“0.0.0.0”表示侦听所有IP地址。配置侦听所有IP地址存在安全风险，不推荐用户使用。必须与有效地址结合使用（比如本地IP等），否则，可能造成Build失败的问题。同时，主备环境下配置为“\*”或“0.0.0.0”时，主节点数据库路径下postgresql.conf文件中的localport端口号不能为数据库dataPortBase+1，否则会导致数据库无法启动。
若存在非法IP时，进程启动阶段会报错退出。

**默认值：**数据库实例安装好后，根据XML配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为：listen_addresses = 'x.x.x.x'。

说明：
支持gs_guc reload方式进行设置该参数值，openGauss内核会按照“侦听新IP、保留重复IP的侦听、关闭无效IP侦听”的策略，动态侦听该参数配置的IP。若存在非法IP（如本机未配置此IP、无效的IP值、该IP已被侦听等）时，内核侦听IP失败，此时会出现listen_addresses设置值和实际侦听IP的状况不匹配。
若通过gs_guc reload方式设置参数值，且参数值中均为非法IP时，侦听新IP失败，同时会取消全部旧IP的侦听。若参数为空时，直接拦截而保持旧IP侦听。
若在进程启动参数中配置listen_addresses后，该参数将强制指定为设置值而不会被reload修改。
若设置新参数值和已设置旧参数值相同时，将不再进行侦听动作。故设置listen_addresses参数值且列表中某非法IP时，内核侦听此IP失败；待IP变为合法后，再次设置相同参数值，由于前后两次参数值相同，则不会侦听此IP。此时需通过gs_guc reload方式将此IP从参数值中去除，并再次设置添加该IP，才会成功侦听。
通过gs_guc reload方式刷新该参数后，若不再侦听某IP后，需再执行gs_validate_ext_listen_ip函数进行清理连接操作，具体入参及执行详见该函数说明。
禁止gs_guc工具通过"-N all"方式reload刷新所有DN的listen_addresses参数值，仅允许单DN设置。
动态修改listen_addresses属于高危操作，若配置有误可能导致数据库无法接受新连接，进而影响业务，请谨慎操作。

local_bind_address

**参数说明：**声明当前节点连接openGauss其他节点绑定的本地IP地址。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**默认值：**数据库实例安装好后，根据XML配置文件中不同实例的IP地址配置不同默认值。DN的默认参数值为：local_bind_address = 'x.x.x.x'。

port

**参数说明：**openGauss服务侦听的TCP端口号。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

说明：
该参数由安装时的配置文件指定，请勿轻易修改，否则修改后会影响数据库正常通信。

**取值范围：**整型，1～65535

说明：

设置端口号时，请设置一个未被占用的端口号。设置多个实例的端口号，不可冲突。

1~1023为操作系统保留端口号，请不要使用。

通过配置文件安装数据库实例时，配置文件中的端口号需要注意通信矩阵预留端口。如：DN还需保留dataPortBase+1作为内部工具使用端口，保留dataPortBase+6作为流引擎消息队列通信端口等。故数据库实例安装阶段，port最大值为：DN可设置65529，同时需要保证端口号不冲突。
通过gs_guc set的方式修改了port值之后，需要手动修改下静态配置文件static_config_files里面的端口信息后，才可以生效。

**默认值：**5432（实际值由安装时的配置文件指定）

max_connections

**参数说明：**允许和数据库连接的最大并发连接数。此参数会影响openGauss的并发能力。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**整型。最小值为10（要大于max_wal_senders），理论最大值为262143，实际最大值为动态值，计算公式为“262143 - job_queue_processes - autovacuum_max_workers - AUXILIARY_BACKENDS - AV_LAUNCHER_PROCS - max_inner_tool_connections”。job_queue_processes、autovacuum_max_workers和max_inner_tool_connections的值取决于对应GUC参数的设置。AUXILIARY_BACKENDS为预留辅助线程数，固定为20。AV_LAUNCHER_PROCS为预留autovacuum的lancher线程数，固定为2。

默认值：

200：编译安装数据库或极简安装数据库的情况下。
5000：使用om安装数据库的情况下。

设置建议：

数据库主节点中此参数建议保持默认值。

配置不当时影响：

若配置max_connections过大，超过计算公式所描述的最大动态值，会出现节点拉起失败问题，报错提示“invalid value for parameter “max_connections””。
若未按照对外出口规格配置仅调大max_connections参数值，未同比例调整内存参数。业务压力大时，容易出现内存不足，报错提示“memory is temporarily unavailable”。

说明：

对于管理员用户的连接数限制会略超过max_connections设置，目的是为了让管理员在链接被普通用户占满后仍可以连接上数据库，再超过一定范围（sysadmin_reserved_connections参数）后才会报错。即管理员用户的最大连接数等于max_connections + sysadmin_reserved_connections。

对于普通用户来说，由于内部作业也会使用一些链接，因此会略小于max_connections，具体值取决于内部链接个数。

max_inner_tool_connections

**参数说明：**允许和数据库连接的工具的最大并发连接数。此参数会影响openGauss的工具连接并发能力。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**整型，最小值为1，最大值为MIN(262143, max_connections)，max_connections的计算方法见上文。

**默认值：**数据库节点为50。如果该默认值超过内核支持的最大值（在执行gs_initdb的时候判断），系统会提示错误。

设置建议：

数据库主节点中此参数建议保持默认值。

增大此参数可能导致openGauss要求更多的SystemV共享内存或者信号量，可能超过操作系统缺省配置的最大值。这种情况下，请酌情对数值加以调整。

sysadmin_reserved_connections

**参数说明：**为管理员用户预留的最少连接数，不建议设置过大。该参数和max_connections参数配合使用，管理员用户的最大连接数等于max_connections + sysadmin_reserved_connections。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**整型，最小值为0，最大值为MIN(262143, max_connections)，max_connections的计算方法见上文。

**默认值：**3

注意：启用线程池功能时，若线程池占满将形成处理瓶颈，导致管理员预留连接无法正常建立，作为逃生手段，此时可使用gsql通过主端口+1端口号连入，清理无用会话，即可正常连入。

unix_socket_directory

**参数说明：**设置openGauss服务器侦听客户端连接的Unix域套接字目录。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

该参数的长度限制于操作系统的长度，超过该限制将会导致Unix-domain socket path “xxx” is too long的问题。

**取值范围：**字符串

**默认值：**空字符串（实际值由安装时配置文件指定）

unix_socket_group

**参数说明：**设置Unix域套接字的所属组（套接字的所属用户总是启动服务器的用户）。可以与选项unix_socket_permissions一起用于对套接字进行访问控制。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**字符串，其中空字符串表示当前用户的缺省组。

**默认值：**空字符串

unix_socket_permissions

**参数说明：**设置Unix域套接字的访问权限。

Unix域套接字使用普通的Unix文件系统权限集。这个参数的值应该是数值的格式（chmod和umask命令可接受的格式）。如果使用自定义的八进制格式，数字必须以0开头。

建议设置为0770（只有当前连接数据库的用户和同组的人可以访问）或者0700（只有当前连接数据库的用户自己可以访问，同组或者其他人都没有权限）。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**0000-0777

**默认值：**0777

说明： 在Linux中，文档具有十个属性，其中第一个属性为文档类型，后面九个为权限属性，分别为Owner、Group及Others这三个组别的read、write、execute属性。

文档的权限属性分别简写为r、w、x，这九个属性三个为一组，也可以使用数字来表示文档的权限，对照表如下：

r：4

w：2

x：1

-：0

同一组（owner/group/others）的三个属性是累加的。

例如，-rwxrwx—表示这个文档的权限为：

owner = rwx = 4+2+1 = 7

group = rwx = 4+2+1 = 7

others = — = 0+0+0 = 0

所以其权限为0770。

application_name

**参数说明：**当前连接请求当中，所使用的客户端名称。

该参数属于USERSET类型参数，请参考表1中对应设置方法进行设置。

在备机请求主机进行日志复制时，如果该参数非空串，那么会被用来作为备机在主机上的流复制槽名字。此时，如果该参数长度超过61个字节，那么流复制槽名字只会截取使用前61个字节的字符。

**取值范围：**字符串。

**默认值：**空字符串（连接到后端的应用名，以实际安装为准）

connection_info

**参数说明：**连接数据库的驱动类型、驱动版本号、当前驱动的部署路径和进程属主用户。

该参数属于USERSET类型参数，属于运维类参数，不建议用户设置。

**取值范围：**字符串。

**默认值：**空字符串

说明：

空字符串，表示当前连接数据库的驱动不支持自动设置connection_info参数或应用程序未设置。

驱动连接数据库的时候自行拼接的connection_info参数格式如下：
{"driver_name":"ODBC","driver_version": "(openGauss X.X.X build 13b34b53) compiled at 2020-05-08 02:59:43 commit 2143 last mr 131 debug","driver_path":"/usr/local/lib/psqlodbcw.so","os_user":"omm"}
默认显示driver_name和driver_version，driver_path和os_user的显示由用户控制（参见连接数据库和Linux下配置数据源）。

enable_dolphin_proto

**参数说明：**是否开启dolphin数据库协议功能

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**布尔型

on表示开启dolphin数据库协议。
off表示关闭dolphin数据库协议。

**默认值：**off

说明：
opengauss-server从3.1.0版本后支持多数据库网络协议功能，默认为opengauss数据库协议。
当加载了dolphin插件，并且开启了此参数后，可以通过mysql数据库协议访问opengauss中B兼容类型的数据库。
当前dolphin插件兼容mysql 5.7.x的客户端工具，兼容mysql-connector-java-5.1.47。

dolphin_server_port

**参数说明：**dophin协议插件监听的TCP端口号。

该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。

**取值范围：**整型，1024～65535

**默认值：**3308

说明：
当加载了dophin插件，并且开启了dolphin数据库协议后，可以使用此功能。
设置端口号时，请设置一个未被占用的端口号，不能同opengauss数据库协议的端口号冲突。