# 图管理接口
# 接口列表:
# 创建数据库
# 方法
POST
# URL
/api/graph/create
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
parameters | map<string,string> | 可选参数列表 | 否 | * | {} |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 创建数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/create -d '{"db_name":"modelroom1_v4","parameters":{}}'
# 测试结果示例
"cost_time" : 0.46348858399999998,
"message" : "OK.",
"status" : 0
# 通过文件创建数据库
# 方法
POST
# URL
/api/graph/create/filepath
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
schema_path | string | schema文件路径 | 否 | "" | * | |
import_conf_path | string | 数据文件路径 | 否 | "" | * |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 创建数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/create/filepath -d '{"db_name":"modelroom1_v3","schema_path":"/Users/xxx/ezoodb/native_test/data/loadtest_v2/schema.txt", "import_conf_path":"/Users/xxx/ezoodb/native_test/data/loadtest_v2/import_conf.txt"}'
# 测试结果(仅供参考)
"cost_time" : 1.548527084,
"message" : "OK.",
"status" : 0
# 删除数据库
# 方法
POST
# URL
/api/graph/drop
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
parameters | map<string,string> | 可选参数列表 | 否 | * | {} |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 删除数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/drop -d '{"db_name":"modelroom1_v4","parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.054155416999999997,
"message" : "OK.",
"status" : 0
# 导出图数据
# 方法
POST
# URL
/api/graph/export
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
parameters | map<string,string> | 可选参数列表 | 否 | * | {} |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 刷新数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/export -d '{"db_name":"modelroom1_v3","parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.0,
"message" : "",
"status" : 0
# 打开数据库
# 方法
POST
# URL
/api/graph/open
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
parameters | map<string,string> | 可选参数列表 | 否 | * | {} |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 打开数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/open -d '{"db_name":"modelroom1_v3","parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.0032709589999999999,
"message" : "OK.",
"status" : 0
# 关闭数据库
# 方法
POST
# URL
/api/graph/close
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
parameters | map<string,string> | 可选参数列表 | 否 | * | {} |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 关闭数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/close -d '{"db_name":"modelroom1_v3","parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.0032709589999999999,
"message" : "OK.",
"status" : 0
# 刷新数据库
# 方法
POST
# URL
/api/graph/reload
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
db_name | string | 数据库名称 | 否 | "" | "ezoo" | |
parameters | map<string,string> | 可选参数列表 | 否 | * | {} |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | Response | 刷新数据库响应结果 | 否 | * | * | Response |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/reload -d '{"db_name":"modelroom1_v3","parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.0032709589999999999,
"message" : "OK.",
"status" : 0
# 获取数据库列表
# 方法
POST
# URL
/api/graph/query/list
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
parameters | map<string,string> | 可选参数列表 | 否 | * | {} | key-value形式参数,暂时传空map。 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_list | 数据库列表结构 | 否 | * | * | graph_list |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/query/list -d '{"parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.001265167,
"message" : "OK.",
"name_list" :
[
"admin",
"modelroom1_v3"
],
"status" : 0
# 获取活跃数据库列表
# 方法
POST
# URL
/api/graph/query/active/list
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
parameters | map<string,string> | 可选参数列表 | 否 | * | {} | key-value形式参数,暂时传空map。 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | graph_list | 数据库列表结构 | 否 | * | * | graph_list |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/query/active/list -d '{"parameters":{}}'
# 测试结果(仅供参考)
"cost_time" : 0.001265167,
"message" : "OK.",
"name_list" :
[
"admin",
"modelroom1_v3"
],
"status" : 0
# 获取数据库状态
# 方法
POST
# URL
/api/graph/query/status
# 参数
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
parameters | map<string,string> | 可选参数列表 | 否 | * | {} | 传参:is_all 或者 db_name 任选一 |
# 返回值
参数列表 | 类型 | 描述 | 是否可空 | 默认值 | 示例 | 备注 |
---|---|---|---|---|---|---|
_return | server_info | 获取数据库状态响应结果 | 否 | * | * | server_info |
# 测试用例
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/query/status -d '{"parameters":{"is_all":"true"}}'
或者
curl -X POST -H "Content-Type: application/json" 127.0.0.1:9898/api/graph/query/status -d '{"parameters":{"db_name":"modelroom1_v3"}}'
# 测试结果(仅供参考)
"cluster_infos" : null,
"cost_time" : 0.0026589579999999999,
"graph_infos" :
{
"admin" :
{
"checkpoint" : -1,
"mem_size" : -1,
"offset" : -1,
"status" : 0
},
"modelroom1_v3" :
{
"checkpoint" : -1,
"mem_size" : -1,
"offset" : -1,
"status" : 0
}
},
"message" : "OK.",
"status" : 0,
"version" : "0.9"