REST接口

创建集合空间

说明例子
请求头同通用请求头
请求内容cmd: create collectionspace
name: 集合空间名字		cmd=create collectionspace&name=sample
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: -33, “description”: “Collection space already exists” }]
说明

删除集合空间

说明例子
请求头同通用请求头
请求内容cmd: drop collectionspace
name: 集合空间名字		cmd=drop collectionspace&name=sample
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

创建集合

说明例子
请求头同通用请求头
请求内容cmd: create collection
name: 集合的全称（集合空间.集合）
options: 选项（可选参数，可不填）		cmd=create collection&name=sample.employee
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

删除集合

说明例子
请求头同通用请求头
请求内容cmd: drop collection
name: 集合的全称（集合空间.集合）		cmd=drop collection&name=sample.employee
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

插入数据

说明例子
请求头同通用请求头
请求内容cmd: insert
name: 集合的全称（集合空间.集合）
insertor: 待插入的数据		cmd=insert&name=sample.employee&insertor={“age”:12,”name”:”hello”}
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

查询数据

说明例子
请求头同通用请求头
请求内容cmd: query
name: 集合的全称（集合空间.集合）
sort: 待排序字段名（可选参数，可不填）
selector: 查询结果列（可选参数，可不填）
skip: 跳过多少行（可选参数，可不填）
returnnum: 最大返回条数（可选参数，可不填）
filter: 查询条件（可选参数，可不填）		cmd=query&name=sample.employee&sort={“name”:1}&skip=0&returnnum=1&filter={“name”:”hello”}
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}
{
返回表里的记录
}
…		[{ “errno”: 0 },{ “_id”:{ “$oid”:”54def72f0d8737161d9d6934” },”age”:12,”name”:”hello” }]
说明

查询更新数据

说明例子
请求头同通用请求头
请求内容cmd: queryandupdate
name: 集合的全称（集合空间.集合）
updator: 更新操作
sort: 待排序字段名（可选参数，可不填）
selector: 查询结果列（可选参数，可不填）
skip: 跳过多少行（可选参数，可不填）
returnnum: 最大返回条数（可选参数，可不填）
filter: 查询条件（可选参数，可不填）
returnnew: 是否返回更新后记录（可选参数，可不填）
flag: 标志位（可选参数，可不填）		cmd=queryandupdate&name=sample.employee&updator={$set:{“age”:100}}&filter={“name”:”hello”}&returnnew=true
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}
{
返回表里的记录
}
…		[{ “errno”: 0 },{ “_id”:{ “$oid”:”54def72f0d8737161d9d6934” },”age”:100,”name”:”hello” }]
说明

Note:

flag既支持字符串形式，也支持数值型。数值型包括十六进制（0x开头）、八进制（0开头）、十进制。
取值如下：
SDB_QUERY_FORCE_HINT(0x00000080)
SDB_QUERY_PARALLED(0x00000100)
SDB_QUERY_WITH_RETURNDATA(0x00000200)
SDB_QUERY_KEEP_SHARDINGKEY_IN_UPDATE(0x00008000)
多个flag用“|”分隔，如flag=SDB_QUERY_FORCE_HINT|SDB_QUERY_PARALLED。

查询删除数据

说明例子
请求头同通用请求头
请求内容cmd: queryandremove
name: 集合的全称（集合空间.集合）
sort: 待排序字段名（可选参数，可不填）
selector: 查询结果列（可选参数，可不填）
skip: 跳过多少行（可选参数，可不填）
returnnum: 最大返回条数（可选参数，可不填）
filter: 查询条件（可选参数，可不填）		cmd=queryandremove&name=sample.employee&filter={“name”:”hello”}
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}
{
返回表里的记录
}
…		[{ “errno”: 0 },{ “_id”:{ “$oid”:”54def72f0d8737161d9d6934” },”age”:12,”name”:”hello” }]
说明

删除记录

说明例子
请求头同通用请求头
请求内容cmd: delete
name: 集合的全称（集合空间.集合）
deletor: 删除条件		cmd=delete&name=sample.employee&deletor={“name”:”hello”}
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

更新记录

说明例子
请求头同通用请求头
请求内容cmd: update
name: 集合的全称（集合空间.集合）
updator: 更新操作
filter: 更新条件
flag: 标志位（可选参数，可不填）		cmd=update&name=sample.employee&updator={$set:{“age”:100}}&filter={“name”:”hello”}&flag=SDB_UPDATE_KEEP_SHARDINGKEY
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

Note:
flag既支持字符串形式，也支持数值型。数值型包括十六进制（0x开头）、八进制（0开头）、十进制。
取值如下：
SDB_UPDATE_KEEP_SHARDINGKEY(0x00008000)

更新或插入记录

说明例子
请求头同通用请求头
请求内容cmd: upsert
name: 集合的全称（集合空间.集合）
updator: 更新操作
filter: 更新条件（可选参数，可不填）
setoninsert: 插入数据（可选参数，可不填）
flag: 标志位（可选参数，可不填）		cmd=upsert&name=sample.employee&updator={$set:{“age”:100}}&filter={“name”:”hello”}&setoninsert={“sex”:”male”}&flag=SDB_UPDATE_KEEP_SHARDINGKEY
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

Note:
flag既支持字符串形式，也支持数值型。数值型包括十六进制（0x开头）、八进制（0开头）、十进制。
取值如下：
SDB_UPDATE_KEEP_SHARDINGKEY(0x00008000)

获取记录数

说明例子
请求头同通用请求头
请求内容cmd: get count
name: 集合的全称（集合空间.集合）
filter: 过滤条件（可选）		cmd=get count&name=sample.employee
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}
{
Total: 总计数
}		[{ “errno”: 0 },{ “Total”:1 }]
说明

修改表属性

说明例子
请求头同通用请求头
请求内容cmd: alter collection
name: 集合的全称（集合空间.集合）
options: 属性		cmd=alter collection&name=sample.employee&options={ShardingKey:{age:1},ShardingType:”hash”}
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

表分区

说明例子
请求头同通用请求头
请求内容cmd: split
name: 集合的全称（集合空间.集合）
source: 源数据组
target: 目标数据组
splitpercent: 百分比
splitquery: 开始条件
splitendquery: 结束条件		cmd=split&name=sample.employee&source=group1&target=group2&splitpercent=50
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

列出数据组

说明例子
请求头同通用请求头
请求内容cmd: list groupscmd=list groups
说明
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}
{
返回数据组的内容
}		[{ “errno”: 0 }]
说明

收集统计信息

说明例子
请求头同通用请求头
请求内容cmd: analyze
options: 设定分析模式、指定集合空间以及命令位置参数		cmd=analyze
cmd=analyze&options={Collection:”sample.employee”}
说明请参考 db.analyze()
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

查询快照

说明例子
请求头同通用请求头
请求内容cmd: snapshot [type]
sort: 待排序字段名（可选参数，可不填）
selector: 查询结果列（可选参数，可不填）
filter: 查询条件（可选参数，可不填）
hint: 快照参数，格式: { $options: {<options>} }（可选参数，可不填）
skip: 跳过多少行（可选参数，可不填）
returnnum: 最大返回条数（可选参数，可不填）		cmd=snapshot health&filter={“IsPrimary”:false}&selector={“NodeName”:null}&sort={“NodeName”:-1}
说明请参考 db.snapshot()
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}
{
返回快照
}
…		[{ “errno”: 0 },{ “NodeName”: “ubuntu-test-03:41000” },{ “NodeName”: “ubuntu-test-03:40000” }]
说明

Note:
[type]指快照类型，分别有：
contexts
contexts current
sessions
sessions current
collections
collectionspaces
database
system
catalog
accessplans
health
configs

更新配置参数

说明例子
请求头同通用请求头
请求内容cmd: update config
configs: 配置参数，包含配置名和配置值
options: 命令位置参数		cmd=update config
cmd=update config&configs={‘diagnum’:27}&options={‘svcname’:’20000’}
说明请参考 db.updateConf()
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明

删除配置参数

说明例子
请求头同通用请求头
请求内容cmd: delete config
configs: 配置参数，包含配置名和配置值
options: 命令位置参数		cmd=update config
cmd=update config&configs={‘diagnum’:1}&options={‘svcname’:’20000’}
说明请参考 db.deleteConf()
响应头同通用响应头
响应内容{
errno: 返回值，0表示成功，其他为失败
description: 失败时的错误描述
}		[{ “errno”: 0 }]
说明