更新日期：2024年09月11日
启动 GBase 8s ESQL/C 应用程序之前，在运行时设置 OPTMSG 环境变量，可以为应
用程序中的所有 SQL 语句启用（或禁用）优化的消息传送（消息链接）。
0 禁用优化消息传送。
1 启用优化消息传送并为任何后续连接实现该功能。
缺省值为 0（零），它将显式禁用消息链接。例如，您可能希望对需要即时应答的语
句禁用优化的消息传送以便进行调试，或确保数据库服务器在应用程序终止前处理所有消
息。
GBase 8s SQL 指南：参考
南大通用数据技术股份有限公司 - 191 -
在应用程序内设置 OPTMSG 时，可为每个连接或在每个线程内激活或取消激活优化
消息传送。要启用优化消息传送，必须在建立连接之前设置 OPTMSG。
有关设置 OPTMSG 和定义相关全局变量的更多信息，请参阅 GBase 8s ESQL/C 程
序员手册。
参数参考
set
只修改配置文件中的参数。
check
只检查配置文件中的参数。
reload
表示修改配置文件中的参数，同时发送信号量给数据库进程，使其重新加载配置文件。
encrypt/generate
生成加密密码文件。
-N
需要设置的主机名称。
取值范围：已有主机名称。
当参数取值为ALL 时，表示设置GBase 8c 中所有的主机。
需依赖静态文件，
仅在om 安装的情况下有效，
编译安装由于没有静态文件，
所以无效。
-I INSTANCE-NAME
需要设置的实例名称。
取值范围：已有实例名称。
当参数取值为ALL 时，表示设置主机中所有的实例。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
159
需依赖静态文件，
仅在om 安装的情况下有效，
编译安装由于没有静态文件，
所以无效。
-D
需要执行命令的GBase 8c 实例路径。
使用encrypt 命令时，
此参数表示指定的密码文件
生成的路径。
不能与-I 参数一块使用
-c parameter=value
要设定的GBase 8c 配置参数的名称和参数值。
如果参数是一个字符串变量，则使用-c parameter="'value'"或者使用-c "parameter =
'value'"。
如果需要配置的value 内容中包含双引号, 则需要在双引号前加上转义符。例如
value 为a"b"c，则命令为-c "parameter = 'a\"b\"c’"
当使用gs_guc set/reload 为"log_directory"恢复默认值时，其默认值会被置为具体的
data 目录。
当使用gs_guc reload 进行参数设定，
并指定-N 参数时，
当指定的节点为主节点时，
主备节点的参数值都会被修改；
当指定节点为备节点时，
只会修改备节点的参数值，
不会修改主节点的参数值。
当使用gs_guc reload 进行参数设定，未指定-N 参数时，当在主节点上执行时，主
备节点的参数值都会被修改；当在备节点上执行时，只会修改备节点的参数值，不
会修改主节点的参数值。
取值范围：postgresql.conf 中的所有参数。
--lcname=LCNAME
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
160
要设定的逻辑数据库名称。
该参数必需同-Z NODE-TYPE 一起使用。
即gs_guc 只允许作用于逻辑数据库的DN
实例。
逻辑数据库允许操作的参数同完整数据库不同。具体差异可参见
$GAUSSHOME/bin/cluster_guc.conf。
取值范围：已经创建的逻辑数据库名称。
--ignore-node=NODES
需要忽略的主机名称。
该参数必须与set/reload 一起使用，且-Z 只支持NODE-TYPE。
该参数不支持与-D 一起使用。
在与reload 一起使用时，如果--ignore-node 没有指定主节点，则集群中所有节点的
参数依然会全部同步修改。
-c parameter
当进行check 操作时，表示需要检查的参数名称；当进行set/reload 操作时，参数值不
允许为空，为空时不会恢复为数据库参数的默认值。
-h host-auth-policy
指定需要在“pg_hba.conf”增加的客户端认证策略。
取值范围：
HOSTTYPE DATABASE USERNAME IPADDR IPMASK [authmehod-options]
HOSTTYPE
DATABASE
USERNAME
IPADDR-WITH-IPMASK
[authmehod-options ]
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
161
HOSTTYPE DATABASE USERNAME HOSTNAME [authmehod-options ]
HOSTTYPE 是必选参数，取值：
local
host
hostssl
hostnossl
其中local 是一个Unix 域套接字，host 是普通或SSL 加密的TCP / IP 套接字，hostssl
是SSL 加密的TCP / IP 套接字，hostnossl 是一个纯TCP/IP 套接字。
authmehod-options 是可选输入，取值：
trust
reject
md5
sha256
sm3
cert
gss
详细的参数说明请参见pg_hba.conf 配置文件中的描述。
指定-h 的情况下，
默认会尝试修改所有节点的pg_hba 文件，
但是如果是编译安装，
由于没有静态文件，可以成功修改本节点的pg_hba 文件，但是会提示静态文件不
存在。
-?, --help
显示帮助信息。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
162
-V, --version
显示版本信息。
-M, --keymode=MODE
设定该密码在数据库运行过程中，用于服务端(server)、客户端(client)还是创建Data
Source 对象时调用。
在使用ssl 功能时，会涉及到服务端证书和私钥文件的加密密码和客户端证书和私
钥文件的加密密码，在加密存储加密密码时，
需要指定模式，否则默认是生成服务
端的密码文件。
取值范围：
server（缺省）
client
source
-K PASSWORD
指定需要加密的密码。
取值范围：字符串，符合密码复杂度的要求。
-U, --keyuser=USER
指定要加密的用户，隶属于OS 用户。
GBase 8c 可以为每个用户配置不同的ssl 证书和私钥文件，指定该选项，可以生成
按用户名区分的密码文件。
-S CIPHERKEY
指定需要加密的字符串。
GBase 8c 工具参考手册
南大通用数据技术股份有限公司
163
取值范围：字符串。
-o PREFIX
指定需要输出的OBS 类型的cipher 和rand 文件前缀名称字符串，
默认输出文件名前缀
为obsserver。
取值范围：仅支持数字、字母和下划线。
-Z NODE-TYPE
指定数据库实例节点类型，参数默认值为datanode。NODE-TYPE 用于识别配置文件。
取值范围：coordinator、datanode、gtm。