gbase数据、南大通用产品文档：GBase8sSQL 管理 API 门户：按权限组划分参数

您可查看 admin() 和 task() 函数参数的列表，按照权限组排序，带有指向有关参数信息的
链接。
权限组标识用户可运行哪些 SQL 管理 API 命令。有些函数参数在多个权限组中。将权限
组授予用户，以便他们为了工作需要可运行这些命令。缺省情况下，仅用户 gbasedbt 或
DBSA 可运行 SQL 管理 API 命令。
使用 grant admin 参数来授予权限，以及 revoke admin 参数来撤销权限。
l ADMIN：用户可运行所有 SQL 管理 API 函数。
l BAR 权限组：用户可运行备份和恢复函数。
l FILE 权限组：用户可管理消息日志并显示文件信息。
l GRANT 权限组：用户有权限授予和撤销权限。
l HA 权限组：用户可运行高可用性函数。
l MISC 权限组：用户可管理数据库服务器。
l MONITOR 权限组：用户可运行仅显示信息的所有 SQL 管理 API 函数。
l OPERATOR：用户可运行所有 SQL 管理 API 函数，除了 GRANT 权限组中的函数。
l REPLICATION 权限组：用户可运行 Enterprise Replication cdr 实用程序函数。
l SQL 权限组：用户可运行与管理数据库的 SQL 语句有关的函数。
l SQLTRACE 权限组：用户可运行 SQL 跟踪函数。
l STORAGE 权限组：用户可运行与空间相关的函数。
l TENANT 权限组：用户可运行 tenant 数据库功能。
BAR 权限组

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 672 -

BAR 权限组包括备份数据库的 SQL 管理 API 函数参数。
表 1. 备份和恢复admin() 和 task() 函数参数
参数
archive fake 参数：执行无记录的备份（SQL 管理 API）
ontape archive 参数：备份数据库上的数据（SQL 管理 API）
onbar 参数：备份存储空间（SQL 管理 API）
onsmsync 参数：与存储管理器目录同步（SQL 管理 API）

FILE 权限组
FILE 权限组包括管理消息日志和显示文件信息的 SQL 管理 API 函数参数。
表 2. 消息日志命令的 admin() 和 task() 函数参数
参数
file status 参数：显示消息日志文件的状态（SQL 管理 API）
message log rotate 参数：轮换消息日志文件（SQL 管理 API）
message log delete 参数：删除消息日志文件（SQL 管理 API）
message log truncate 参数：删除消息日志文件的内容（SQL 管理 API）
print file info 参数：显示目录或文件信息（SQL 管理 API）

GRANT 权限组
GRANT 权限组包括将运行 SQL 管理 API 命令的权限授予其他用户或撤销的 SQL 管理
API 函数参数。
表 3. 授予和撤销权限的 admin() 和 task() 函数参数
参数
grant admin 参数：授予运行 SQL 管理 API 命令的权限
revoke admin 参数：撤销运行 SQL 管理 API 命令的权限

HA 权限组
HA 权限组包括管理高可用性集群的 SQL 管理 API 函数参数。

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 673 -

表 4. 高可用性集群命令的 admin() 和 task() 函数参数
参数
ha make primary 参数：更改辅助服务器的模式（SQL 管理 API）
ha rss 参数：创建 RS 辅助服务器（SQL 管理 API）
ha rss add 参数：将 RS 辅助服务器添加到主服务器（SQL 管理 API）
ha rss change 参数：更改 RS 辅助服务器的口令（SQL 管理 API）
ha rss delete 参数：删除 RS 辅助服务器（SQL 管理 API）
ha sds clear 参数：停止共享磁盘复制（SQL 管理 API）
ha sds primary 参数：将 SD 辅助服务器转换到主服务器（SQL 管理 API）
ha sds set 参数：创建共享磁盘主服务器（SQL 管理 API）
ha set idxauto 参数：复制索引到辅助服务器（SQL 管理 API）
ha set ipl 参数：在主服务器上构建日志索引（SQL 管理 API）
ha set primary 参数：定义 HDR 主服务器（SQL 管理 API）
ha set secondary 参数：定义 HDR 辅助服务器（SQL 管理 API）
ha set standard 参数：将 HDR 服务器转换成为标准服务器（SQL 管理 API）
ha set timeout 参数：更改 SD 辅助服务器超时（SQL 管理 API）
onmode 和 d 参数：设置数据复制类型（SQL 管理 API）

MISC 权限组
MISC 权限组包括管理数据库服务器的 SQL 管理函数参数：
l onstat
l 配置参数
l 数据、分区和 extent
l 监听线程
l 消息日志
l 内存
l PDQ
l 服务器模式

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 674 -

l SQL 语句高速缓存
l 其他管理任务
onstat
通过运行 onstat 命令监视数据库服务器的 SQL 管理 API 函数参数。
表 5. onstat 命令的 admin() 和 task() 函数参数
参数
onstat 参数：监视数据库服务器（SQL 管理 API）

配置参数
更新配置参数的 SQL 管理 API 函数参数。
表 6. 配置参数命令的 admin() 和 task() 函数参数
参数
export config 参数：导出配置参数值（SQL 管理 API）
import config 参数：导入配置参数值（SQL 管理 API）
modify config 参数：更改配置参数（SQL 管理 API）
onmode 和 wf 参数：永久地更新配置参数（SQL 管理 API）
onmode 和 wm 参数：临时地更新配置参数（SQL 管理 API）
onmode、wm 和 AUTO_LRU_TUNING 参数：更改 LRU 调整状态（SQL 管理 API）
reset config 参数：恢复配置参数值（SQL 管理 API）
reset config all 参数：恢复所有动态地可更新的配置参数值（SQL 管理 API）
set onconfig memory 参数：临时地更改配置参数（SQL 管理 API）
set onconfig permanent 参数：永久地更改配置参数（SQL 管理 API）

数据、分区和 extent
管理数据、分区和 extent 的 SQL 管理 API 函数参数。
表 7. 数据、分区和 extent 命令的 admin() 和 task() 函数参数
参数

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 675 -

参数
check data 参数：检查数据一致性（SQL 管理 API）
check extents 参数：检查 extent 一致性（SQL 管理 API）
check partition 参数：检查分区一致性（SQL 管理 API）
checkpoint 参数：强制一检查点（SQL 管理 API）
create dbaccessdemo 参数：创建演示数据库（SQL 管理 API）
onmode 和 C 参数：控制 B-tree 扫描程序（SQL 管理 API）
onmode 和 c 参数：强制检查点（SQL 管理 API）
print partition 参数：打印分区信息（SQL 管理 API）
set dataskip 参数：启动或停止跳过 dbspace（SQL 管理 API）
set index compression 参数：更改索引页压缩（SQL 管理 API）

监听线程
不中断现有的连接而控制 SOCTCP 或 TLITCP 网络连接协议监听线程的 SQL 管理 API 函
数参数。
表 8. 监听线程命令的 admin() 和 task() 函数参数
参数
restart listen 参数：动态地停止并启动监听线程（SQL 管理 API）
start listen 参数：动态地启动监听线程（SQL 管理 API）
stop listen 参数：动态地停止监听线程（SQL 管理 API）

消息日志
管理消息日志的 SQL 管理 API 函数参数。
表 9. 消息日志命令的 admin() 和 task() 函数参数
参数
file status 参数：显示消息日志文件的状态（SQL 管理 API）

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 676 -

参数
message log rotate 参数：轮换消息日志文件（SQL 管理 API）
message log delete 参数：删除消息日志文件（SQL 管理 API）
message log truncate 参数：删除消息日志文件的内容（SQL 管理 API）

内存
管理内存的 SQL 管理 API 函数参数。
表 10. 内存命令的 admin() 和 task() 函数参数
参数
add bufferpool 参数：添加缓冲池（SQL 管理 API）
add memory 参数：增加共享内存（SQL 管理 API）
onmode 和 a 参数：添加共享内存段（SQL 管理 API）
onmode 和 F 参数：释放不用的内存段（SQL 管理 API）
onmode 和 n 参数：解锁驻留内存（SQL 管理 API）
onmode 和 r 参数：强制共享内存的驻留（SQL 管理 API）
scheduler lmm enable 参数：指定自动的低内存管理设置（SQL 管理 API）
scheduler lmm disable 参数：停止自动的低内存管理（SQL 管理 API）

PDQ
管理 PDQ 的 SQL 管理 API 函数参数。
表 11. PDQ 命令的 admin() 和 task() 函数参数
参数
onmode 和 D 参数：设置 PDQ 优先级（SQL 管理 API）
onmode 和 M 参数：临时地更改决策支持内存（SQL 管理 API）
onmode 和 Q 参数：设置决策支持查询的最大数目（SQL 管理 API）
onmode 和 S 参数：设置决策支持扫描的最大数目（SQL 管理 API）


GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 677 -

服务器模式
更改服务器模式的 SQL 管理 API 函数参数。
表 12. 服务器模式命令的 admin() 和 task() 函数参数
参数
onmode 和 j 参数：切换数据库服务器到管理模式（SQL 管理 API）
onmode 和 m 参数：切换到多用户模式（SQL 管理 API）

SQL 语句高速缓存
管理 SQL 语句高速缓存的 SQL 管理 API 函数参数。
表 13. SQL 语句高速缓存命令的 admin() 和 task() 函数参数
参数
onmode 和 e 参数：更改 SQL 语句高速缓存的用法（SQL 管理 API）
onmode 和 W 参数：重置语句高速缓存属性（SQL 管理 API）

其他管理任务
管理其他管理任务的 SQL 管理 API 函数参数。
表 14. 其他管理任务命令的 admin() 和 task() 函数参数
参数
alter logmode 参数：更改数据库日志记录模式（SQL 管理 API）
create dbaccessdemo 参数：创建演示数据库（SQL 管理 API）
onmode 和 e 参数：更改 SQL 语句高速缓存的用法（SQL 管理 API）
onmode 和 l 参数：切换到下一个逻辑日志（SQL 管理 API）
onmode 和 p 参数：添加或移除虚拟处理器（SQL 管理 API）
onmode 和 Y 参数：更改会话的查询计划度量（SQL 管理 API）
onmode 和 z 参数：终止用户会话（SQL 管理 API）
onmode 和 Z 参数：终止分布式事务（SQL 管理 API）
print error 参数：打印错误消息（SQL 管理 API）

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 678 -

参数
reset sysadmin 参数：移动 sysadmin 数据库（SQL 管理 API）
scheduler 参数：停止或启动调度程序（SQL 管理 API）

MONITOR 权限组
MONITOR 权限组包括监视消息日志、Enterprise Replication 和压缩估算的 SQL 管理函
数参数。
表 15. 监视消息日志、Enterprise
Replication 或压缩估算的 admin() 和 task() 函数
参数
参数
cdr
error、cdr
finderr、cdr
list
repair、cdr
list
replicate、cdr
list
replicateset、
cdr list server、cdr list template、cdr stats recv 和 cdr stats rqm 参数
cdr 参数：管理 Enterprise Replication（SQL 管理 API）
file status 参数：显示消息日志文件的状态（SQL 管理 API）
index estimate_compression 参数：估计索引压缩（SQL 管理 API）
print error 参数：打印错误消息（SQL 管理 API）
onstat 参数：监视数据库服务器（SQL 管理 API）
table estimate_compression 和 fragment estimate_compression 参数
table 或 fragment 参数：压缩数据和优化存储（SQL 管理 API）

REPLICATION 权限组
REPLICATION 权限组包括管理 Enterprise Replication 的 SQL 管理 API 函数参数。
表 16. Enterprise Replication 命令的 admin() 和 task() 函数参数
参数
cdr 参数：管理 Enterprise Replication（SQL 管理 API）

SQL 权限组

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 679 -

SQL 权限组包括创建和删除数据库以及查看错误消息的 SQL 管理 API 函数参数。
表 17. 数据库和错误消息的 admin() 和 task() 函数参数
参数
create database 参数：创建数据库（SQL 管理 API）
create dbaccessdemo 参数：创建演示数据库（SQL 管理 API）
drop database 参数：删除数据库（SQL 管理 API）
print error 参数：打印错误消息（SQL 管理 API）

SQLTRACE 权限组
SQLTRACE 权限组包括管理 SQL 跟踪的 SQL 管理 API 函数参数。
表 18. SQL 跟踪命令的 admin() 和 task() 函数参数
参数
set sql tracing 参数：设置全局 SQL 跟踪（SQL 管理 API）
set sql tracing database 参数：更改数据库跟踪（SQL 管理 API）
set sql tracing session 参数：控制对会话的跟踪（SQL 管理 API）
set sql tracing user 参数：控制对用户的跟踪（SQL 管理 API）
set sql user tracing 参数：设置对用户会话的全局 SQL 跟踪（SQL 管理 API）

STORAGE 权限组
STORAGE 权限组包括管理存储的下列方面的 SQL 管理 API 函数参数：
l 自动表存储位置参数
l 压缩
l 逻辑和物理日志
l 镜像
l 存储空间
l 存储供应
自动表存储位置参数
管理存储自动分配分片的 dbspace 列表的 SQL 管理 API 函数参数。
表 19. 表存储命令的 admin() 和 task() 函数参数

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 680 -

参数
autolocate database add 参数：添加 dbspace 到 dbspace 列表（SQL 管理 API）
autolocate database anywhere 参数：添加所有 dbspace 到 dbspace 列表（SQL 管理
API）
autolocate database 参数：指定自动定位和分片的 dbspace（SQL 管理 API）
autolocate database off 参数：禁用数据库的自动分片（SQL 管理 API）
autolocate database remove 参数：从 dbspace 列表中移除 dbspace（SQL 管理 API）

压缩
管理数据压缩并优化存储的 SQL 管理 API 函数参数。
表 20. 压缩命令的 admin() 和 task() 函数参数
参数
index compress repack shrink 参数：优化 B-tree 索引的存储（SQL 管理 API）
index estimate_compression 参数：估计索引压缩（SQL 管理 API）
table 或 fragment 参数：压缩数据和优化存储（SQL 管理 API）
清除压缩字典参数：移除压缩字典（SQL 管理 API）

要了解压缩和存储优化命令的概况，请参阅表和分片压缩和解压缩操作（SQL 管理 API）。

逻辑和物理日志
管理逻辑和物理日志的 SQL 管理 API 函数参数。
表 21. 日志命令的 admin() 和 task() 函数参数
参数
add log 参数：添加新逻辑日志（SQL 管理 API）
alter logmode 参数：更改数据库日志记录模式（SQL 管理 API）
alter plog 参数：更改物理日志（SQL 管理 API）
drop log 参数：删除逻辑日志（SQL 管理 API）


GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 681 -

镜像
管理镜像的 SQL 管理 API 函数参数。
表 22. 镜像命令的 admin() 和 task() 函数参数
参数
add mirror 参数：添加镜像 chunk（SQL 管理 API）
start mirroring 参数：启动存储空间镜像（SQL 管理 API）
stop mirroring 参数：停止存储空间镜像（SQL 管理 API）

存储空间
管理 chunk、blobspace、dbspace 和 sbspace 的 SQL 管理 API 函数参数。
表 23. 空间命令的 admin() 和 task() 函数参数
参数
add chunk 参数：添加新 chunk（SQL 管理 API）
alter chunk 参数：更改 chunk 状态为 online 或 offline（SQL 管理 API）
clean sbspace 参数：释放未引用的智能大对象（SQL 管理 API）
create blobspace 参数：创建 blobspace（SQL 管理 API）
create chunk 参数：创建 chunk（SQL 管理 API）
create dbaccessdemo 参数：创建演示数据库（SQL 管理 API）
create dbspace 参数：创建 dbspace（SQL 管理 API）
create sbspace 参数：创建 sbspace（SQL 管理 API）
create sbspace with accesstime 参数：创建跟踪访问时间的 sbspace（SQL 管理 API）

create sbspace with log 参数：创建带有事务日志记录的 sbspace（SQL 管理 API）
create tempdbspace 参数：创建临时 dbspace（SQL 管理 API）
create tempsbspace 参数：创建临时 sbspace（SQL 管理 API）
drop blobspace 参数：删除 blobspace（SQL 管理 API）
drop chunk 参数：删除 chunk（SQL 管理 API）

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 682 -

参数
drop dbspace 参数：删除 dbspace（SQL 管理 API）
drop sbspace 参数：删除 sbspace（SQL 管理 API）
drop tempdbspace 参数：删除临时 dbspace（SQL 管理 API）
onmode 和 O 参数：标记禁用的 dbspace 为 down（SQL 管理 API）
print error 参数：打印错误消息（SQL 管理 API）
rename space 参数：重命名存储空间（SQL 管理 API）
set chunk 参数：更改 chunk 的状态（SQL 管理 API）
set sbspace accesstime 参数：控制访问次数跟踪（SQL 管理 API）
set sbspace avg_lo_size 参数：设置智能大对象的平均大小（SQL 管理 API）
set sbspace logging 参数：更改 sbspace 的日志记录（SQL 管理 API）

存储供应
管理来自存储池的 chunk、blobspace、dbspace 和 sbspace 的 SQL 管理 API 函数参数。

表 24. 存储供应空间命令的 admin() 和 task() 函数参数
参数
create blobspace from storagepool 参数：从存储池创建 blobspace（SQL 管理 API）
create chunk from storagepool 参数：从存储池创建 chunk（SQL 管理 API）
create dbspace from storagepool 参数：从存储池创建 dbspace（SQL 管理 API）
create plogspace 参数：创建 plogspace（SQL 管理 API）
create sbspace from storagepool 参数：从存储池创建 sbspace（SQL 管理 API）
create tempdbspace 参数：创建临时 dbspace（SQL 管理 API）
create
tempdbspace
from
storagepool 参数：
从存储池创建临时 dbspace
（SQL 管理 API）

drop blobspace to storagepool 参数：从空 blobspace 归还空间到存储池（SQL 管理
API）

GBase 8s 管理员参考
南大通用数据技术股份有限公司 - 683 -

参数
drop chunk to storagepool 参数：从空 chunk 归还空间到存储池（SQL 管理 API）
drop dbspace to storagepool 参数：从空 dbspace 归还空间到存储池（SQL 管理 API）

drop plogspace 参数：删除 plogspace（SQL 管理 API）
drop sbspace to storagepool 参数：从空 sbspace 归还空间到存储池（SQL 管理 API）

drop
tempsbspace
to
storagepool 参数：
从空的临时 sbspace 归还空间到存储池
（SQL 管
理 API）
modify chunk extend 参数：扩展 chunk 的大小（SQL 管理 API）
modify chunk extendable off 参数：标记 chunk 为不可扩展的（SQL 管理 API）
modify chunk extendable 参数：标记 chunk 为可扩展的（SQL 管理 API）
modify space expand 参数：扩大空间的大小（SQL 管理 API）
modify space sp_sizes 参数：更改可扩展的存储空间的大小（SQL 管理 API）
storagepool add 参数：添加存储池条目（SQL 管理 API）
storagepool modify 参数：更改存储池条目（SQL 管理 API）
storagepool delete 参数：删除一个存储池条目（SQL 管理 API）
storagepool purge 参数：删除存储池条目（SQL 管理 API）

TENANT 权限组
TENANT 权限组包括管理 tenant 数据库的 SQL 管理 API 函数参数。
表 25. tenant 数据库命令的 admin() 和 task() 函数参数
参数
tenant create 参数：创建 tenant 数据库（SQL 管理 API）
tenant drop 参数：删除 tenant 数据库（SQL 管理 API）
tenant update 参数：更改 tenant 数据库属性（SQL 管理 API）

修改单库数目
单个全文库的数目定义为一个unit，是一个完整独立的全文索引结构，包含了字
典和所有倒排信息。打分、排序也是在该库内计算的，与其他库无关。单库内查
询采用串行的方式。对应配置项参数如下：
100000000

GBase 8s SQL 指南：教程
南大通用数据技术股份有限公司 - 254 -

当使用事务日志记录时，GBase 8s 保证在事务结束时，可回滚在事务内所作的一切。要可
靠地处理事务，数据库服务器通常应用下列规则：
•
当事务结束时，关闭所有游标。
•
当事务结束时，释放所有锁。
对于支持事务的大多数数据库系统，用于可靠地处理事务的规则都是正常的。然而，存在
一些情况，随同游标使用标准事务是不可能的。例如，在没有事务的情况下，下列代码正
常工作。然而，当添加事务时，关闭游标与同时使用两个游标发生冲突。
EXEC SQL DECLARE master CURSOR FOR
EXEC SQL DECLARE detail CURSOR FOR FOR UPDATE
EXEC SQL OPEN master;
while(SQLCODE == 0)
{
EXEC SQL FETCH master INTO
if(SQLCODE == 0)
{
EXEC SQL BEGIN WORK;
EXEC SQL OPEN detail USING
EXEC SQL FETCH detail
EXEC SQL UPDATE WHERE CURRENT OF detail
EXEC SQL COMMIT WORK;
}
}
EXEC SQL CLOSE master;
在此设计中，使用一个游标来扫描表。选择了的记录用作更新不同的表的基础。问题在于，
当将每一更新当做分开的事务处理时（如前一示例中伪代码所示），跟在 UPDATE 之后
的 COMMIT WORK 语句关闭所有游标，包括主游标。
最简单的替代方案是将 COMMIT WORK 语句和 BEGIN WORK 语句分别移到最后一个
语句和第一个语句， 这样，对整个主表的扫描就是一个大事务。将主表的扫描作为一个大
事务来处理，有时是可能的，但如果需要更新许多行，它可变得不现实。锁的数目可能太
大，并且在程序期间持有它们。
GBase 8s 数据库服务器支持的解决方案是将关键字 WITH HOLD 添加到主游标的声明。
引
用这样的游标作为持有游标，在不在事务结束时关闭。数据库服务器仍然关闭所有其他游
标，且它仍然释放所有锁，但持有游标保持打开，直到显式地关闭它为止。
在您尝试使用持有游标之前，您必须确保了解此处描述的锁定机制，且您还必须了解正在
并发地运行的程序。每当执行 COMMIT WORK 时，释放所有锁，包括放置在任何通过该
持有游标访存的行上的任何锁。

GBase 8s SQL 指南：教程
南大通用数据技术股份有限公司 - 255 -

对于对表的单向扫描，如果如您所愿地使用游标，则锁的移除无关紧要。然而，您可为任
何游标指定 WITH HOLD，包括更新游标和滚动游标。在您这么做之前，您必须了解该事
实的含义，即，在事务结束时，释放所有锁（包括对整个表的锁）。