华为云用户手册

resilience_escape_user_permissions 参数说明：设置用户权限，以逗号分隔，可以设置多个，设置多个则表示多个特殊权限的用户都支持逃生能力，只设置一个则只针对一个特权用户进行逃生。sysadmin控制sysadmin用户的作业是否会被该逃生功能进行cancel处理；monadmin控制monadmin用户的作业是否会被该逃生功能进行cancel处理；默认为空，表示关闭sysadmin和monadmin用户的逃生能力。当前取值仅支持sysadmin，monadmin或者空字符串。 参数类型：字符串 参数单位：无 取值范围：长度大于0的字符串。 该参数目前只支持三个取值：sysadmin，monadmin或""，这几个值的具体含义如下： sysadmin：控制sysadmin用户的作业是否会被该逃生功能进行cancel处理。 monadmin：控制monadmin用户的作业是否会被该逃生功能进行cancel处理。 ""：关闭sysadmin和monadmin用户的逃生能力。 默认值：""，表示关闭sysadmin和monadmin用户的逃生能力。 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。该参数可以同时设置多个值，以逗号分隔，例如resilience_escape_user_permissions = 'sysadmin,monadmin'，也可以只设置一个值，例如resilience_escape_user_permissions = 'monadmin'。 例如，如下命令表示同时开启sysadmin和monadmin用户的逃生功能。 gs_guc reload -Z coordinator -Z datanode -N all -I all -c "resilience_escape_user_permissions='sysadmin,monadmin'" 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。 若该参数多次设置，以最新的设置生效。 该参数设置为取值范围中的任意值，普通用户都支持该逃生功能。 当用户同时具有sysadmin和monadmin时，resilience_escape_user_permissions必须设置为"sysadmin,monadmin"才能触发该用户的逃生功能。

enable_standby_bufferpool 参数说明：启用极致RTO备机读独立缓冲区功能的开关。 参数类型：布尔型 参数单位：无 取值范围： on：表示开启。 off：表示关闭。 默认值：on 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。 启用该功能开关时，开关生效需满足enable_incremental_checkpoint增量检查点打开，且参数standby_shared_buffers_fraction减去参数standby_bufferpool_scale的差值不小于0.1。

standby_bufferpool_scale 参数说明：设置用于开启极致RTO备机读独立缓冲区功能后，独立缓冲区使用shared_buffers内存缓冲区大小的比例。 参数类型：浮点型 参数单位：无 取值范围：0.1-0.9 默认值：0.5 设置方式：该参数属于POSTMASTER类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。 设置不当的风险与影响：若该值设置不合理，会导致刷页速度加快。

max_redo_log_size 参数说明：备DN表示最新日志回放点到最新检查点位置之间日志量的期望值，主DN表示最新日志插入点到最新检查点位置之间日志量的期望值。该参数被用来参与控制检查点刷页速度。 参数类型：整型 参数单位：kB 取值范围：163840～2147483647 默认值：‬1048576 设置方式：该参数属于SIGHUP类型参数，请参考表1中对应设置方法进行设置。 设置建议：推荐使用默认值。关注RTO的情况下，这个值建议不宜过大。 设置不当的风险与影响：请在充分理解参数含义，并经过测试验证后进行修改，避免出现意料之外的结果。

连接池场景 连接池允许应用程序重复使用预先建立的连接，无需每次都重新建立连接。连接一旦创建并放入连接池，应用程序即可重复利用，避免了重复执行完整的连接过程。 这种池化连接的使用可以显著提升性能，尤其对于需要频繁建立和断开连接的中间层应用程序或网络连接的应用程序而言，性能提升尤为明显。 除了性能优势外，连接池架构还能够实现环境中的连接在单个进程中被多个组件共享的目的。这意味着，同一进程中的不同组件可以在不互相干扰的情况下共享连接池中的连接，进一步提高了系统的效率和资源利用率。 在连接池中，打开的连接可能被多个用户重用，如果您的应用程序脚本会更改数据库连接的状态，可能会导致数据泄露，为了安全起见，请谨慎评估使用连接池。 Linux场景配置 在odbcinst.ini配置文件中开启连接池，连接池相关参考配置如下： [ODBC]Pooling=Yes #开启连接池[GaussMPP]CPTimeout=60 #一个连接在连接池中未被重用则会被释放的计时，默认为0，开启连接池需要设置为大于0CPTimeToLive=60 #该驱动下连接池存在的计时[GaussMPP2]CPTimeout=0 #关闭连接池 Windows场景配置 在打开的驱动管理器上，选择“连接池”后双击“ GaussDB Unicode”驱动名称，选择“使用池连接此驱动程序”[默认为60s]，该设置参数同Linux场景配置的CPTimeout，参考例图如下： 在应用程序中配置连接池参数，需要在环境句柄创建前通过调用SQLSetEnvAttr 设置连接池参数，其中的环境句柄应设置为 null，这使得 SQL_ATTR_CONNECTION_POOLING 成为进程级属性。目前在Windows上支持配置SQL_ATTR_CONNECTION_POOLING为以下两种值： SQL_CP_OFF：默认参数设置，禁用连接池。 SQL_CP_ONE_PER_DRIVER：开启连接池，每个驱动支持一个连接池，驱动其中的所有连接共享一个池。 应用程序调用 SQLConnect 或 SQLDriverConnect 时，会从连接池中提取连接，如果连接已超时，或者池中没有与请求匹配的连接，则会打开一个新连接，连接池对调用应用程序是透明的。 应用程序调用 SQLDisconnect 时，链接不会被释放，而是会将连接放回连接池用于下一次使用。 在环境上调用 SQLFreeHandle释放环境句柄前，应用程序成功为环境设置的所有环境属性都会持续存在。 应用程序的连接在一段时间内处于非活动状态（未在连接中使用），则会从池中删除该连接。连接池的大小仅受内存限制和服务器限制。

日志诊断场景 ODBC日志分为unixODBC驱动管理器日志和gsqlODBC驱动端日志。前者可以用于追溯应用程序API的执行成功与否，后者是底层实现过程中的一些DFX日志，用来帮助定位问题。 unixODBC日志需要在odbcinst.ini文件中配置： 1234567 [ODBC]Trace=YesTraceFile=/path/to/odbctrace.log[GaussMPP]Driver64=/usr/local/lib/gsqlodbcw.sosetup=/usr/local/lib/gsqlodbcw.so gsqlODBC日志只需要在odbc.ini加上如下内容： [gaussdb]Driver=GaussMPPServername=10.10.0.13 #数据库Server IP...Debug=1 #打开驱动端debug日志 unixODBC日志将会生成在TraceFile配置的路径下，gsqlODBC会在系统/tmp/下生成mylog_xxx.log。

负载均衡场景 当应用程序有大并发场景时可开启负载均衡： 负载均衡即为将并发连接随机分发到所有CN上，避免单个CN负载过大，达到提高性能的目的。 配置参数AutoBalance=1，开启负载均衡功能。 参数RefreshCNListTime=5可以选择性配置，默认刷新时间为10s。 参数Priority=1可以选择性配置，即为并发连接优先发送到配置文件中配置的CN上，当配置的CN全部不可连接时，连接才会被分发到剩余CN上。 示例场景： 集群环境有6个CN，CN1、CN2、CN3、CN4、CN5和CN6；配置文件配置4个CN，为CN1、CN2、CN3和CN4。 odbc.ini配置文件示例： [gaussdb]Driver=GaussMPPServername=10.145.130.26,10.145.130.27,10.145.130.28,10.145.130.29 #数据库Server IP。Database=db1 #数据库名称。Username=omm #数据库用户名。Password= #数据库用户密码。Port=8000 #数据库侦听端口。Sslmode=allowAutoBalance=1RefreshCNListTime=3Priority=1 当配置文件和集群环境如示例时，并发连接会随机、平均发送到CN1、CN2、CN3和CN4上，连接数均衡。当CN1、CN2、CN3和CN4全部不可用时，并发连接会随机、平均发送到CN5和CN6上。如果此时CN1、CN2、CN3和CN4中有CN重新可用时，连接则不会再发送到CN5和CN6上，而是重新发送到重新可用的CN上。

备机读场景 配置文件配置CN节点，设置StandbyRead=1开启分布式备机读模式。 odbc.ini配置文件示例： [gaussdb]Driver=GaussMPPServername=10.145.130.26,10.145.130.27,10.145.130.28,10.145.130.29 #数据库Server IP。Database=db1 #数据库名称。Username=omm #数据库用户名称。Password= #数据库用户密码。Port=8000 #数据库侦听端口。StandbyRead=1 #打开备机读模式。Sslmode=allowAutoBalance=1 #开启负载均衡模式。

常见问题处理 connect to server failed: no such file or directory 此问题可能的原因： 配置了错误的/不可达的数据库地址，或者端口 请检查数据源配置中的Server及Port配置项。 服务器侦听不正确 如果确认Server及Port配置正确，请根据“操作步骤”中数据库服务器的相关配置，确保数据库侦听了合适的网卡及端口。 防火墙及网闸设备 请确认防火墙设置，将数据库的通信端口添加到可信端口中。 如果有网闸设备，请确认相关的设置。 The password-stored method is not supported. 此问题可能原因： 数据源中未配置sslmode配置项，请调整此项至allow或以上级别，允许SSL连接，此选项的更多说明，请参见表1。 authentication method 10 not supported. 使用开源客户端碰到此问题，可能原因： 数据库中存储的密码校验只存储了SHA256格式哈希，而开源客户端只识别MD5校验，双方校验方法不匹配报错。 数据库并不存储用户密码，只存储用户密码的哈希码。 当用户更新用户密码或者新建用户时，数据库会同时存储两种格式的哈希码，这时将兼容开源的认证协议。 当旧版本升级到新版本时，由于哈希的不可逆性，所以数据库无法还原用户密码，进而生成新格式的哈希，所以仍然只保留了SHA256格式的哈希，导致仍然无法使用MD5做密码认证。 MD5加密算法安全性低，存在安全风险，建议使用更安全的加密算法。 要解决该问题，可以更新用户密码（请参见ALTER USER），或者新建一个用户（请参见CREATE USER），赋予同等权限，使用新用户连接数据库。 unsupported frontend protocol 3.51: server supports 1.0 to 3.0 目标数据库版本过低，或者目标数据库为开源数据库。请使用对应版本的数据库驱动连接目标数据库。 FATAL: GSS authentication method is not allowed because XXXX user password is not disabled. 目标CN的gs_hba.conf里配置了当前客户端IP使用"gss"方式来做认证，该认证算法不支持用作客户端的身份认证，请修改到"sha256"后再试。

常见问题处理 [UnixODBC][Driver Manager]Can't open lib 'xxx/xxx/gsqlodbcw.so':file not found. 此问题的可能原因： odbcinst.ini文件中配置的路径不正确 确认的方法：执行ls命令查询错误信息中的路径，以确保该gsqlodbcw.so文件存在，同时具有执行权限。 gsqlodbcw.so的依赖库不存在，或者不在系统环境变量中 确认的方法：执行ldd命令查询错误信息中的路径，如果是缺少libodbc.so.1等UnixODBC的库，那么按照“操作步骤”中的方法重新配置UnixODBC，并确保它的安装路径下的lib目录添加到了LD_LIBRARY_PATH中。如果重装仍无法解决，可以手动将数据库安装包下的unixodbc/lib下的内容复制到UnixODBC的安装路径下的lib目录。如果是缺少其他库，请将ODBC驱动包中的lib目录添加到LD_LIBRARY_PATH中。如果缺少其他标准库，请自行安装。 [UnixODBC]connect to server failed: no such file or directory 此问题的可能原因： 配置了错误的/不可达的数据库地址，或者端口 请检查数据源配置中的Servername及Port配置项。 服务器侦听不正确 如果确认Servername及Port配置正确，请根据“操作步骤”中数据库服务器的相关配置，确保数据库侦听了合适的网卡及端口。 防火墙及网闸设备 请确认防火墙设置，将数据库的通信端口添加到可信端口中。 如果有网闸设备，请确认相关的设置。 [unixODBC]The password-stored method is not supported. 此问题的可能原因： 数据源中未配置sslmode配置项。 解决办法： 请配置该选项至allow或以上选项。此配置的更多信息，请参见表3。 Server common name "xxxx" does not match host name "xxxxx" 此问题的可能原因： 使用了SSL加密的“verify-full”选项，驱动程序会验证证书中的主机名与实际部署数据库的主机名是否一致。 解决办法： 碰到此问题可以使用“verify-ca”选项，不再校验主机名，或者重新生成一套与数据库所在主机名相同的服务端证书。 Driver's SQLAllocHandle on SQL_HANDLE_DBC failed 此问题的可能原因： 可执行文件（比如UnixODBC的isql，以下都以isql为例）与数据库驱动（gsqlodbcw.so）依赖于不同的ODBC的库版本：libodbc.so.1或者libodbc.so.2。此问题可以通过如下方式确认： ldd `which isql` | grep odbcldd gsqlodbcw.so | grep odbc 这时，如果输出的libodbc.so最后的后缀数字不同或者指向不同的磁盘物理文件，那么基本就可以断定是此问题。isql与gsqlodbcw.so都会要求加载libodbc.so，这时如果它们加载的是不同的物理文件，便会导致两套完全同名的函数列表，同时出现在同一个可见域里（UnixODBC的libodbc.so.*的函数导出列表完全一致），产生冲突，无法加载数据库驱动。 解决办法： 确定一个要使用的UnixODBC，卸载另外一个（比如卸载库版本号为.so.2的UnixODBC），然后将剩下的.so.1的库，新建一个同名但是后缀为.so.2的软链接，便可解决此问题。 FATAL: Forbid remote connection with trust method! 由于安全原因，数据库CN禁止集群内部其他节点无认证接入。 如果要在集群内部访问CN，请将ODBC程序部署在CN所在机器，服务器地址使用"127.0.0.1"。建议业务系统单独部署在集群外部，否则可能会影响数据库运行性能。 [unixODBC][Driver Manager]Invalid attribute value 在使用SQL on other GaussDB功能时碰到此问题，有可能是unixODBC的版本并非推荐版本，建议通过“odbcinst --version”命令排查环境中的unixODBC版本。 authentication method 10 not supported. 使用开源客户端碰到此问题，可能原因： 数据库中存储的密码校验只存储了SHA256格式哈希，而开源客户端只识别MD5校验，双方校验方法不匹配报错。 数据库并不存储用户密码，只存储用户密码的哈希码。 当用户更新用户密码或者新建用户时，数据库会同时存储两种格式的哈希码，这时将兼容开源的认证协议。 当旧版本数据库升级到新版本时，由于哈希的不可逆性，数据库无法还原用户密码，进而生成新格式的哈希，所以仍然只保留了SHA256格式的哈希，导致仍然无法使用MD5做密码认证。 MD5加密算法安全性低，存在安全风险，建议使用更安全的加密算法。 要解决该问题，可以更新用户密码（请参见ALTER USER），或者新建一个用户（请参见CREATE USER），赋予同等权限，使用新用户连接数据库。 unsupported frontend protocol 3.51: server supports 1.0 to 3.0 目标数据库版本过低，或者目标数据库为开源数据库。 请使用对应版本的数据库驱动连接目标数据库。 FATAL: GSS authentication method is not allowed because XXXX user password is not disabled. 目标CN的gs_hba.conf里配置了当前客户端IP使用"gss"方式来做认证，该认证算法不支持用作客户端的身份认证，请修改到"sha256"后再试。 isql：error while loading shared libraries:xxx 环境缺少该动态库，需要自行安装对应的库。

关闭连接 ODBC关闭数据库连接，释放资源相关API如表1所示。 表1 相关API说明 功能 API 断开与数据源的连接 SQLDisconnect 释放句柄资源 SQLFreeHandle：释放句柄资源，可替代如下函数： SQLFreeEnv：释放环境句柄 SQLFreeConnect：释放连接句柄 SQLFreeStmt：释放语句句柄 示例如下（完整示例请参考获取和处理数据库中的数据）： // 断开数据源连接并释放句柄资源。SQLFreeHandle(SQL_HANDLE_STMT,V_OD_hstmt); SQLDisconnect(V_OD_hdbc); SQLFreeHandle(SQL_HANDLE_DBC,V_OD_hdbc); SQLFreeHandle(SQL_HANDLE_ENV, V_OD_Env); 父主题： 开发步骤

PG_STAT_ACTIVITY PG_STAT_ACTIVITY视图显示和当前用户查询相关的信息，字段保存的是上一次执行的信息。具体字段信息如表1所示。 表1 PG_STAT_ACTIVITY字段 名称 类型 描述 datid oid 用户会话在后台连接到的数据库OID。 datname name 用户会话在后台连接到的数据库名称。 pid bigint 后台线程id。 sessionid bigint 会话id。 usesysid oid 登录该后台的用户OID。 usename name 登录该后台的用户名。 application_name text 连接到该后台的应用名。 client_addr inet 连接到该后台的客户端的IP地址。 如果此字段是null，它表明通过服务器机器上UNIX套接字连接客户端或者这是内部线程，如autovacuum。 client_hostname text 客户端的主机名，这个字段是通过client_addr的反向DNS查找得到。这个字段只有在启动log_hostname且使用IP连接时才非空。 client_port integer 客户端用于与后台通讯的TCP端口号，如果使用Unix套接字，则为-1。 backend_start timestamp with time zone 该会话开始的时间，即客户端连接服务器的时间。 xact_start timestamp with time zone 当前活跃事务开始的时间，如果没有事务是活跃的，则为null。如果当前查询是首个事务，则这列等同于query_start列。 query_start timestamp with time zone 当前活跃查询开始的时间， 如果state的值不是active，则这个值是上一个查询的开始时间。如果是存储过程、或函数或package，则显示的是第一个查询时间，不会随着存储过程内语句运行而改变。 state_change timestamp with time zone 上次状态改变的时间。 waiting boolean 如果后台当前正等待锁则为true。否则为false。 enqueue text 语句当前排队状态。可能值是： waiting in queue：表示语句在排队中。 空：表示语句正在运行。 state text 该后台当前总体状态。可能值是： active：后台正在执行一个查询。 idle：后台正在等待一个新的客户端命令。 idle in transaction：后台在事务中，但事务中没有语句在执行。 idle in transaction (aborted)：后台在事务中，但事务中有语句执行失败。 fastpath function call：后台正在执行一个fast-path函数。 disabled：如果后台禁用track_activities，则报告这个状态。 说明： 普通用户只能查看到自己账户所对应的会话状态。即其他账户的state信息为空。例如以judy用户连接数据库后，在pg_stat_activity中查看到的普通用户joe及初始用户omm的state信息为空： SELECT datname, usename, usesysid, state,pid FROM pg_stat_activity; datname | usename | usesysid | state | pid----------+---------+----------+--------+----------------- testdb | omm | 10 | | 139968752121616 testdb | omm | 10 | | 139968903116560 db_tpcds | judy | 16398 | active | 139968391403280 testdb | omm | 10 | | 139968643069712 testdb | omm | 10 | | 139968680818448 testdb | joe | 16390 | | 139968563377936(6 rows) resource_pool name 用户使用的资源池。 query_id bigint 查询语句的id。 query text 该后台的最新查询。如果state状态是active（活跃的），此字段显示当前正在执行的查询。所有其他情况表示上一个查询。 connection_info text json格式字符串，记录当前连接数据库的驱动类型、驱动版本号、当前驱动的部署路径、进程属主用户等信息（参见GUC参数connection_info）。 global_sessionid text 全局的会话id。 unique_sql_id bigint 语句的unique sql id。 trace_id text 驱动传入的trace id，与应用的一次请求相关联。 top_xid xid 事务的顶层事务id。 current_xid xid 事务的当前事务id。 xlog_quantity bigint 事务当前使用的X LOG 量，单位为字节。 父主题： 其他系统视图

GS_WORKLOAD_RULE_STAT GS_WORKLOAD_RULE_STAT系统视图记录SQL限流规则相关的信息。只有具有sysadmin权限的用户才可以访问此系统视图。 表1 GS_WORKLOAD_RULE_STAT字段 名称 类型 描述 rule_id bigint 限流规则ID。 rule_name name 限流规则的名称，用于检索限流规则。 databases name[] 限流规则作用的数据库列表，为NULL表示对所有库生效。 rule_type text 限流规则类型，当前仅支持：“sqlid”、“select”、“insert”、“update”、“delete”、“merge”、“resource”，其他取值为非法值。 start_time timestamp with time zone 限流规则开始的时间，为NULL表示从现在开始生效。 end_time timestamp with time zone 限流规则结束的时间，为NULL表示一直生效。 max_workload bigint 限制规则设置的最大并发数。 option_val text[] 限流规则的参数值，包括：sqlid，关键字列表，资源限制情况。 详细请参见gs_add_workload_rule接口说明。 is_valid boolean 限流规则是否生效，超时的限流规则会设为false。 validate_count bigint 限流规则拦截SQL的次数。 node_names text[] 预留字段，限流规则生效的节点名称列表，当前不生效。 user_names text[] 预留字段，限流规则生效的用户名称列表，当前不生效。 父主题： 系统视图

示例 --创建一个无用的外部数据封装器dummy。gaussdb=# CREATE FOREIGN DATA WRAPPER dummy;--创建一个带有处理器函数file_fdw_handler 的外部数据封装器file。gaussdb=# CREATE FOREIGN DATA WRAPPER file HANDLER file_fdw_handler;--创建一个带有一些选项的外部数据封装器mywrapper。gaussdb=# CREATE FOREIGN DATA WRAPPER mywrapper OPTIONS (debug 'true');

参数说明 name 要创建的外部数据封装器的名字 HADNLER handler_function handler_function是先前已经注册了的函数的名字，用来为外部表检索执行函数。 处理器函数必须没有参数，并且它的返回类型必须为fdw_handler。 不用处理器函数创建外部数据封装器是可能的，但是使用这种封装器的外部表只能被声明，不能被访问。 VALIDATOR validator_function validator_function 是先前已经注册了的函数的名字用来检查提供给外部数据封装器的通用选项， 还有使用该外部数据封装器的外部服务器、用户映射和外部表的选项。 如果没有验证器函数或声明了NO VALIDATOR， 那么在创建时将不检查选项。（外部数据封装器可能在运行时忽略或拒绝无效的选项说明， 取决于实现。）验证器函数必须接受两个参数：一个类型为text[]， 将包含存储在系统目录中的选项的数组，一个类型为oid， 是包含这些选项的系统目录的OID。忽略返回类型；该函数应该使用 ereport(ERROR)函数报告无效选项。 OPTIONS ( option 'value' [, ... ] ) 这个子句为新的外部数据封装器声明选项。允许的选项名和值是特定于每个外部数据封装器的， 并且是经过外部数据封装器的验证器函数验证了的。选项名必须是唯一的。

示例 --修改一个外部数据封装dbi，增加选项foo，删除bargaussdb=# ALTER FOREIGN DATA WRAPPER dbi OPTIONS (ADD foo '1', DROP 'bar');--修改外部数据封装dbi验证器为bob.myvalidatorgaussdb=# ALTER FOREIGN DATA WRAPPER dbi VALIDATOR bob.myvalidator;

GS_GLOBAL_ARCHIVE_STATUS GS_GLOBAL_ARCHIVE_STATUS视图描述CN和所有分片的归档进度，获取分片名称（node_name）、归档位置（restart_lsn）、实际进行归档的主/备机名称（archive_node）和当前日志位置（current_xlog_location）。查询此视图需要数据库开启归档功能，并从CN节点进行查询，需要monitor admin和sysadmin权限。 表1 GS_GLOBAL_ARCHIVE_STATUS字段 名称 类型 描述 node_name text 分片名称。 restart_lsn text 归档位置。 archive_node text 实际进行归档的主/备机名称。 current_xlog_location text 当前日志位置。 父主题： 系统视图

语法格式 设置外部数据封装属性 ALTER FOREIGN DATA WRAPPER name[ HANDLER handler_function | NO HANDLER ][ VALIDATOR validator_function | NO VALIDATOR ][ OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ]) ]; 设置新的所有者 ALTER FOREIGN DATA WRAPPER name OWNER TO new_owner; 设置新的名称 ALTER FOREIGN DATA WRAPPER name RENAME TO new_name;

参数说明 name 已有外部数据封装的名字。 HANDLER handler_function 为外部数据封装指定一个新的处理函数。 NO HANDLER 这个参数用来指定外部数据封装不再拥有处理函数。 使用外部数据封装但没有handler的外表不能访问。 VALIDATOR validator_function 为外部数据封装指定一个新的验证函数。 根据新的验证器，外部数据封装器或依赖的服务器、 用户映射或外部表的已经存在的选项是有可能是无效的。用户在使用外部数据封装之前需要保证这些选项是正确的。 不过，ALTER FOREIGN DATA WRAPPER 命令中指定的任何选项都将使用新的验证函数检查。 NO VALIDATOR 这个用来指定外部数据封装不再有验证函数。 OPTIONS ( [ ADD | SET | DROP ] option ['value'] [, ... ] ) 修改外部数据封装的选项。 ADD, SET, 和 DROP 指定表现的动作。如果没有明确指定操作默认是ADD。选项名必须唯一。 使用外部数据封装验证函数时，名字和取值也会被验证。 new_owner 外部数据封装新的所有者的用户名。 new_name 外部数据封装的新名称。

GS_WORKLOAD_RULE GS_WORKLOAD_RULE系统表存储与SQL限流规则相关的信息。该系统表没有权限限制，所有用户可查询。 表1 GS_WORKLOAD_RULE字段 名称 类型 描述 rule_id bigint 限流规则标识列，系统自动生成。 rule_name name 限流规则的名称，用于检索限流规则，不保证唯一性，可以为NULL。 databases name[] 限流规则作用的数据库列表，为NULL表示所有库生效。 max_workload bigint 限制规则设置的最大并发数。 is_valid boolean 限流规则是否生效，超时的限流规则会设为false。 start_time timestamp with time zone 限流规则开始的时间，为NULL表示从现在开始生效。 end_time timestamp with time zone 限流规则结束的时间，为NULL表示一直生效。 rule_type text 限流规则类型，当前仅支持：“sqlid”、“select”、“insert”、“update”、“delete”、“merge”、“resource”，其他的为非法值。 option_val text[] 限流规则的参数值，包括：sqlid，关键字列表，资源限制情况。 详细请参见gs_add_workload_rule接口说明。 node_names text[] 预留字段，限流规则生效的节点名称列表，当前不生效。 user_names text[] 预留字段，限流规则生效的用户名称列表，当前不生效。 父主题： 系统表

SQL限流函数 gs_add_workload_rule(rule_type, rule_name, databases, start_time, end_time, max_workload, option_val) 描述：创建一条SQL限流规则。需要具有sysadmin权限的用户才可执行。只支持在CN节点上执行。 参数：参数介绍请参见表1。 返回值类型：int8 表1 gs_add_workload_rule参数说明 参数名称 类型 描述 取值范围 rule_type text 限流规则类型，不区分大小写。 “sqlid”：根据Unique SQL ID进行限流； “select”、“insert”、“update”、“delete”、“merge”：根据查询类型和关键字进行限流； “resource”：根据系统资源利用率进行实例级别的限流。 rule_name name 限流规则名称，用于检索限流规则。 任意字符串，可以为NULL。 databases name[] 限流规则生效的数据库名称数组，区分大小写。 数据库名列表，必须为已创建的数据库名。可以为NULL，表示所有数据库生效。 目前只有指定rule_type为查询类型时，数据库列表才生效，因为Unique SQL ID本身是与库进行绑定的，其只属于某个库；而根据资源利用率的限流规则是对实例生效的，即对所有库生效。 start_time timestamptz 限流规则生效的开始时间。 可以为NULL，表示从当前时间开始生效。 end_time timestamptz 限流规则生效的结束时间。 可以为NULL，表示规则一直生效。 max_workload int8 限流规则设置的最大并发数。 - option_val text[] 限流规则的补充信息。 与rule_type匹配，具体匹配关系如下： “sqlid”：要限流的Unique SQL ID，以及慢SQL管控规则，格式为'{id=1234, time_limit=100, max_execute_time=500, max_iops=1}'，其中id值为Unique SQL ID，为必选项，可通过dbe_perf.statement或者pg_stat_activity视图获取。其他选项非必选，其含义参考慢SQL管控规则的Hint； “select”、“insert”、“update”、“delete”、“merge” ：要限流的关键字序列，不区分大小写，可以为NULL； “resource” ：要限流的资源阈值，形式为'{cpu-80, memory-70}'。当前cpu和memory无论设置为多少，都当成"0"处理。 示例： 1 2 3 4 5 6 7 8 9101112131415161718192021 gaussdb=# select gs_add_workload_rule('sqlid', 'rule for one query', '{}', now(), NULL, 20, '{id=32413214}'); gs_add_workload_rule ---------------------- 1(1 row)gaussdb=# create database db1;gaussdb=# create database db2;gaussdb=# select gs_add_workload_rule('select', 'rule for select', '{db1, db2}', NULL, NULL, 100, '{tb1, tb2}'); gs_add_workload_rule ---------------------- 2(1 row)gaussdb=# select gs_add_workload_rule('resource', 'rule for resource', '{}', NULL, NULL, 20, '{cpu-80}'); gs_add_workload_rule ---------------------- 3(1 row)gaussdb=# drop database db1;DROP DATABASEgaussdb=# drop database db2;DROP DATABASE gs_update_workload_rule(rule_id, rule_name, databases, start_time, end_time, max_workload, option_val) 描述：更新一条SQL限流规则，需要重新设置全部参数，不支持只指定部分参数。需要具有sysadmin权限的用户才可执行。只支持在CN节点上执行。 参数：参数介绍请参见表2。 返回值类型：boolean 表2 gs_update_workload_rule参数说明 参数名称 类型 描述 取值范围 rule_id int8 要更新的限流规则ID。 - rule_name name 限流规则名称，用于检索限流规则。 任意字符串，可以为NULL。 databases name[] 限流规则生效的数据库名称数组，区分大小写。 数据库名列表，必须为已创建的数据库名。可以为NULL，表示所有数据库生效。 目前只有指定rule_type为查询类型时，数据库列表才生效，因为Unique SQL ID本身是与库进行绑定的，其只属于某个库；而根据资源利用率的限流规则是对实例生效的，即对所有库生效。 start_time timestamptz 限流规则生效的开始时间。 可以为NULL，表示从当前时间开始生效。 end_time timestamptz 限流规则生效的结束时间。 可以为NULL，表示规则一直生效。 max_workload int8 限流规则设置的最大并发数。 - option_val text[] 限流规则的补充信息。 与rule_type匹配，具体匹配关系如下： “sqlid”：要限流的Unique SQL ID，以及慢SQL管控规则，格式为'{id=1234, time_limit=100, max_execute_time=500, max_iops=1}'，其中id值为Unique SQL ID，为必选项，可通过dbe_perf.statement或者pg_stat_activity视图获取。其他选项非必选，其含义参考慢SQL管控规则的Hint； “select”、“insert”、“update”、“delete”、“merge”：要限流的关键字序列，不区分大小写，可以为NULL； “resource”：要限流的资源阈值，形式为'{cpu-80, memory-70}'，表示触发实例级别限流的操作系统资源阈值，可以为NULL，表示不管资源利用率直接进行限流。 示例： 12345678 gaussdb=# create database db1;gaussdb=# select gs_update_workload_rule(2, 'rule for select 2', '{db1}', now(), NULL, 50, '{tb1}'); gs_update_workload_rule ------------------------- t(1 row)gaussdb=# drop database db1;DROP DATABASE gs_delete_workload_rule(rule_id) 描述：删除一条SQL限流规则。需要具有sysadmin权限的用户才可执行。只支持在CN节点上执行。 参数：rule_id，要更新的限流规则ID，类型为int8 返回值类型：boolean 示例： 12345 gaussdb=# select gs_delete_workload_rule(3); gs_delete_workload_rule ------------------------- t(1 row) gs_get_workload_rule_stat(rule_id) 描述：查询SQL限流规则拦截SQL的次数。需要具有sysadmin权限的用户才可执行。只支持在CN节点上执行。 参数：rule_id，要查询的限流规则ID，类型为int8。可以指定rule_id为-1，此时表示查询所有的SQL限流规则。 返回值类型： 名称 类型 描述 rule_id int8 SQL限流规则的ID。 validate_count int8 SQL限流规则拦截SQL的次数。 示例： 1 2 3 4 5 6 7 8 91011 gaussdb=# select * from gs_get_workload_rule_stat(1); rule_id | validate_count ---------+---------------- 1 | 0(1 row)gaussdb=# select * from gs_get_workload_rule_stat(-1); rule_id | validate_count ---------+---------------- 1 | 0 2 | 0(2 rows) 父主题： 系统管理函数

数组类型的字符串输出 一个数组值的输出表现形式由该数组元素类型的输出再加上一些标明该数组结构的修饰组成。这些修饰由围绕在数组值周围的花括号（“{” 和“}”）加上相邻项之间的分隔字符组成。在多维数组里， 每个维都有自己级别的花括号，并且在同级相邻的花括号项之间包含分隔符。 数组类型数据包含特殊字符（下述说明中的字符），字符串输出示例： gaussdb=# SELECT ARRAY['{', '}', 'hello, world', '"', '\', ' ', NULL] AS RESULT; array ---------------------------------------------- {"{","}","hello, world","\"","\\"," ",NULL}(1 row) 对于数组字符串常量输出，如果数组元素值是空字符串或者包含花括号、分隔符、双引号、反斜杠、空白或者元素为NULL，则这些元素输出时会输出双引号中，双引号和反斜杠则会被反斜杠转义额外输出一个反斜杠。与字符串常量输入相对应。

数组类型的字符串输入 要把一个数组值写成一个文字常数（常量输入），将元素值用花括号括起并用逗号分隔。因此，一个数组常量的一般格式如下： '{ val1 delim val2 delim ... }' 上述格式中的delim是元素类型的分隔符，记录在类型的pg_type表的typdelim列中。每个val可以是数组元素类型的一个常量，也可以是一个子数组。示例如下： gaussdb=# SELECT '{1, 2, 3}'::int[] AS RESULT; result --------- {1,2,3}(1 row)gaussdb=# SELECT '{{1, 2, 3}, {4, 5, 6}, {7, 8, 9}}'::int[] AS RESULT; result --------------------------- {{1,2,3},{4,5,6},{7,8,9}}(1 row) 在任意元素值周围可以使用双引号，并且在元素值包含逗号或花括号等一些特殊字符时必须使用双引号。示例如下： gaussdb=# SELECT '{" ", "NULL", null, "\\", "{", "}", ","}'::varchar[] AS RESULT; result ------------------------------------ {" ","NULL",NULL,"\\","{","}",","}(1 row)-- 该示例表示有一个varchar类型的数组，且一共有7个varchar元素，元素依次为： 1、包含一个空格的字符串 2、值为“NULL”的字符串 3、字符串为NULL 4、有一个\字符的字符串 5、有一个{字符的字符串 6、有一个}字符的字符串 7、有一个,字符的字符串 对于数组字符串常量输入，如果数组元素值是空字符串或者包含花括号、分隔符、双引号、反斜杠、空白或者匹配关键字NULL，则这些元素输入需要使用双引号，在元素值里包含的双引号和反斜杠时需要额外添加一个反斜杠。 关键字NULL不区分大小写。 输入会自动跳过没有使用双引号的空白。 一般不建议使用字符常量的方式构造数组数据，推荐使用ARRAY构造器。

数组类型的定义 一个数组数据类型一般通过在数组元素的数据类型名称后面加上方括号（[]）来命名。 示例一，创建一个名为sal_emp的表，它有一个表示雇员姓名类型为text的列（name），一个表示雇员季度工资的数组且元素类型为integer的列（pay_by_quarter），一个表示雇员手机号码的数组且元素类型为varchar(11)的列（phone_numbers）： gaussdb=# CREATE TABLE sal_emp ( name text, pay_by_quarter integer[], phone_numbers varchar(11)[] );gaussdb=# DROP TABLE sal_emp; 示例二，其他方式定义一个数组类型，具体定义方法和定义行为参考示例中的注释： gaussdb=# CREATE TABLE sal_emp ( name text, pay_by_quarter1 integer[][], -- int类型的二维数组 pay_by_quarter2 integer[3], -- int类型的一维数组，尺寸大小为3 pay_by_quarter3 integer[3][3], -- int类型的二维数组，每一维尺寸大小为3 pay_by_quarter4 integer ARRAY, -- int类型的一维数组 pay_by_quarter5 integer ARRAY[3] -- int类型的一维数组，尺寸大小为3);gaussdb=# DROP TABLE sal_emp; 数组的维数定义功能并不生效（不影响运行时的行为），建议采用示例一的方式定义数组类型，并且不建议使用多维数组数据。 数组的尺寸定义功能并不生效（不影响运行时的行为），建议采用示例一的方式定义数组类型。 允许的数组数据维数最大为6。 数组元素个数限制如下： 元素个数最大为134217727个。 所有元素加起来最大存储空间不超过1GB - 1字节即1073741823字节。

数组类型的使用 数组类型的使用示例如下： -- 创建有数组类型列的表,并插入一些数据gaussdb=# CREATE TABLE orders ( name varchar, items varchar[]);gaussdb=# INSERT INTO orders VALUES('a', ARRAY['苹果', '橘子', '梨']);gaussdb=# INSERT INTO orders VALUES('b', ARRAY['矿泉水', '可乐', '雪碧']);gaussdb=# INSERT INTO orders VALUES('c', ARRAY['鼠标', '键盘', '耳机']);gaussdb=# INSERT INTO orders VALUES('d', '{白菜, 土豆, 茄子}');-- 查询数据gaussdb=# SELECT * FROM orders ORDER BY name; name | items ------+-------------------- a | {苹果,橘子,梨} b | {矿泉水,可乐,雪碧} c | {鼠标,键盘,耳机} d | {白菜,土豆,茄子}(4 rows)-- 访问数组元素gaussdb=# SELECT items[1] FROM orders ORDER BY name; items -------- 苹果 矿泉水 鼠标 白菜(4 rows)-- 访问元素超过范围或者访问下标为NULL时会返回NULLgaussdb=# SELECT items[4] FROM orders ORDER BY name; items -------(4 rows)gaussdb=# SELECT items[null] FROM orders ORDER BY name; items -------(4 rows)-- 访问子数组gaussdb=# SELECT items[1:2] FROM orders ORDER BY name; items --------------- {苹果,橘子} {矿泉水,可乐} {鼠标,键盘} {白菜,土豆}(4 rows)-- 更新整个数组gaussdb=# UPDATE orders SET items = ARRAY['香蕉', '西瓜', '草莓'] WHERE name = 'a';gaussdb=# SELECT items FROM orders WHERE name = 'a'; items ------------------ {香蕉,西瓜,草莓}(1 row)-- 更新数组的元素gaussdb=# UPDATE orders SET items[1] = '芒果' WHERE name = 'a';gaussdb=# SELECT items FROM orders WHERE name = 'a'; items ------------------ {芒果,西瓜,草莓}(1 row)-- 更新数组的元素片段gaussdb=# UPDATE ORDERS SET items[1:2] = ARRAY['电脑', '手机'] WHERE name = 'c';gaussdb=# SELECT items FROM ORDERS WHERE name = 'c'; items ------------------ {电脑,手机,耳机}(1 row)-- 添加数组元素，所有位于原数组最后一个元素和这个新元素之间的未赋值元素都将设为 NULLgaussdb=# UPDATE orders SET items[4] = '显示器' WHERE name = 'c';gaussdb=# SELECT items FROM orders WHERE name = 'c'; items ------------------------- {电脑,手机,耳机,显示器}(1 row)gaussdb=# UPDATE orders SET items[6] = '显示器2' WHERE name = 'c';gaussdb=# SELECT items FROM orders WHERE name = 'c'; items -------------------------------------- {电脑,手机,耳机,显示器,NULL,显示器2}(1 row)gaussdb=# DROP TABLE orders;

数组构造器 数组构造器是一个能构建数组值的表达式。简单的数组构造器由关键词ARRAY、“[”、用于数组元素值的表达式列表（用逗号分隔）以及最后的“]”组成。示例如下： gaussdb=# SELECT ARRAY[1, 2, 3 + 4]; array --------- {1,2,7}(1 row) 默认情况下，数组的元素类型是成员表达式的公共类型，使用和UNION或CASE结构（UNION，CASE和相关构造）相同的规则决定。可以通过显式类型转换将数组构造为想要的数据类型，示例如下： gaussdb=# SELECT ARRAY[1, 2, 3]::varchar[]; array --------- {1,2,3}(1 row)gaussdb=# SELECT ARRAY['a', 'b', 'c']::varchar[]; array --------- {a,b,c}(1 row) 除预置的基础类型外，表类型也可以定义其数组类型，示例： gaussdb=# CREATE TYPE rec IS (c1 int, c2 int);gaussdb=# SELECT ARRAY[(1, 1), (2, 2)]::rec[]; array ------------------- {"(1,1)","(2,2)"}(1 row)gaussdb=# CREATE TABLE tab (c1 int, c2 int);gaussdb=# SELECT ARRAY[(1, 1), (2, 2)]::tab[]; array ------------------- {"(1,1)","(2,2)"}(1 row)gaussdb=# DROP TYPE rec;gaussdb=# DROP TABLE tab; 因为数组必须得有类型，因此在构造一个空数组时，必须明确的将其构造成需要的类型，示例： gaussdb=# SELECT ARRAY[]::int[]; array ------- {}(1 row) 也可以从子查询的结果中构造一个数组。此时，数组构造器是关键字ARRAY后跟着用圆括号括起来的子查询，子查询必须只返回一个单独的字段。生成的一维数组将为子查询里每行结果生成一个元素，元素类型匹配子查询的输出字段。示例： gaussdb=# SELECT ARRAY(SELECT generate_series(1, 6)); array --------------- {1,2,3,4,5,6}(1 row) 多维数组值可以通过嵌套数组构造器的方法来制作。内层构造器中的ARRAY关键字可以省略。比如，下面两个示例是同样的结果： gaussdb=# SELECT ARRAY[ARRAY[1,2], ARRAY[3,4]]; array --------------- {{1,2},{3,4}}(1 row)gaussdb=# SELECT ARRAY[[1,2], [3,4]]; array --------------- {{1,2},{3,4}}(1 row) 同层的内层构造器必须生成同维的子数组。 任何应用于外层ARRAY构造器的类型转换自动的应用到所有的内层构造器。

数据库对象命名 数据库对象命名需要满足约束： 表标识符长度不超过63个字节。 标识符以字母或下划线开头，中间字符可以是字母、数字、下划线、$、#。 若标识符被双引号（""）包含，则可以使用合法字符的任意组合，如"123gs_column"。 标识符不区分大小写，只有被双引号包含才区分大小写。 避免使用保留或者非保留关键字命名数据库对象。 可以使用select * from pg_get_keywords()查询GaussDB的关键字，或者在关键字章节中查看。 避免使用双引号括起来的字符串来定义数据库对象名称，除非需要限制数据库对象名称的大小写。数据库对象名称大小写敏感会使定位问题难度增加。 数据库对象命名风格务必保持统一。 增量开发的业务系统或进行业务迁移的系统，建议遵守历史的命名风格。 建议使用多个单词组成，以下划线分割。 数据库对象名称建议能够望文知意，尽量避免使用自定义缩写（可以使用通用的术语缩写进行命名）。例如，在命名中可以使用具有实际业务含义的英文词汇或汉语拼音，但规则应该在集群范围内保持一致。 变量名的关键是要具有描述性，即变量名要有一定的意义，变量名要有前缀标明该变量的类型。 表对象的命名应该可以表征该表的重要特征。例如，在表对象命名时区分该表是普通表、临时表还是非日志表： 普通表名按照数据集的业务含义命名。 临时表以“tmp_+后缀”命名。 非日志表以“ul_+后缀”命名。 外表以“f_+后缀”命名。 不创建以redis_为前缀的数据库对象。 不创建以mlog_和以matviewmap_为前缀的数据库对象。 不创建以gs_role_为前缀的数据库对象。 表对象命名建议不要超过63字节。如果超过该长度内核会对表名进行截断，从而出现实际名称和设置值不一致的现象，且在不同字符集下，可能造成字符被截断，出现预期外的字符。 父主题： 开发设计建议

选择数据类型 在字段设计时，基于查询效率的考虑，一般需要遵循以下原则： 尽量使用高效数据类型。 选择数值类型时，在满足业务精度的情况下，选择数据类型的优先级从高到低依次为整数、浮点数、NUMERIC。 当多个表存在逻辑关系时，表示同一含义的字段应该使用相同的数据类型。 对于字符串数据，建议使用变长字符串数据类型，并指定最大长度。请务必确保指定的最大长度大于需要存储的最大字符数，避免出现超出字段定义最大长度的异常报错而导致业务中断现象。除非明确知道数据类型为固定长度字符串，否则，不建议使用CHAR(n)、BPCHAR(n)、NCHAR(n)、CHARACTER(n)。 关于字符串类型的详细说明，请参见常用字符串类型介绍。

Database设计建议 在实际业务中，根据需要创建新的Database，不建议直接使用集群默认的postgres数据库。 一个集群内，用户自定义的Database数量推荐值为3个，不建议超过10个。用户自定义的Database数量过多会导致升级、备份等运维操作的效率降低。 为了适应全球化的需求，使数据库编码能够存储与表示绝大多数的字符，建议创建Database的时候使用UTF-8编码。 创建Database时，需要重点关注字符集编码（ENCODING）和兼容性（DBCOMPATIBILITY）两个配置项。GaussDB支持TD、ORA、MYSQL和PG四种兼容模式，分别部分兼容Teradata语法、Oracle语法、MySQL语法和PostgreSQL语法，不同兼容模式下的语法行为存在一定差异，默认为MYSQL兼容模式。 Database的owner默认拥有该Database下所有对象的所有权限，包括删除权限。删除权限影响较大，请谨慎使用。

Schema设计建议 实际用户环境中Schema数量不建议超过100个。当数据库中存在大量Schema时，会导致gs_dump等依赖Schema数量的操作性能变慢。 如果该用户不具有sysadmin权限或者不是该Schema的owner，要访问Schema下的对象，需要同时给用户授予Schema的usage权限和对象的相应权限。 如果要在Schema下创建对象，需要授予操作用户该Schema的CREATE权限。 Schema的owner默认拥有该Schema下对象的所有权限，包括删除权限。删除权限影响较大，请谨慎使用。