v3.4 v3.4 v3.2 v3.0 v2.8 v2.6 v2.0 文档: 关于 SequoiaDB

产品概述

整体架构

核心特性

快速入门

安装

系统要求

服务器软硬件要求

Linux环境推荐配置

安装部署

概述

命令行安装

数据库安装
规划数据库部署
独立模式
集群模式

Docker 部署

可视化安装

可视化数据操作

limit设置

增加机器

升级

版本兼容性

卸载

基本操作

CRUD操作

插入

查询

更新

删除

索引

全文索引

概述

全文检索环境部署

搜索引擎适配器

全文检索语法

聚集

事务

数据分区

分区类型

分区键

分区集合

分区索引

后台任务

数据切分

数据模型

概述

文档

数据类型

数据类型概述

数组

对象ID

日期

时间戳

二进制数据

正则表达式

高精度数

集合

集合空间

大对象

自增字段

SQL引擎

PostgreSQL实例组件

概述

安装

安装部署
连接
开发
卸载

SQL实例与 JSON对象映射表

MySQL实例组件

概述

安装部署

sequoiasql-mysql服务

高可用

升级

使用

配置

错误码

注意事项

卸载

FileSystem引擎

概述

安装部署

使用

挂载目录

卸载目录

S3引擎

概述

SequoiaS3 安装与配置

Rest 接口

桶 API

对象 API

区域 API

用户 API

Java 接口

系统架构

概述

SQL节点

协调节点

编目节点

概述

SYSCOLLECTIONS 集合

SYSCOLLECTIONSPACES 集合

SYSDOMAINS 集合

SYSNODES 集合

SYSTASKS 集合

SYSUSRS 集合

STOREPROCEDURES 集合

数据节点

资源管理节点

分区组

概述

选举机制

数据复制

读写分离

后台任务

域

数据库管理

数据库服务

数据库配置

特殊配置项修改

概述

数据文件

索引文件

大对象数据文件

大对象元数据文件

同步日志

引擎调度工具

数据库工具

快速部署工具

命令行工具

数据导入工具

数据导出工具

数据库检测工具

数据库日志dump工具

数据库性能工具

节点数据一致性检测工具

数据库信息收集工具

大对象工具

数据库密码工具

集群启停

集群启动

集群停止

集群扩容

新增主机

新增节点

备份恢复

数据备份

查看备份信息

数据恢复

日志归档重放

日志归档

日志重放

监控

概述

快照

快照类型
上下文快照
当前上下文快照
会话快照
当前会话快照
集合快照
集合空间快照
数据库快照
操作系统快照
编目信息快照
事务快照
当前事务快照
访问计划缓存快照
节点健康检测快照
配置快照
服务任务快照
序列快照

列表

列表类型
上下文列表
当前上下文列表
会话列表
当前会话列表
集合列表
集合空间列表
存储单元列表
分区组列表
事务列表
当前事务列表
服务任务列表
序列列表
用户列表
备份列表

监控节点状态

监控集群

安全

数据库系统安全

网络安全

查询访问计划

概述

基于代价的访问计划评估

概述
访问计划的搜索过程
TBSCAN的推演公式
IXSCAN的推演公式
SORT的推演公式

查看访问计划

概述
协调节点的访问计划
主表的访问计划
数据节点的访问计划
COORD-MERGE操作的信息
MERGE操作的信息
SORT操作的信息
TBSCAN操作的信息
IXSCAN操作的信息

访问计划缓存

统计信息

统计信息

连接器

Hadoop

部署

集成

Hive

部署

建表

从hdfs上导入表

查询数据

Spark实例组件

概述

安装

SparkSQL

PostgreSQL实例组件

概述

部署

连接

开发

驱动

C驱动

C驱动概述

C开发环境搭建

C开发基础

C BSON使用

SQL to SequoiaDB shell to C

C API

C++驱动

C++驱动概述

C++开发环境搭建

C++开发基础

C++ BSON使用

C++连接池

SQL to SequoiaDB shell to C++

C++ API

CSharp驱动

CSharp驱动概述

CSharp开发环境搭建

CSharp开发基础

SQL to SequoiaDB shell to CSharp

CSharp API

Java开发驱动

Java驱动概述

Java开发环境搭建

Java开发基础

Java BSON使用

Java Datasource介绍

SQL to SequoiaDB shell to Java

Java API

PHP驱动

PHP驱动概述

PHP开发环境搭建

PHP开发基础

SQL to SequoiaDB shell to PHP

PHP API

Python驱动

Python驱动概述

Python开发环境搭建

Python开发基础

Python BSON使用

SQL to SequoiaDB shell to Python

Python API

REST接口

REST接口描述

REST接口

参考手册

SequoiaDB Shell方法

概述

命令位置参数

Global

help()
print()
sleep()
forceGC()
getErr()
getLastErrMsg()
getLastErrObj()
getLastError()
setLastErrMsg()
setLastErrObj()
setLastError()
getExePath()
getRootPath()
getSelfPath()
import()
importOnce()
jsonFormat()
traceFmt()

Sdb

Sdb()
analyze()
backup()
cancelTask()
close()
createCataRG()
createCoordRG()
createCS()
createDomain()
createProcedure()
createRG()
createSpareRG()
createUsr()
dropCS()
dropDomain()
dropUsr()
eval()
exec()
execUpdate()
flushConfigure()
forceSession()
forceStepUp()
getCatalogRG()
getCoordRG()
getCS()
getDomain()
getRG()
getSessionAttr()
getSpareRG()
invalidateCache()
list()
listBackup()
listCollections()
listCollectionSpaces()
listDomains()
listProcedures()
listReplicaGroups()
listSequences()
listTasks()
loadCS()
removeBackup()
removeCatalogRG()
removeCoordRG()
removeSpareRG()
removeProcedure()
removeRG()
renameCS()
resetSnapshot()
reloadConf()
deleteConf()
setSessionAttr()
snapshot()
startRG()
stopRG()
sync()
setPDLevel()
traceOff()
traceOn()
traceResume()
traceStatus()
transBegin()
transCommit()
transRollback()
unloadCS()
updateConf()
waitTasks()

SecureSdb

SdbCS

alter()
createCL()
dropCL()
getCL()
removeDomain()
renameCL()
setAttributes()
setDomain()

SdbCollection

aggregate()
alter()
attachCL()
count()
createAutoIncrement()
createIdIndex()
createIndex()
createLobID()
deleteLob()
detachCL()
disableCompression()
disableSharding()
dropAutoIncrement()
dropIdIndex()
dropIndex()
enableCompression()
enableSharding()
find()
findOne()
getIndex()
getLob()
insert()
listIndexes()
listLobs()
putLob()
remove()
setAttributes()
split()
splitAsync()
truncate()
truncateLob()
update()
upsert()

SdbCursor

close()
current()
next()
arrayAccess()

SdbQuery

arrayAccess()
close()
count()
current()
explain()
flags()
getQueryMeta()
hint()
limit()
next()
query()
remove()
size()
skip()
sort()
toArray()
update()

SdbReplicaGroup

attachNode()
createNode()
detachNode()
getDetail()
getMaster()
getNode()
getSlave()
reelect()
removeNode()
start()
stop()

SdbNode

connect()
getHostName()
getNodeDetail()
getServiceName()
start()
stop()

SdbDomain

addGroups()
alter()
listCollections()
listCollectionSpaces()
removeGroups()
setAttributes()
setGroups()
listGroups()

Oma

Oma()
close()
createCoord()
createData()
createOM()
removeCoord()
removeData()
removeOM()
startNode()
stopNode()
startAllNodes()
stopAllNodes()
setNodeConfigs()

File

File()
chgrp()
chmod()
chown()
close()
copy()
exist()
find()
getSize()
getUmask()
isDir()
isEmptyDir()
isFile()
list()
md5()
mkdir()
move()
read()
readContent()
readLine()
remove()
scp()
seek()
setUmask()
stat()
write()
writeContent()
truncate()

FileContent

clear()
getLength()
toBase64Code()

Cmd

Cmd()
getCommand()
getInfo()
getLastOut()
getLastRet()
run()
runJS()
start()

Remote

close()
getCmd()
getFile()
getIniFile()
getInfo()
Remote()

Hash

fileMD5()
md5()

IniFile

IniFile()
addComment()
addSectionComment()
addLastComment()
setComment()
setSectionComment()
setLastComment()
delComment()
delSectionComment()
delLastComment()
enableItem()
disableItem()
disableAllItem()
getComment()
getSectionComment()
getLastComment()
getValue()
setValue()
toObj()
toString()
save()

Sdbtool

listNodes()

Ssh

Ssh()
close()
exec()
getLastOut()
getLastRet()
getLocalIP()
getPeerIP()
pull()
push()

System

addAHostMap
addGroup
addUser
delAHostMap
delGroup
delUser
getAHostMap
getCpuInfo
getCurrentUser
getDiskInfo
getEWD
getHostName
getHostsMap
getIpTablesInfo
getMemInfo
getNetcardInfo
getPID
getProcUlimitConfigs
getReleaseInfo
getSystemConfigs
getTID
getUserEnv
isGroupExist
isProcExist
isUserExist
killProcess
listAllUsers
listGroups
listLoginUsers
listProcess
ping
runService
setProcUlimitConfigs
setUserConfigs
snapshotCpuInfo
snapshotDiskInfo
snapshotMemInfo
snapshotNetcardInfo
sniffPort
type

辅助类型对象

SdbSnapshotOption
SdbQueryOption
SdbTraceOption
CLCount

特殊类型对象

BinData
BSONArray
BSONObj
MaxKey
MinKey
NumberDecimal
NumberLong
OID
Regex
SdbDate
Timestamp

操作符

匹配符

概述
$gt
$gte
$lt
$lte
$ne
$et
$mod
$in
$isnull
$nin
$all
$and
$not
$or
$type
$exists
$elemMatch
$+标识符
$size
$regex
$field
$expand
$returnMatch

选择符

概述
$include
$default
$elemMatch
$elemMatchOne

函数操作

概述
$abs
$ceiling
$floor
$mod
$add
$subtract
$multiply
$divide
$substr
$strlen
$lower
$upper
$ltrim
$rtrim
$trim
$cast
$size
$type
$slice

更新符

概述
$inc
$set
$unset
$addtoset
$pop
$pull
$pull_all
$pull_by
$pull_all_by
$push
$push_all
$replace

聚集符

概述
$project
$match
$limit
$sort
$skip
$group
SQL to Aggregate 映射表

SQL语法

语句

create collectionspace
drop collectionspace
create collection
drop collection
create index
drop index
list collectionspaces
list collections
insert into
select
update
delete
transaction

子句

where
group by
order by
split by
limit
offset
as
inner join
left outer join
right outer join
hint

函数

sum()
count()
avg()
max()
min()
first()
last()
push()
addtoset()
buildobj()
mergearrayset()

监控视图

概述
$SNAPSHOT_CONTEXT
$SNAPSHOT_CONTEXT_CUR
$SNAPSHOT_SESSION
$SNAPSHOT_SESSION_CUR
$SNAPSHOT_CL
$SNAPSHOT_CS
$SNAPSHOT_DB
$SNAPSHOT_SYSTEM
$SNAPSHOT_CATA
$SNAPSHOT_TRANS
$SNAPSHOT_TRANS_CUR
$SNAPSHOT_ACCESSPLANS
$SNAPSHOT_HEALTH
$SNAPSHOT_CONFIGS
$SNAPSHOT_SVCTASKS
$SNAPSHOT_SEQUENCES
$LIST_CONTEXT
$LIST_CONTEXT_CUR
$LIST_SESSION
$LIST_SESSION_CUR
$LIST_CL
$LIST_CS
$LIST_SU
$LIST_GROUP
$LIST_TRANS
$LIST_TRANS_CUR
$LIST_SVCTASKS
$LIST_SEQUENCES
$LIST_USER
$LIST_BACKUP

表达式

运算符

数据类型

SQL to SequoiaDB 映射表

限制

错误码

故障排除

常见错误

常见错误处理指南

SAC 管控中心

运行环境

安装与登录

安装 SAC

登录 SAC

修改登录密码

部署

一键部署

创建集群

主机操作

添加主机
卸载主机
解绑主机
部署包
更新主机信息

存储集群操作

创建存储集群
添加已有的存储集群
删除存储集群
移除存储集群
扩容
减容
重启
同步配置
设置鉴权

MySQL 实例操作

创建实例
添加已有的实例
删除实例
移除实例
添加实例存储
移除实例存储
重启实例
同步配置
设置鉴权

PostgreSQL 实例操作

创建实例
添加已有的实例
删除实例
移除实例
添加实例存储
移除实例存储
重启实例
同步配置
设置鉴权

监控

总览

节点

节点列表
分区组列表
分区组快照
节点快照
分区组信息
节点信息
图表
节点数据同步

资源

会话
上下文
域
存储过程
事务
图表

主机

主机列表
主机快照
图表
主机信息

配置

修改存储集群配置

修改 MySQL 实例配置

修改 PostgreSQL 实例配置

SequoiaDB 数据操作

集合空间

集合空间属性
创建集合空间
删除集合空间

集合

集合属性
创建集合
删除集合
挂载集合
分离集合
切分数据

索引

索引属性
创建索引
删除索引

记录

查询
插入
更新
删除
显示模式

Lob

PostgreSQL 实例数据操作

数据库

数据操作

字段结构

MySQL 实例数据操作

数据库

数据操作

字段结构

Web服务

概述

WebSphere

部署

连接

web应用

Tomcat

部署

连接

web应用

JBoss

部署

连接

web应用

版本信息

getSlave()

名称

getSlave - 获取当前分区组的备节点。

语法

rg.getSlave([positions])

类别

Replica Group

描述

获取当前分区组的备节点。

参数

positions ( Int32，选填 )

节点位置。目前，节点位置定义为该节点在 catalog 元数据的 "Group" 数组中的位置。其起始值为1，范围为[1,7]。最多只能输入7个不重复的、有效节点位置。若指定的节点位置大于分区组的节点数，这些节点位置将按照公式 (position - 1) % nodeCount + 1 进行转换。

返回值

成功：返回 SdbNode 对象。

失败：抛出异常。

Note:

当分区组只有一个节点，不管是否指定节点位置，直接返回唯一的节点对象，即使该节点为主节点。
当分区组有多个节点，在不指定节点位置的情况下，返回的节点必为备节点。
当分区组有多个节点，在指定节点位置的情况下，若节点位置包含备节点，则随机返回包含的备节点；若节点位置只包含主节点，则返回主节点。

错误

getSlave()函数常见异常如下：

错误码	错误类型	描述	解决方法
-6	SDB_INVALIDARG	参数错误。	输入的节点位置参数有误。
-10	SDB_SYS	系统错误。	一般由 catalog 元素数据变更后，驱动无法解析元数据导致。
-154	SDB_CLS_GRP_NOT_EXIST	分区组不存在。	检查分区组是否存在。
-158	SDB_CLS_EMPTY_GROUP	分区组为空。	检查分区组是否包含任何节点。

当异常抛出时，可以通过getLastError()获取错误码，或通过getLastErrMsg()获取错误信息。可以参考常见错误处理指南了解更多内容。

版本

v2.10加入节点位置参数，用于获取指定位置的备节点。
v1.0 添加此接口。

示例

获取 group1 分区组的备节点。

> var rg = db.getRG("group1")
> rg.getSlave()
hostname1:42000

group1 分区组信息如下：

> db.list(SDB_LIST_GROUPS, {"GroupName":"group1"})
{
"Group": [
    {
    "HostName": "hostname1",
    "Status": 1,
    "dbpath": "/sequoiadb/database/40000/",
    "Service": [
        {
        "Type": 0,
        "Name": "40000"
        },
        {
        "Type": 1,
        "Name": "40001"
        },
        {
        "Type": 2,
        "Name": "40002"
        }
    ],
    "NodeID": 1001
    },
    {
    "HostName": "hostname1",
    "Status": 1,
    "dbpath": "/sequoiadb/database/41000/",
    "Service": [
        {
        "Type": 0,
        "Name": "41000"
        },
        {
        "Type": 1,
        "Name": "41001"
        },
        {
        "Type": 2,
        "Name": "41002"
        }
    ],
    "NodeID": 1002
    },
    {
    "HostName": "hostname1",
    "Status": 1,
    "dbpath": "/sequoiadb/database/42000/",
    "Service": [
        {
        "Type": 0,
        "Name": "42000"
        },
        {
        "Type": 1,
        "Name": "42001"
        },
        {
        "Type": 2,
        "Name": "42002"
        }
    ],
    "NodeID": 1003
    }
],
"GroupID": 1001,
"GroupName": "group1",
"PrimaryNode": 1002,
"Role": 0,
"SecretID": 1425460557,
"Status": 1,
"Version": 7,
"_id": {
    "$oid": "5a045460c517f3cf06a32976"
}
}

其中，节点为：
hostname1:40000(备节点，节点位置为1)；
hostname1:41000(主节点，节点位置为2)；
hostname1:42000(备节点，节点位置为3)；
从 group1 分区组中，随机获取位置1和位置2节点中的备节点：

> var rg = db.getRG("group1")
> rg.getSlave(1,2)
hostname1:40000

文档

getSlave()

名称

语法

类别

描述

参数

返回值

错误

版本

示例

产品

技术文档

解决方案

联系我们