6.1 Graphs
6.1.1 创建一个新图
Method & Url
POST http://localhost:8080/graphs/hugegraph2
Request Body
# gremlin entrence to create graph
gremlin.graph=com.baidu.hugegraph.HugeFactory
# cache config
#schema.cache_capacity=1048576
#graph.cache_capacity=10485760
#graph.cache_expire=600
# schema illegal name template
#schema.illegal_name_regex=\s+|~.*
#vertex.default_label=vertex
backend=cassandra
serializer=cassandra
store=hugegraph2
...
Response Status
201
Response Body
{
"name": "hugegraph2",
"backend": "cassandra"
}
6.1.2 列出数据库中全部的图
Method & Url
GET http://localhost:8080/graphs
Response Status
200
Response Body
{
"graphs": [
"hugegraph",
"hugegraph2"
]
}
6.1.3 查看某个图的信息
Method & Url
GET http://localhost:8080/graphs/hugegraph
Response Status
200
Response Body
{
"name": "hugegraph",
"backend": "cassandra"
}
6.1.4 清空某个图的全部数据，包括schema、vertex、edge和index等，该操作需要管理员权限
Method & Url
PUT http://localhost:8080/graphs/hugegraph
Request Body
{
"action": "clear",
"confirm_message": "I'm sure to delete all data"
}
Response Status
200
6.1.5 删除某个图，该操作需要管理员权限
Params
由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：
- confirm_message: 默认为
I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph?confirm_message=I%27m+sure+to+drop+the+graph
Response Status
204
6.2 Conf
6.2.1 查看某个图的配置，该操作需要管理员权限
Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
Response Status
200
Response Body
# gremlin entrence to create graph
gremlin.graph=com.baidu.hugegraph.HugeFactory
# cache config
#schema.cache_capacity=1048576
#graph.cache_capacity=10485760
#graph.cache_expire=600
# schema illegal name template
#schema.illegal_name_regex=\s+|~.*
#vertex.default_label=vertex
backend=cassandra
serializer=cassandra
store=hugegraph
...
6.3 Mode
合法的图模式包括：NONE，RESTORING，MERGING，LOADING
- None 模式（默认），元数据和图数据的写入属于正常状态。特别的：
- 元数据（schema）创建时不允许指定 ID
- 图数据（vertex）在 id strategy 为 Automatic 时，不允许指定 ID
- LOADING：批量导入数据时自动启用，特别的：
- 添加顶点/边时，不会检查必填属性是否传入
Restore 时存在两种不同的模式： Restoring 和 Merging
- Restoring 模式，恢复到一个新图中，特别的：
- 元数据（schema）创建时允许指定 ID
- 图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID
- Merging 模式，合并到一个已存在元数据和图数据的图中，特别的：
- 元数据（schema）创建时不允许指定 ID
- 图数据（vertex）在 id strategy 为 Automatic 时，允许指定 ID
正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging 模式，并在完成 Restore 时，恢复图模式为 None。
6.3.1 查看某个图的模式. 该操作需要管理员权限
Method & Url
GET http://localhost:8080/graphs/hugegraph/mode
Response Status
200
Response Body
{
"mode": "NONE"
}
合法的图模式包括：NONE，RESTORING，MERGING
6.3.2 设置某个图的模式. 该操作需要管理员权限
Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
Request Body
"RESTORING"
合法的图模式包括：NONE，RESTORING，MERGING
Response Status
200
Response Body
{
"mode": "RESTORING"
}
6.4 Graph Read Mode
合法的图的读模式包括：OLTP_ONLY, ALL
- OLTP 模式（默认），图的查询结果只包含OLTP类型的属性，不包含OLAP属性
- ALL 模式，图的查询结果既包含OLTP类型的属性，又包含OLAP属性（如果有）
6.4.1 查看某个图的读模式
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
Response Status
200
Response Body
{
"graph_read_mode": "OLTP_ONLY"
}
6.4.2 设置某个图的读模式. 该操作需要管理员权限
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"ALL"
合法的图模式包括：OLTP_ONLY，ALL
Response Status
200
Response Body
{
"graph_read_mode": "ALL"
}