From eef5d5cb1398a90a6a953434f00ac919e3f230e1 Mon Sep 17 00:00:00 2001 From: imbajin Date: Mon, 18 Sep 2023 09:51:16 +0000 Subject: [PATCH] doc: update gremlin config in graphs.md (#282) line126: gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy * enhance a string of style problem & fix package name --------- Co-authored-by: imbajin 3baae60dffe15f6e70b1e1bd26c8ad11530208cc --- cn/docs/_print/index.html | 108 +++++++------- cn/docs/clients/_print/index.html | 108 +++++++------- cn/docs/clients/restful-api/_print/index.html | 108 +++++++------- cn/docs/clients/restful-api/graphs/index.html | 116 +++++++-------- cn/docs/clients/restful-api/index.xml | 114 +++++++-------- cn/sitemap.xml | 2 +- docs/_print/index.html | 129 ++++++++--------- docs/clients/_print/index.html | 129 ++++++++--------- docs/clients/restful-api/_print/index.html | 129 ++++++++--------- docs/clients/restful-api/graphs/index.html | 130 +++++++++-------- docs/clients/restful-api/index.xml | 134 +++++++++--------- docs/index.xml | 134 +++++++++--------- en/sitemap.xml | 2 +- sitemap.xml | 2 +- 14 files changed, 678 insertions(+), 667 deletions(-) diff --git a/cn/docs/_print/index.html b/cn/docs/_print/index.html index d475374d4..71b06e8b9 100644 --- a/cn/docs/_print/index.html +++ b/cn/docs/_print/index.html @@ -5303,52 +5303,51 @@

5.1.4 删除某个键值对

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/variables/name
Response Status
204

5.1.12 - Graphs API

6.1 Graphs

6.1.1 列出数据库中全部的图

Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
+
Response Status
200
+
Response Body
{
+    "graphs": [
         "hugegraph",
         "hugegraph1"
     ]
 }

6.1.2 查看某个图的信息

Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph",
+    "backend": "cassandra"
 }
-

6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，该操作需要管理员权限

Params

由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
+

6.1.3 清空某个图的全部数据，包括 schema、vertex、edge 和 index 等，该操作需要管理员权限

Params

由于清空图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204

6.1.4 克隆一个图，该操作需要管理员权限

Params
  • clone_graph_name: 已有图的名称；从已有的图来克隆，用户可选择传递配置文件，传递时将替换已有图中的配置；
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body 【可选】
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body【可选】
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph_clone",
+    "backend": "rocksdb"
 }

6.1.5 创建一个图，该操作需要管理员权限

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph2",
+    "backend": "rocksdb"
 }
-

6.1.6 删除某个图及其全部数据

Params

由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
+

6.1.6 删除某个图及其全部数据

Params

由于删除图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204

6.2 Conf

6.2.1 查看某个图的配置，该操作需要管理员权限

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
Response Body
# gremlin entrence to create graph
-gremlin.graph=com.baidu.hugegraph.HugeFactory
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -5363,46 +5362,47 @@
 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
+...=
+

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"
+

合法的图模式包括：NONE，RESTORING，MERGING

Response Status
200
+
Response Body
{
+    "mode": "RESTORING"
 }
-

6.3.3 查看某个图的读模式.

Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+

6.3.3 查看某个图的读模式。

Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
+
Response Status
200
+
Response Body
{
+    "graph_read_mode": "ALL"
 }
-

6.3.4 设置某个图的读模式. 该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
+

6.3.4 设置某个图的读模式。该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
+
Response Body
{
+    "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 创建快照

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_created"
 }

6.4.2 快照恢复

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_resumed"
 }

6.5 Compact

6.5.1 手动压缩图，该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
+
Response Status
200
+
Response Body
{
+    "nodes": 1,
+    "cluster_id": "local",
+    "servers": {
+        "local": "OK"
     }
 }

5.1.13 - Task API

7.1 Task

7.1.1 列出某个图中全部的异步任务

Params
  • status: 异步任务的状态
  • limit：返回异步任务数目上限
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
diff --git a/cn/docs/clients/_print/index.html b/cn/docs/clients/_print/index.html
index 7e0dcc531..98bdf3733 100644
--- a/cn/docs/clients/_print/index.html
+++ b/cn/docs/clients/_print/index.html
@@ -3520,52 +3520,51 @@

5.1.4 删除某个键值对

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/variables/name
Response Status
204

1.12 - Graphs API

6.1 Graphs

6.1.1 列出数据库中全部的图

Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
+
Response Status
200
+
Response Body
{
+    "graphs": [
         "hugegraph",
         "hugegraph1"
     ]
 }

6.1.2 查看某个图的信息

Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph",
+    "backend": "cassandra"
 }
-

6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，该操作需要管理员权限

Params

由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
+

6.1.3 清空某个图的全部数据，包括 schema、vertex、edge 和 index 等，该操作需要管理员权限

Params

由于清空图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204

6.1.4 克隆一个图，该操作需要管理员权限

Params
  • clone_graph_name: 已有图的名称；从已有的图来克隆，用户可选择传递配置文件，传递时将替换已有图中的配置；
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body 【可选】
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body【可选】
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph_clone",
+    "backend": "rocksdb"
 }

6.1.5 创建一个图，该操作需要管理员权限

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph2",
+    "backend": "rocksdb"
 }
-

6.1.6 删除某个图及其全部数据

Params

由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
+

6.1.6 删除某个图及其全部数据

Params

由于删除图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204

6.2 Conf

6.2.1 查看某个图的配置，该操作需要管理员权限

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
Response Body
# gremlin entrence to create graph
-gremlin.graph=com.baidu.hugegraph.HugeFactory
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -3580,46 +3579,47 @@
 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
+...=
+

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"
+

合法的图模式包括：NONE，RESTORING，MERGING

Response Status
200
+
Response Body
{
+    "mode": "RESTORING"
 }
-

6.3.3 查看某个图的读模式.

Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+

6.3.3 查看某个图的读模式。

Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
+
Response Status
200
+
Response Body
{
+    "graph_read_mode": "ALL"
 }
-

6.3.4 设置某个图的读模式. 该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
+

6.3.4 设置某个图的读模式。该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
+
Response Body
{
+    "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 创建快照

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_created"
 }

6.4.2 快照恢复

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_resumed"
 }

6.5 Compact

6.5.1 手动压缩图，该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
+
Response Status
200
+
Response Body
{
+    "nodes": 1,
+    "cluster_id": "local",
+    "servers": {
+        "local": "OK"
     }
 }

1.13 - Task API

7.1 Task

7.1.1 列出某个图中全部的异步任务

Params
  • status: 异步任务的状态
  • limit：返回异步任务数目上限
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
diff --git a/cn/docs/clients/restful-api/_print/index.html b/cn/docs/clients/restful-api/_print/index.html
index 2b3e6da74..1fada6631 100644
--- a/cn/docs/clients/restful-api/_print/index.html
+++ b/cn/docs/clients/restful-api/_print/index.html
@@ -3522,52 +3522,51 @@

5.1.4 删除某个键值对

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/variables/name
Response Status
204

12 - Graphs API

6.1 Graphs

6.1.1 列出数据库中全部的图

Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
+
Response Status
200
+
Response Body
{
+    "graphs": [
         "hugegraph",
         "hugegraph1"
     ]
 }

6.1.2 查看某个图的信息

Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph",
+    "backend": "cassandra"
 }
-

6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，该操作需要管理员权限

Params

由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
+

6.1.3 清空某个图的全部数据，包括 schema、vertex、edge 和 index 等，该操作需要管理员权限

Params

由于清空图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204

6.1.4 克隆一个图，该操作需要管理员权限

Params
  • clone_graph_name: 已有图的名称；从已有的图来克隆，用户可选择传递配置文件，传递时将替换已有图中的配置；
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body 【可选】
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body【可选】
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph_clone",
+    "backend": "rocksdb"
 }

6.1.5 创建一个图，该操作需要管理员权限

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph2",
+    "backend": "rocksdb"
 }
-

6.1.6 删除某个图及其全部数据

Params

由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
+

6.1.6 删除某个图及其全部数据

Params

由于删除图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：

  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204

6.2 Conf

6.2.1 查看某个图的配置，该操作需要管理员权限

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
Response Body
# gremlin entrence to create graph
-gremlin.graph=com.baidu.hugegraph.HugeFactory
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -3582,46 +3581,47 @@
 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
+...=
+

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"
+

合法的图模式包括：NONE，RESTORING，MERGING

Response Status
200
+
Response Body
{
+    "mode": "RESTORING"
 }
-

6.3.3 查看某个图的读模式.

Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+

6.3.3 查看某个图的读模式。

Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
+
Response Status
200
+
Response Body
{
+    "graph_read_mode": "ALL"
 }
-

6.3.4 设置某个图的读模式. 该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
+

6.3.4 设置某个图的读模式。该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
+
Response Body
{
+    "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 创建快照

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_created"
 }

6.4.2 快照恢复

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_resumed"
 }

6.5 Compact

6.5.1 手动压缩图，该操作需要管理员权限

Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
+
Response Status
200
+
Response Body
{
+    "nodes": 1,
+    "cluster_id": "local",
+    "servers": {
+        "local": "OK"
     }
 }

13 - Task API

7.1 Task

7.1.1 列出某个图中全部的异步任务

Params
  • status: 异步任务的状态
  • limit：返回异步任务数目上限
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
diff --git a/cn/docs/clients/restful-api/graphs/index.html b/cn/docs/clients/restful-api/graphs/index.html
index 7f2f0fd88..4bd9e3fdc 100644
--- a/cn/docs/clients/restful-api/graphs/index.html
+++ b/cn/docs/clients/restful-api/graphs/index.html
@@ -6,62 +6,61 @@
 200
 Response Body
 {
-    "graphs": [ …">
+    "graphs": [ …">
 
Graphs API
6.1 Graphs
6.1.1 列出数据库中全部的图
Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
+
Response Status
200
+
Response Body
{
+    "graphs": [
         "hugegraph",
         "hugegraph1"
     ]
 }
 
6.1.2 查看某个图的信息
Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph",
+    "backend": "cassandra"
 }
-
6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，该操作需要管理员权限
Params
由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：
  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
+
6.1.3 清空某个图的全部数据，包括 schema、vertex、edge 和 index 等，该操作需要管理员权限
Params
由于清空图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：
  • confirm_message: 默认为I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204
 
6.1.4 克隆一个图，该操作需要管理员权限
Params
  • clone_graph_name: 已有图的名称；从已有的图来克隆，用户可选择传递配置文件，传递时将替换已有图中的配置；
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body 【可选】
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body【可选】
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph_clone",
+    "backend": "rocksdb"
 }
 
6.1.5 创建一个图，该操作需要管理员权限
Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+    "name": "hugegraph2",
+    "backend": "rocksdb"
 }
-
6.1.6 删除某个图及其全部数据
Params
由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：
  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
+
6.1.6 删除某个图及其全部数据
Params
由于删除图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：
  • confirm_message: 默认为I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204
 
6.2 Conf
6.2.1 查看某个图的配置，该操作需要管理员权限
Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
 
Response Body
# gremlin entrence to create graph
-gremlin.graph=com.baidu.hugegraph.HugeFactory
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -76,49 +75,50 @@
 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"
+...=
+
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
+
合法的图模式包括：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"
+
合法的图模式包括：NONE，RESTORING，MERGING
Response Status
200
+
Response Body
{
+    "mode": "RESTORING"
 }
-
6.3.3 查看某个图的读模式.
Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+
6.3.3 查看某个图的读模式。
Params
  • name: 图的名称
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
+
Response Status
200
+
Response Body
{
+    "graph_read_mode": "ALL"
 }
-
6.3.4 设置某个图的读模式. 该操作需要管理员权限
Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
+
6.3.4 设置某个图的读模式。该操作需要管理员权限
Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
 
Request Body
"OLTP_ONLY"
-
合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY
Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+
合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY
Response Status
200
+
Response Body
{
+    "graph_read_mode": "OLTP_ONLY"
 }
 
6.4 Snapshot
6.4.1 创建快照
Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_created"
 }
 
6.4.2 快照恢复
Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
+
Response Status
200
+
Response Body
{
+    "hugegraph": "snapshot_resumed"
 }
 
6.5 Compact
6.5.1 手动压缩图，该操作需要管理员权限
Params
  • name: 图的名称
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
+
Response Status
200
+
Response Body
{
+    "nodes": 1,
+    "cluster_id": "local",
+    "servers": {
+        "local": "OK"
     }
 }
-

Last modified May 27, 2022: divide create graph into clone and create (665739b7)

+

Last modified September 18, 2023: doc: update gremlin config in graphs.md (#282) (3baae60d)
diff --git a/cn/docs/clients/restful-api/index.xml b/cn/docs/clients/restful-api/index.xml index c63fb70c7..1f7527f96 100644 --- a/cn/docs/clients/restful-api/index.xml +++ b/cn/docs/clients/restful-api/index.xml @@ -5198,10 +5198,10 @@ <h5 id="method--url">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs </span></span></code></pre></div><h5 id="response-status">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graphs&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graphs&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph1&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> @@ -5210,22 +5210,22 @@ <h5 id="method--url-1">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph </span></span></code></pre></div><h5 id="response-status-1">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-1">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;cassandra&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;cassandra&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="613-清空某个图的全部数据包括schemavertexedge和index等该操作需要管理员权限">6.1.3 清空某个图的全部数据，包括schema、vertex、edge和index等，<strong>该操作需要管理员权限</strong></h4> +</span></span></code></pre></div><h4 id="613-清空某个图的全部数据包括-schemavertexedge-和-index-等该操作需要管理员权限">6.1.3 清空某个图的全部数据，包括 schema、vertex、edge 和 index 等，<strong>该操作需要管理员权限</strong></h4> <h5 id="params">Params</h5> -<p>由于清空图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：</p> +<p>由于清空图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：</p> <ul> <li>confirm_message: 默认为<code>I'm sure to delete all data</code></li> </ul> <h5 id="method--url-2">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data </span></span></code></pre></div><h5 id="response-status-2">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> </span></span></code></pre></div><h4 id="614-克隆一个图该操作需要管理员权限">6.1.4 克隆一个图，<strong>该操作需要管理员权限</strong></h4> <h5 id="params-1">Params</h5> <ul> @@ -5233,57 +5233,56 @@ </ul> <h5 id="method--url-3">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph -</span></span></code></pre></div><h5 id="request-body-可选">Request Body 【可选】</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy +</span></span></code></pre></div><h5 id="request-body可选">Request Body【可选】</h5> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy </span></span><span style="display:flex;"><span>backend=rocksdb </span></span><span style="display:flex;"><span>serializer=binary </span></span><span style="display:flex;"><span>store=hugegraph_clone </span></span><span style="display:flex;"><span>rocksdb.data_path=./hg2 </span></span><span style="display:flex;"><span>rocksdb.wal_path=./hg2 </span></span></code></pre></div><h5 id="response-status-3">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-2">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph_clone&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph_clone&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="615-创建一个图该操作需要管理员权限">6.1.5 创建一个图，<strong>该操作需要管理员权限</strong></h4> <h5 id="method--url-4">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>POST http://localhost:8080/graphs/hugegraph2 </span></span></code></pre></div><h5 id="request-body">Request Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy </span></span><span style="display:flex;"><span>backend=rocksdb </span></span><span style="display:flex;"><span>serializer=binary </span></span><span style="display:flex;"><span>store=hugegraph2 </span></span><span style="display:flex;"><span>rocksdb.data_path=./hg2 </span></span><span style="display:flex;"><span>rocksdb.wal_path=./hg2 </span></span></code></pre></div><h5 id="response-status-4">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-3">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph2&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph2&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="616-删除某个图及其全部数据">6.1.6 删除某个图及其全部数据</h4> <h5 id="params-2">Params</h5> -<p>由于删除图是一个比较危险的操作，为避免用户误调用，我们给API添加了用于确认的参数：</p> +<p>由于删除图是一个比较危险的操作，为避免用户误调用，我们给 API 添加了用于确认的参数：</p> <ul> <li>confirm_message: 默认为<code>I'm sure to drop the graph</code></li> </ul> <h5 id="method--url-5">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph </span></span></code></pre></div><h5 id="response-status-5">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> </span></span></code></pre></div><h3 id="62-conf">6.2 Conf</h3> <h4 id="621-查看某个图的配置该操作需要管理员权限">6.2.1 查看某个图的配置，<strong>该操作需要管理员权限</strong></h4> <h5 id="method--url-6">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/conf </span></span></code></pre></div><h5 id="response-status-6">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-4">Response Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span># gremlin entrence to create graph -</span></span><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.HugeFactory -</span></span><span style="display:flex;"><span> +</span></span><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.HugeFactory </span></span><span style="display:flex;"><span># cache config </span></span><span style="display:flex;"><span>#schema.cache_capacity=1048576 </span></span><span style="display:flex;"><span>#graph.cache_capacity=10485760 @@ -5298,7 +5297,7 @@ </span></span><span style="display:flex;"><span>serializer=cassandra </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span>store=hugegraph -</span></span><span style="display:flex;"><span>... +</span></span><span style="display:flex;"><span>...= </span></span></code></pre></div><h3 id="63-mode">6.3 Mode</h3> <p>合法的图模式包括：NONE，RESTORING，MERGING，LOADING</p> <ul> @@ -5314,7 +5313,7 @@ </ul> </li> </ul> -<p>Restore 时存在两种不同的模式： Restoring 和 Merging</p> +<p>Restore 时存在两种不同的模式：Restoring 和 Merging</p> <ul> <li>Restoring 模式，恢复到一个新图中，特别的： <ul> @@ -5329,20 +5328,21 @@ </ul> </li> </ul> -<p>正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging 模式，并在完成 Restore 时，恢复图模式为 None。</p> -<h4 id="631-查看某个图的模式">6.3.1 查看某个图的模式.</h4> +<p>正常情况下，图模式为 None，当需要 Restore 图时，需要根据需要临时修改图模式为 Restoring 模式或者 Merging +模式，并在完成 Restore 时，恢复图模式为 None。</p> +<h4 id="631-查看某个图的模式">6.3.1 查看某个图的模式。</h4> <h5 id="method--url-7">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/mode </span></span></code></pre></div><h5 id="response-status-7">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-5">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><blockquote> <p>合法的图模式包括：NONE，RESTORING，MERGING</p> </blockquote> -<h4 id="632-设置某个图的模式-该操作需要管理员权限">6.3.2 设置某个图的模式. <strong>该操作需要管理员权限</strong></h4> +<h4 id="632-设置某个图的模式该操作需要管理员权限">6.3.2 设置某个图的模式。<strong>该操作需要管理员权限</strong></h4> <h5 id="method--url-8">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/mode </span></span></code></pre></div><h5 id="request-body-1">Request Body</h5> @@ -5351,12 +5351,12 @@ <p>合法的图模式包括：NONE，RESTORING，MERGING</p> </blockquote> <h5 id="response-status-8">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-6">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;RESTORING&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;RESTORING&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="633-查看某个图的读模式">6.3.3 查看某个图的读模式.</h4> +</span></span></code></pre></div><h4 id="633-查看某个图的读模式">6.3.3 查看某个图的读模式。</h4> <h5 id="params-3">Params</h5> <ul> <li>name: 图的名称</li> @@ -5364,12 +5364,12 @@ <h5 id="method--url-9">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/graph_read_mode </span></span></code></pre></div><h5 id="response-status-9">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-7">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graph_read_mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ALL&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graph_read_mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ALL&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="634-设置某个图的读模式-该操作需要管理员权限">6.3.4 设置某个图的读模式. <strong>该操作需要管理员权限</strong></h4> +</span></span></code></pre></div><h4 id="634-设置某个图的读模式该操作需要管理员权限">6.3.4 设置某个图的读模式。<strong>该操作需要管理员权限</strong></h4> <h5 id="params-4">Params</h5> <ul> <li>name: 图的名称</li> @@ -5382,10 +5382,10 @@ <p>合法的图模式包括：ALL，OLTP_ONLY，OLAP_ONLY</p> </blockquote> <h5 id="response-status-10">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-8">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graph_read_mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OLTP_ONLY&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graph_read_mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OLTP_ONLY&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h3 id="64-snapshot">6.4 Snapshot</h3> <h4 id="641-创建快照">6.4.1 创建快照</h4> @@ -5396,10 +5396,10 @@ <h5 id="method--url-11">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/snapshot_create </span></span></code></pre></div><h5 id="response-status-11">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-9">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_created&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_created&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="642-快照恢复">6.4.2 快照恢复</h4> <h5 id="params-6">Params</h5> @@ -5409,10 +5409,10 @@ <h5 id="method--url-12">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/snapshot_resume </span></span></code></pre></div><h5 id="response-status-12">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-10">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_resumed&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_resumed&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h3 id="65-compact">6.5 Compact</h3> <h4 id="651-手动压缩图该操作需要管理员权限">6.5.1 手动压缩图，<strong>该操作需要管理员权限</strong></h4> @@ -5423,13 +5423,13 @@ <h5 id="method--url-13">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/compact </span></span></code></pre></div><h5 id="response-status-13">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-11">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;nodes&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;cluster_id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;servers&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;local&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OK&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;nodes&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;cluster_id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;servers&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OK&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div>Docs: Task API/cn/docs/clients/restful-api/task/Mon, 01 Jan 0001 00:00:00 +0000/cn/docs/clients/restful-api/task/ diff --git a/cn/sitemap.xml b/cn/sitemap.xml index fbfb69184..1d371e4c3 100644 --- a/cn/sitemap.xml +++ b/cn/sitemap.xml @@ -1 +1 @@ -/cn/docs/guides/architectural/2023-06-25T21:06:07+08:00/cn/docs/config/config-guide/2023-06-21T14:48:04+08:00/cn/docs/language/hugegraph-gremlin/2023-01-01T16:16:43+08:00/cn/docs/performance/hugegraph-benchmark-0.5.6/2022-09-15T15:16:23+08:00/cn/docs/quickstart/hugegraph-server/2023-09-12T12:18:04+08:00/cn/docs/introduction/readme/2023-06-18T14:57:33+08:00/cn/docs/changelog/hugegraph-1.0.0-release-notes/2023-01-09T07:41:46+08:00/cn/docs/clients/restful-api/2023-07-31T23:55:30+08:00/cn/docs/clients/restful-api/schema/2023-05-14T19:35:13+08:00/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-rocksdb/2023-01-01T16:16:43+08:00/cn/docs/contribution-guidelines/contribute/2023-09-09T20:50:32+08:00/cn/docs/config/config-option/2023-02-08T20:56:09+08:00/cn/docs/guides/desgin-concept/2022-04-17T11:36:55+08:00/cn/docs/download/download/2023-06-17T14:43:04+08:00/cn/docs/language/hugegraph-example/2023-02-02T01:21:10+08:00/cn/docs/clients/hugegraph-client/2022-09-15T15:16:23+08:00/cn/docs/performance/api-preformance/2023-06-17T14:43:04+08:00/cn/docs/quickstart/hugegraph-loader/2023-05-17T23:12:35+08:00/cn/docs/clients/restful-api/propertykey/2023-05-19T05:15:56-05:00/cn/docs/changelog/hugegraph-0.11.2-release-notes/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.12.0-release-notes/2023-01-01T16:16:43+08:00/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-cassandra/2023-01-01T16:16:43+08:00/cn/docs/contribution-guidelines/subscribe/2023-06-17T14:43:04+08:00/cn/docs/config/config-authentication/2022-04-17T11:36:55+08:00/cn/docs/clients/gremlin-console/2023-06-12T23:52:07+08:00/cn/docs/guides/custom-plugin/2022-09-15T15:16:23+08:00/cn/docs/performance/hugegraph-loader-performance/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-tools/2023-05-09T21:27:34+08:00/cn/docs/quickstart/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.10.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/vertexlabel/2022-04-17T11:36:55+08:00/cn/docs/contribution-guidelines/validate-release/2023-02-15T16:14:21+08:00/cn/docs/guides/backup-restore/2022-04-17T11:36:55+08:00/cn/docs/config/2022-04-17T11:36:55+08:00/cn/docs/config/config-https/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/edgelabel/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.9.2-release-notes/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-hubble/2023-09-12T12:18:04+08:00/cn/docs/contribution-guidelines/hugegraph-server-idea-setup/2023-06-25T21:06:07+08:00/cn/docs/clients/2022-04-17T11:36:55+08:00/cn/docs/config/config-computer/2023-01-01T16:16:43+08:00/cn/docs/guides/faq/2023-01-04T22:59:07+08:00/cn/docs/clients/restful-api/indexlabel/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.8.0-release-notes/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-client/2023-05-18T11:09:55+08:00/cn/docs/guides/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/rebuild/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.7.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-computer/2023-06-25T21:06:46+08:00/cn/docs/language/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.6.1-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/vertex/2023-06-04T23:04:47+08:00/cn/docs/clients/restful-api/edge/2023-06-29T10:17:29+08:00/cn/docs/performance/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.5.6-release-notes/2022-04-17T11:36:55+08:00/cn/docs/changelog/2022-04-17T11:36:55+08:00/cn/docs/contribution-guidelines/2022-12-30T19:57:48+08:00/cn/docs/changelog/hugegraph-0.4.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/traverser/2023-09-15T11:15:58+08:00/cn/docs/clients/restful-api/rank/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.3.3-release-notes/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.2-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/variable/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/graphs/2022-05-27T09:27:37+08:00/cn/docs/changelog/hugegraph-0.2.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/task/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/gremlin/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/cypher/2023-07-31T23:55:30+08:00/cn/docs/clients/restful-api/auth/2023-07-31T23:55:30+08:00/cn/docs/clients/restful-api/other/2023-07-31T23:55:30+08:00/cn/docs/2022-12-30T19:57:48+08:00/cn/blog/news/2022-04-17T11:36:55+08:00/cn/blog/releases/2022-04-17T11:36:55+08:00/cn/blog/2018/10/06/easy-documentation-with-docsy/2022-04-17T11:36:55+08:00/cn/blog/2018/10/06/the-second-blog-post/2022-04-17T11:36:55+08:00/cn/blog/2018/01/04/another-great-release/2022-04-17T11:36:55+08:00/cn/docs/cla/2022-04-17T11:36:55+08:00/cn/docs/performance/hugegraph-benchmark-0.4.4/2022-09-15T15:16:23+08:00/cn/docs/summary/2023-07-31T23:55:30+08:00/cn/blog/2022-04-17T11:36:55+08:00/cn/categories//cn/community/2022-04-17T11:36:55+08:00/cn/2023-01-04T22:59:07+08:00/cn/search/2022-04-17T11:36:55+08:00/cn/tags/ \ No newline at end of file +/cn/docs/guides/architectural/2023-06-25T21:06:07+08:00/cn/docs/config/config-guide/2023-06-21T14:48:04+08:00/cn/docs/language/hugegraph-gremlin/2023-01-01T16:16:43+08:00/cn/docs/performance/hugegraph-benchmark-0.5.6/2022-09-15T15:16:23+08:00/cn/docs/quickstart/hugegraph-server/2023-09-12T12:18:04+08:00/cn/docs/introduction/readme/2023-06-18T14:57:33+08:00/cn/docs/changelog/hugegraph-1.0.0-release-notes/2023-01-09T07:41:46+08:00/cn/docs/clients/restful-api/2023-07-31T23:55:30+08:00/cn/docs/clients/restful-api/schema/2023-05-14T19:35:13+08:00/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-rocksdb/2023-01-01T16:16:43+08:00/cn/docs/contribution-guidelines/contribute/2023-09-09T20:50:32+08:00/cn/docs/config/config-option/2023-02-08T20:56:09+08:00/cn/docs/guides/desgin-concept/2022-04-17T11:36:55+08:00/cn/docs/download/download/2023-06-17T14:43:04+08:00/cn/docs/language/hugegraph-example/2023-02-02T01:21:10+08:00/cn/docs/clients/hugegraph-client/2022-09-15T15:16:23+08:00/cn/docs/performance/api-preformance/2023-06-17T14:43:04+08:00/cn/docs/quickstart/hugegraph-loader/2023-05-17T23:12:35+08:00/cn/docs/clients/restful-api/propertykey/2023-05-19T05:15:56-05:00/cn/docs/changelog/hugegraph-0.11.2-release-notes/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.12.0-release-notes/2023-01-01T16:16:43+08:00/cn/docs/performance/api-preformance/hugegraph-api-0.5.6-cassandra/2023-01-01T16:16:43+08:00/cn/docs/contribution-guidelines/subscribe/2023-06-17T14:43:04+08:00/cn/docs/config/config-authentication/2022-04-17T11:36:55+08:00/cn/docs/clients/gremlin-console/2023-06-12T23:52:07+08:00/cn/docs/guides/custom-plugin/2022-09-15T15:16:23+08:00/cn/docs/performance/hugegraph-loader-performance/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-tools/2023-05-09T21:27:34+08:00/cn/docs/quickstart/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.10.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/vertexlabel/2022-04-17T11:36:55+08:00/cn/docs/contribution-guidelines/validate-release/2023-02-15T16:14:21+08:00/cn/docs/guides/backup-restore/2022-04-17T11:36:55+08:00/cn/docs/config/2022-04-17T11:36:55+08:00/cn/docs/config/config-https/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/edgelabel/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.9.2-release-notes/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-hubble/2023-09-12T12:18:04+08:00/cn/docs/contribution-guidelines/hugegraph-server-idea-setup/2023-06-25T21:06:07+08:00/cn/docs/clients/2022-04-17T11:36:55+08:00/cn/docs/config/config-computer/2023-01-01T16:16:43+08:00/cn/docs/guides/faq/2023-01-04T22:59:07+08:00/cn/docs/clients/restful-api/indexlabel/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.8.0-release-notes/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-client/2023-05-18T11:09:55+08:00/cn/docs/guides/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/rebuild/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.7.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/quickstart/hugegraph-computer/2023-06-25T21:06:46+08:00/cn/docs/language/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.6.1-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/vertex/2023-06-04T23:04:47+08:00/cn/docs/clients/restful-api/edge/2023-06-29T10:17:29+08:00/cn/docs/performance/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.5.6-release-notes/2022-04-17T11:36:55+08:00/cn/docs/changelog/2022-04-17T11:36:55+08:00/cn/docs/contribution-guidelines/2022-12-30T19:57:48+08:00/cn/docs/changelog/hugegraph-0.4.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/traverser/2023-09-15T11:15:58+08:00/cn/docs/clients/restful-api/rank/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.3.3-release-notes/2022-04-17T11:36:55+08:00/cn/docs/changelog/hugegraph-0.2-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/variable/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/graphs/2023-09-18T17:50:28+08:00/cn/docs/changelog/hugegraph-0.2.4-release-notes/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/task/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/gremlin/2022-04-17T11:36:55+08:00/cn/docs/clients/restful-api/cypher/2023-07-31T23:55:30+08:00/cn/docs/clients/restful-api/auth/2023-07-31T23:55:30+08:00/cn/docs/clients/restful-api/other/2023-07-31T23:55:30+08:00/cn/docs/2022-12-30T19:57:48+08:00/cn/blog/news/2022-04-17T11:36:55+08:00/cn/blog/releases/2022-04-17T11:36:55+08:00/cn/blog/2018/10/06/easy-documentation-with-docsy/2022-04-17T11:36:55+08:00/cn/blog/2018/10/06/the-second-blog-post/2022-04-17T11:36:55+08:00/cn/blog/2018/01/04/another-great-release/2022-04-17T11:36:55+08:00/cn/docs/cla/2022-04-17T11:36:55+08:00/cn/docs/performance/hugegraph-benchmark-0.4.4/2022-09-15T15:16:23+08:00/cn/docs/summary/2023-07-31T23:55:30+08:00/cn/blog/2022-04-17T11:36:55+08:00/cn/categories//cn/community/2022-04-17T11:36:55+08:00/cn/2023-01-04T22:59:07+08:00/cn/search/2022-04-17T11:36:55+08:00/cn/tags/ \ No newline at end of file diff --git a/docs/_print/index.html b/docs/_print/index.html index 0d7b84f6d..720e1a9a4 100644 --- a/docs/_print/index.html +++ b/docs/_print/index.html @@ -5313,56 +5313,57 @@

5.1.4 Deleting a specific key-value pair

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/variables/name
Response Status
204

5.1.12 - Graphs API

6.1 Graphs

6.1.1 List all graphs

Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
-        "hugegraph",
-        "hugegraph1"
-    ]
+
Response Status
200
+
Response Body
{
+  "graphs": [
+    "hugegraph",
+    "hugegraph1"
+  ]
 }

6.1.2 Get details of the graph

Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
-}
-

6.1.3 Clear all data of a graph，include: schema、vertex、edge and index .etc，This operation requires administrator privileges

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
-

6.1.4 Clone graph，This operation requires administrator privileges

Params
  • clone_graph_name: name of an exist graph. +
Response Status
200
+
Response Body
{
+  "name": "hugegraph",
+  "backend": "cassandra"
+}
+

6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation

requires administrator privileges**

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204
+

6.1.4 Clone graph,This operation requires administrator privileges

Params
  • clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body [Optional]
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body [Optional]
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph_clone",
+  "backend": "rocksdb"
 }
-

6.1.5 Create graph，This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+

6.1.5 Create graph,This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
-}
-

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
-

6.2 Conf

6.2.1 Get configuration for a graph，This operation requires administrator privileges

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph2",
+  "backend": "rocksdb"
+}
+

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204
+

6.2 Conf

6.2.1 Get configuration for a graph,This operation requires administrator privileges

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
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -5377,49 +5378,49 @@
 serializer=cassandra
 
 store=hugegraph
-...
-

6.3 Mode

Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING

  • None mode is regular mode
    • Not allowed create schema with specified id
    • Not support create vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes： Restoring and Merging

  • Restoring mode is used to restore schema and graph data to an new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, +...= +

6.3 Mode

Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING

  • None mode is regular mode
    • Not allowed to create schema with specified id
    • Not support creating vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes: Restoring and Merging

  • Restoring mode is used to restore schema and graph data to a new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed to create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, you need to temporarily modify the graph mode to Restoring or Merging as needed. When you complete the restore, change the graph mode to None.

6.3.1 Get graph mode.

Method & Url
GET http://localhost:8080/graphs/hugegraph/mode
-
Response Status
200
-
Response Body
{
-    "mode": "NONE"
+
Response Status
200
+
Response Body
{
+  "mode": "NONE"
 }
-

Allowed graph mode values are：NONE，RESTORING，MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
+

Allowed graph mode values are: NONE, RESTORING, MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
Request Body
"RESTORING"
-

Allowed graph mode values are：NONE，RESTORING，MERGING

Response Status
200
-
Response Body
{
-    "mode": "RESTORING"
+

Allowed graph mode values are: NONE, RESTORING, MERGING

Response Status
200
+
Response Body
{
+  "mode": "RESTORING"
 }

6.3.3 Get graph’s read mode.

Params
  • name: name of a graph
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+
Response Status
200
+
Response Body
{
+  "graph_read_mode": "ALL"
 }

6.3.4 Modify graph’s read mode. This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY

Response Status
200
+
Response Body
{
+  "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 Create a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_created"
 }

6.4.2 Resume a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
-}
-

6.5 Compact

6.5.1 Manually compact graph，This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
-    }
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_resumed"
+}
+

6.5 Compact

6.5.1 Manually compact graph,This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
+
Response Status
200
+
Response Body
{
+  "nodes": 1,
+  "cluster_id": "local",
+  "servers": {
+    "local": "OK"
+  }
 }

5.1.13 - Task API

7.1 Task

7.1.1 List all async tasks in graph

Params
  • status: the status of asyncTasks
  • limit：the max number of tasks to return
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
Response Status
200
diff --git a/docs/clients/_print/index.html b/docs/clients/_print/index.html
index 3ce418637..38b31d8a9 100644
--- a/docs/clients/_print/index.html
+++ b/docs/clients/_print/index.html
@@ -3524,56 +3524,57 @@

5.1.4 Deleting a specific key-value pair

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/variables/name
Response Status
204

1.12 - Graphs API

6.1 Graphs

6.1.1 List all graphs

Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
-        "hugegraph",
-        "hugegraph1"
-    ]
+
Response Status
200
+
Response Body
{
+  "graphs": [
+    "hugegraph",
+    "hugegraph1"
+  ]
 }

6.1.2 Get details of the graph

Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
-}
-

6.1.3 Clear all data of a graph，include: schema、vertex、edge and index .etc，This operation requires administrator privileges

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
-

6.1.4 Clone graph，This operation requires administrator privileges

Params
  • clone_graph_name: name of an exist graph. +
Response Status
200
+
Response Body
{
+  "name": "hugegraph",
+  "backend": "cassandra"
+}
+

6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation

requires administrator privileges**

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204
+

6.1.4 Clone graph,This operation requires administrator privileges

Params
  • clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body [Optional]
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body [Optional]
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph_clone",
+  "backend": "rocksdb"
 }
-

6.1.5 Create graph，This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+

6.1.5 Create graph,This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
-}
-

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
-

6.2 Conf

6.2.1 Get configuration for a graph，This operation requires administrator privileges

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph2",
+  "backend": "rocksdb"
+}
+

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204
+

6.2 Conf

6.2.1 Get configuration for a graph,This operation requires administrator privileges

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
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -3588,49 +3589,49 @@
 serializer=cassandra
 
 store=hugegraph
-...
-

6.3 Mode

Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING

  • None mode is regular mode
    • Not allowed create schema with specified id
    • Not support create vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes： Restoring and Merging

  • Restoring mode is used to restore schema and graph data to an new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, +...= +

6.3 Mode

Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING

  • None mode is regular mode
    • Not allowed to create schema with specified id
    • Not support creating vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes: Restoring and Merging

  • Restoring mode is used to restore schema and graph data to a new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed to create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, you need to temporarily modify the graph mode to Restoring or Merging as needed. When you complete the restore, change the graph mode to None.

6.3.1 Get graph mode.

Method & Url
GET http://localhost:8080/graphs/hugegraph/mode
-
Response Status
200
-
Response Body
{
-    "mode": "NONE"
+
Response Status
200
+
Response Body
{
+  "mode": "NONE"
 }
-

Allowed graph mode values are：NONE，RESTORING，MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
+

Allowed graph mode values are: NONE, RESTORING, MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
Request Body
"RESTORING"
-

Allowed graph mode values are：NONE，RESTORING，MERGING

Response Status
200
-
Response Body
{
-    "mode": "RESTORING"
+

Allowed graph mode values are: NONE, RESTORING, MERGING

Response Status
200
+
Response Body
{
+  "mode": "RESTORING"
 }

6.3.3 Get graph’s read mode.

Params
  • name: name of a graph
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+
Response Status
200
+
Response Body
{
+  "graph_read_mode": "ALL"
 }

6.3.4 Modify graph’s read mode. This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY

Response Status
200
+
Response Body
{
+  "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 Create a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_created"
 }

6.4.2 Resume a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
-}
-

6.5 Compact

6.5.1 Manually compact graph，This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
-    }
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_resumed"
+}
+

6.5 Compact

6.5.1 Manually compact graph,This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
+
Response Status
200
+
Response Body
{
+  "nodes": 1,
+  "cluster_id": "local",
+  "servers": {
+    "local": "OK"
+  }
 }

1.13 - Task API

7.1 Task

7.1.1 List all async tasks in graph

Params
  • status: the status of asyncTasks
  • limit：the max number of tasks to return
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
Response Status
200
diff --git a/docs/clients/restful-api/_print/index.html b/docs/clients/restful-api/_print/index.html
index 71e90f311..aa92f7886 100644
--- a/docs/clients/restful-api/_print/index.html
+++ b/docs/clients/restful-api/_print/index.html
@@ -3524,56 +3524,57 @@

5.1.4 Deleting a specific key-value pair

Method & Url
DELETE http://localhost:8080/graphs/hugegraph/variables/name
Response Status
204

12 - Graphs API

6.1 Graphs

6.1.1 List all graphs

Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
-        "hugegraph",
-        "hugegraph1"
-    ]
+
Response Status
200
+
Response Body
{
+  "graphs": [
+    "hugegraph",
+    "hugegraph1"
+  ]
 }

6.1.2 Get details of the graph

Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
-}
-

6.1.3 Clear all data of a graph，include: schema、vertex、edge and index .etc，This operation requires administrator privileges

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
-

6.1.4 Clone graph，This operation requires administrator privileges

Params
  • clone_graph_name: name of an exist graph. +
Response Status
200
+
Response Body
{
+  "name": "hugegraph",
+  "backend": "cassandra"
+}
+

6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation

requires administrator privileges**

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204
+

6.1.4 Clone graph,This operation requires administrator privileges

Params
  • clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body [Optional]
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body [Optional]
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph_clone",
+  "backend": "rocksdb"
 }
-

6.1.5 Create graph，This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+

6.1.5 Create graph,This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
-}
-

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
-

6.2 Conf

6.2.1 Get configuration for a graph，This operation requires administrator privileges

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph2",
+  "backend": "rocksdb"
+}
+

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204
+

6.2 Conf

6.2.1 Get configuration for a graph,This operation requires administrator privileges

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
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -3588,49 +3589,49 @@
 serializer=cassandra
 
 store=hugegraph
-...
-

6.3 Mode

Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING

  • None mode is regular mode
    • Not allowed create schema with specified id
    • Not support create vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes： Restoring and Merging

  • Restoring mode is used to restore schema and graph data to an new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, +...= +

6.3 Mode

Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING

  • None mode is regular mode
    • Not allowed to create schema with specified id
    • Not support creating vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes: Restoring and Merging

  • Restoring mode is used to restore schema and graph data to a new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed to create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, you need to temporarily modify the graph mode to Restoring or Merging as needed. When you complete the restore, change the graph mode to None.

6.3.1 Get graph mode.

Method & Url
GET http://localhost:8080/graphs/hugegraph/mode
-
Response Status
200
-
Response Body
{
-    "mode": "NONE"
+
Response Status
200
+
Response Body
{
+  "mode": "NONE"
 }
-

Allowed graph mode values are：NONE，RESTORING，MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
+

Allowed graph mode values are: NONE, RESTORING, MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
Request Body
"RESTORING"
-

Allowed graph mode values are：NONE，RESTORING，MERGING

Response Status
200
-
Response Body
{
-    "mode": "RESTORING"
+

Allowed graph mode values are: NONE, RESTORING, MERGING

Response Status
200
+
Response Body
{
+  "mode": "RESTORING"
 }

6.3.3 Get graph’s read mode.

Params
  • name: name of a graph
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+
Response Status
200
+
Response Body
{
+  "graph_read_mode": "ALL"
 }

6.3.4 Modify graph’s read mode. This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY

Response Status
200
+
Response Body
{
+  "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 Create a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_created"
 }

6.4.2 Resume a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
-}
-

6.5 Compact

6.5.1 Manually compact graph，This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
-    }
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_resumed"
+}
+

6.5 Compact

6.5.1 Manually compact graph,This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
+
Response Status
200
+
Response Body
{
+  "nodes": 1,
+  "cluster_id": "local",
+  "servers": {
+    "local": "OK"
+  }
 }

13 - Task API

7.1 Task

7.1.1 List all async tasks in graph

Params
  • status: the status of asyncTasks
  • limit：the max number of tasks to return
Method & Url
GET http://localhost:8080/graphs/hugegraph/tasks?status=success
Response Status
200
diff --git a/docs/clients/restful-api/graphs/index.html b/docs/clients/restful-api/graphs/index.html
index 2c1361687..16a6a6967 100644
--- a/docs/clients/restful-api/graphs/index.html
+++ b/docs/clients/restful-api/graphs/index.html
@@ -6,63 +6,67 @@
 200
 Response Body
 {
-    "graphs": [ …">
+  "graphs": [ …">
 
Graphs API
6.1 Graphs
6.1.1 List all graphs
Method & Url
GET http://localhost:8080/graphs
-
Response Status
200
-
Response Body
{
-    "graphs": [
-        "hugegraph",
-        "hugegraph1"
-    ]
+
Response Status
200
+
Response Body
{
+  "graphs": [
+    "hugegraph",
+    "hugegraph1"
+  ]
 }
 
6.1.2 Get details of the graph
Method & Url
GET http://localhost:8080/graphs/hugegraph
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph",
-    "backend": "cassandra"
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph",
+  "backend": "cassandra"
 }
-
6.1.3 Clear all data of a graph，include: schema、vertex、edge and index .etc，This operation requires administrator privileges
Params
Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to
-avoid false calls by users：
  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
-
Response Status
204
-
6.1.4 Clone graph，This operation requires administrator privileges
Params
  • clone_graph_name: name of an exist graph.
+

6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation

requires administrator privileges**

Params

Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to delete all data
Method & Url
DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
+
Response Status
204
+

6.1.4 Clone graph,This operation requires administrator privileges

Params
  • clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph
Method & Url
POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
-
Request Body [Optional]
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+
Request Body [Optional]
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph_clone
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph_clone",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph_clone",
+  "backend": "rocksdb"
 }
-

6.1.5 Create graph，This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
-
Request Body
gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy
+

6.1.5 Create graph,This operation requires administrator privileges

Method & Url
POST http://localhost:8080/graphs/hugegraph2
+
Request Body
gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
 backend=rocksdb
 serializer=binary
 store=hugegraph2
 rocksdb.data_path=./hg2
 rocksdb.wal_path=./hg2
-
Response Status
200
-
Response Body
{
-    "name": "hugegraph2",
-    "backend": "rocksdb"
+
Response Status
200
+
Response Body
{
+  "name": "hugegraph2",
+  "backend": "rocksdb"
 }
-

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
-
Response Status
204
-

6.2 Conf

6.2.1 Get configuration for a graph，This operation requires administrator privileges

Method & Url
GET http://localhost:8080/graphs/hugegraph/conf
-
Response Status
200
+

6.1.6 Delete graph and it’s data

Params

Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:

  • confirm_message: default by I'm sure to drop the graph
Method & Url
DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
+
Response Status
204
+

6.2 Conf

6.2.1 Get configuration for a graph,This operation requires administrator privileges

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
-
+gremlin.graph=org.apache.hugegraph.HugeFactory
 # cache config
 #schema.cache_capacity=1048576
 #graph.cache_capacity=10485760
@@ -77,51 +81,51 @@
 serializer=cassandra
 
 store=hugegraph
-...
-

6.3 Mode

Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING

  • None mode is regular mode
    • Not allowed create schema with specified id
    • Not support create vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes： Restoring and Merging

  • Restoring mode is used to restore schema and graph data to an new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, +...= +

6.3 Mode

Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING

  • None mode is regular mode
    • Not allowed to create schema with specified id
    • Not support creating vertex with id for AUTOMATIC id strategy
  • LOADING mode used to load data via hugegraph-loader.
    • When adding vertices / edges, it is not checked whether the required attributes are passed in

Restore has two different modes: Restoring and Merging

  • Restoring mode is used to restore schema and graph data to a new graph.
    • Support create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy
  • Merging mode is used to merge schema and graph data to an existing graph.
    • Not allowed to create schema with specified id
    • Support create vertex with id for AUTOMATIC id strategy

Under normal circumstances, the graph mode is None. When you need to restore the graph, you need to temporarily modify the graph mode to Restoring or Merging as needed. When you complete the restore, change the graph mode to None.

6.3.1 Get graph mode.

Method & Url
GET http://localhost:8080/graphs/hugegraph/mode
-
Response Status
200
-
Response Body
{
-    "mode": "NONE"
+
Response Status
200
+
Response Body
{
+  "mode": "NONE"
 }
-

Allowed graph mode values are：NONE，RESTORING，MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
+

Allowed graph mode values are: NONE, RESTORING, MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

Method & Url
PUT http://localhost:8080/graphs/hugegraph/mode
Request Body
"RESTORING"
-

Allowed graph mode values are：NONE，RESTORING，MERGING

Response Status
200
-
Response Body
{
-    "mode": "RESTORING"
+

Allowed graph mode values are: NONE, RESTORING, MERGING

Response Status
200
+
Response Body
{
+  "mode": "RESTORING"
 }

6.3.3 Get graph’s read mode.

Params
  • name: name of a graph
Method & Url
GET http://localhost:8080/graphs/hugegraph/graph_read_mode
-
Response Status
200
-
Response Body
{
-    "graph_read_mode": "ALL"
+
Response Status
200
+
Response Body
{
+  "graph_read_mode": "ALL"
 }

6.3.4 Modify graph’s read mode. This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/graph_read_mode
Request Body
"OLTP_ONLY"
-

Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY

Response Status
200
-
Response Body
{
-    "graph_read_mode": "OLTP_ONLY"
+

Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY

Response Status
200
+
Response Body
{
+  "graph_read_mode": "OLTP_ONLY"
 }

6.4 Snapshot

6.4.1 Create a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_create
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_created"
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_created"
 }

6.4.2 Resume a snapshot

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/snapshot_resume
-
Response Status
200
-
Response Body
{
-    "hugegraph": "snapshot_resumed"
+
Response Status
200
+
Response Body
{
+  "hugegraph": "snapshot_resumed"
 }
-

6.5 Compact

6.5.1 Manually compact graph，This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
-
Response Status
200
-
Response Body
{
-    "nodes": 1,
-    "cluster_id": "local",
-    "servers": {
-        "local": "OK"
-    }
+

6.5 Compact

6.5.1 Manually compact graph,This operation requires administrator privileges

Params
  • name: name of a graph
Method & Url
PUT http://localhost:8080/graphs/hugegraph/compact
+
Response Status
200
+
Response Body
{
+  "nodes": 1,
+  "cluster_id": "local",
+  "servers": {
+    "local": "OK"
+  }
 }
-

Last modified May 27, 2022: divide create graph into clone and create (665739b7)
+
Last modified September 18, 2023: doc: update gremlin config in graphs.md (#282) (3baae60d)
diff --git a/docs/clients/restful-api/index.xml b/docs/clients/restful-api/index.xml index 55c5c0b0a..589f87fa1 100644 --- a/docs/clients/restful-api/index.xml +++ b/docs/clients/restful-api/index.xml @@ -5209,10 +5209,10 @@ A random walk based PersonalRank algorithm should be likes this:</p> <h5 id="method--url">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs </span></span></code></pre></div><h5 id="response-status">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graphs&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graphs&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph1&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> @@ -5221,84 +5221,86 @@ A random walk based PersonalRank algorithm should be likes this:</p> <h5 id="method--url-1">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph </span></span></code></pre></div><h5 id="response-status-1">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-1">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;cassandra&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;cassandra&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="613-clear-all-data-of-a-graphinclude-schemavertexedge-and-index-etcthis-operation-requires-administrator-privileges">6.1.3 Clear all data of a graph，include: schema、vertex、edge and index .etc，<strong>This operation requires administrator privileges</strong></h4> +</span></span></code></pre></div><h4 id="613-clear-all-data-of-a-graph-include-schema-vertex-edge-and-index-etcthis-operation">6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation</h4> +<p>requires administrator privileges**</p> <h5 id="params">Params</h5> -<p>Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：</p> +<p>Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:</p> <ul> <li>confirm_message: default by <code>I'm sure to delete all data</code></li> </ul> <h5 id="method--url-2">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data </span></span></code></pre></div><h5 id="response-status-2">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> -</span></span></code></pre></div><h4 id="614-clone-graphthis-operation-requires-administrator-privileges">6.1.4 Clone graph，<strong>This operation requires administrator privileges</strong></h4> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> +</span></span></code></pre></div><h4 id="614-clone-graphthis-operation-requires-administrator-privileges">6.1.4 Clone graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="params-1">Params</h5> <ul> -<li>clone_graph_name: name of an exist graph. +<li>clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph</li> </ul> <h5 id="method--url-3">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph </span></span></code></pre></div><h5 id="request-body-optional">Request Body [Optional]</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy </span></span><span style="display:flex;"><span>backend=rocksdb </span></span><span style="display:flex;"><span>serializer=binary </span></span><span style="display:flex;"><span>store=hugegraph_clone </span></span><span style="display:flex;"><span>rocksdb.data_path=./hg2 </span></span><span style="display:flex;"><span>rocksdb.wal_path=./hg2 </span></span></code></pre></div><h5 id="response-status-3">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-2">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph_clone&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph_clone&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="615-create-graphthis-operation-requires-administrator-privileges">6.1.5 Create graph，<strong>This operation requires administrator privileges</strong></h4> +</span></span></code></pre></div><h4 id="615-create-graphthis-operation-requires-administrator-privileges">6.1.5 Create graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="method--url-4">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>POST http://localhost:8080/graphs/hugegraph2 </span></span></code></pre></div><h5 id="request-body">Request Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy </span></span><span style="display:flex;"><span>backend=rocksdb </span></span><span style="display:flex;"><span>serializer=binary </span></span><span style="display:flex;"><span>store=hugegraph2 </span></span><span style="display:flex;"><span>rocksdb.data_path=./hg2 </span></span><span style="display:flex;"><span>rocksdb.wal_path=./hg2 </span></span></code></pre></div><h5 id="response-status-4">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-3">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph2&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph2&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="616-delete-graph-and-its-data">6.1.6 Delete graph and it&rsquo;s data</h4> <h5 id="params-2">Params</h5> -<p>Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：</p> +<p>Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:</p> <ul> <li>confirm_message: default by <code>I'm sure to drop the graph</code></li> </ul> <h5 id="method--url-5">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph </span></span></code></pre></div><h5 id="response-status-5">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> </span></span></code></pre></div><h3 id="62-conf">6.2 Conf</h3> -<h4 id="621-get-configuration-for-a-graphthis-operation-requires-administrator-privileges">6.2.1 Get configuration for a graph，<strong>This operation requires administrator privileges</strong></h4> +<h4 id="621-get-configuration-for-a-graphthis-operation-requires-administrator-privileges">6.2.1 Get configuration for a graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="method--url-6">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/conf </span></span></code></pre></div><h5 id="response-status-6">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-4">Response Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span># gremlin entrence to create graph -</span></span><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.HugeFactory -</span></span><span style="display:flex;"><span> +</span></span><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.HugeFactory </span></span><span style="display:flex;"><span># cache config </span></span><span style="display:flex;"><span>#schema.cache_capacity=1048576 </span></span><span style="display:flex;"><span>#graph.cache_capacity=10485760 @@ -5313,14 +5315,14 @@ avoid false calls by users：</p> </span></span><span style="display:flex;"><span>serializer=cassandra </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span>store=hugegraph -</span></span><span style="display:flex;"><span>... +</span></span><span style="display:flex;"><span>...= </span></span></code></pre></div><h3 id="63-mode">6.3 Mode</h3> -<p>Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING</p> +<p>Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING</p> <ul> <li>None mode is regular mode <ul> -<li>Not allowed create schema with specified id</li> -<li>Not support create vertex with id for AUTOMATIC id strategy</li> +<li>Not allowed to create schema with specified id</li> +<li>Not support creating vertex with id for AUTOMATIC id strategy</li> </ul> </li> <li>LOADING mode used to load data via hugegraph-loader. @@ -5329,9 +5331,9 @@ avoid false calls by users：</p> </ul> </li> </ul> -<p>Restore has two different modes： Restoring and Merging</p> +<p>Restore has two different modes: Restoring and Merging</p> <ul> -<li>Restoring mode is used to restore schema and graph data to an new graph. +<li>Restoring mode is used to restore schema and graph data to a new graph. <ul> <li>Support create schema with specified id</li> <li>Support create vertex with id for AUTOMATIC id strategy</li> @@ -5339,7 +5341,7 @@ avoid false calls by users：</p> </li> <li>Merging mode is used to merge schema and graph data to an existing graph. <ul> -<li>Not allowed create schema with specified id</li> +<li>Not allowed to create schema with specified id</li> <li>Support create vertex with id for AUTOMATIC id strategy</li> </ul> </li> @@ -5351,13 +5353,13 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-7">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/mode </span></span></code></pre></div><h5 id="response-status-7">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-5">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><blockquote> -<p>Allowed graph mode values are：NONE，RESTORING，MERGING</p> +<p>Allowed graph mode values are: NONE, RESTORING, MERGING</p> </blockquote> <h4 id="632-modify-graph-mode-this-operation-requires-administrator-privileges">6.3.2 Modify graph mode. <strong>This operation requires administrator privileges</strong></h4> <h5 id="method--url-8">Method &amp; Url</h5> @@ -5365,13 +5367,13 @@ When you complete the restore, change the graph mode to None.</p> </span></span></code></pre></div><h5 id="request-body-1">Request Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&#34;RESTORING&#34; </span></span></code></pre></div><blockquote> -<p>Allowed graph mode values are：NONE，RESTORING，MERGING</p> +<p>Allowed graph mode values are: NONE, RESTORING, MERGING</p> </blockquote> <h5 id="response-status-8">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-6">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;RESTORING&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;RESTORING&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="633-get-graphs-read-mode">6.3.3 Get graph&rsquo;s read mode.</h4> <h5 id="params-3">Params</h5> @@ -5381,10 +5383,10 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-9">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/graph_read_mode </span></span></code></pre></div><h5 id="response-status-9">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-7">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graph_read_mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ALL&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graph_read_mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ALL&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="634-modify-graphs-read-mode-this-operation-requires-administrator-privileges">6.3.4 Modify graph&rsquo;s read mode. <strong>This operation requires administrator privileges</strong></h4> <h5 id="params-4">Params</h5> @@ -5396,13 +5398,13 @@ When you complete the restore, change the graph mode to None.</p> </span></span></code></pre></div><h5 id="request-body-2">Request Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&#34;OLTP_ONLY&#34; </span></span></code></pre></div><blockquote> -<p>Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY</p> +<p>Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY</p> </blockquote> <h5 id="response-status-10">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-8">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graph_read_mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OLTP_ONLY&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graph_read_mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OLTP_ONLY&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h3 id="64-snapshot">6.4 Snapshot</h3> <h4 id="641-create-a-snapshot">6.4.1 Create a snapshot</h4> @@ -5413,10 +5415,10 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-11">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/snapshot_create </span></span></code></pre></div><h5 id="response-status-11">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-9">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_created&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_created&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="642-resume-a-snapshot">6.4.2 Resume a snapshot</h4> <h5 id="params-6">Params</h5> @@ -5426,13 +5428,13 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-12">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/snapshot_resume </span></span></code></pre></div><h5 id="response-status-12">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-10">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_resumed&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_resumed&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h3 id="65-compact">6.5 Compact</h3> -<h4 id="651-manually-compact-graphthis-operation-requires-administrator-privileges">6.5.1 Manually compact graph，<strong>This operation requires administrator privileges</strong></h4> +<h4 id="651-manually-compact-graphthis-operation-requires-administrator-privileges">6.5.1 Manually compact graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="params-7">Params</h5> <ul> <li>name: name of a graph</li> @@ -5440,13 +5442,13 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-13">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/compact </span></span></code></pre></div><h5 id="response-status-13">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-11">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;nodes&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;cluster_id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;servers&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;local&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OK&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;nodes&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;cluster_id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;servers&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OK&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div>Docs: Task API/docs/clients/restful-api/task/Mon, 01 Jan 0001 00:00:00 +0000/docs/clients/restful-api/task/ diff --git a/docs/index.xml b/docs/index.xml index 3b5fe16df..2eeb0edc8 100644 --- a/docs/index.xml +++ b/docs/index.xml @@ -14492,10 +14492,10 @@ A random walk based PersonalRank algorithm should be likes this:</p> <h5 id="method--url">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs </span></span></code></pre></div><h5 id="response-status">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graphs&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graphs&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">[</span> </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> </span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph1&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">]</span> @@ -14504,84 +14504,86 @@ A random walk based PersonalRank algorithm should be likes this:</p> <h5 id="method--url-1">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph </span></span></code></pre></div><h5 id="response-status-1">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-1">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;cassandra&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;cassandra&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="613-clear-all-data-of-a-graphinclude-schemavertexedge-and-index-etcthis-operation-requires-administrator-privileges">6.1.3 Clear all data of a graph，include: schema、vertex、edge and index .etc，<strong>This operation requires administrator privileges</strong></h4> +</span></span></code></pre></div><h4 id="613-clear-all-data-of-a-graph-include-schema-vertex-edge-and-index-etcthis-operation">6.1.3 Clear all data of a graph, include: schema, vertex, edge and index .etc.,**This operation</h4> +<p>requires administrator privileges**</p> <h5 id="params">Params</h5> -<p>Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：</p> +<p>Since emptying the graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:</p> <ul> <li>confirm_message: default by <code>I'm sure to delete all data</code></li> </ul> <h5 id="method--url-2">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data </span></span></code></pre></div><h5 id="response-status-2">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> -</span></span></code></pre></div><h4 id="614-clone-graphthis-operation-requires-administrator-privileges">6.1.4 Clone graph，<strong>This operation requires administrator privileges</strong></h4> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> +</span></span></code></pre></div><h4 id="614-clone-graphthis-operation-requires-administrator-privileges">6.1.4 Clone graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="params-1">Params</h5> <ul> -<li>clone_graph_name: name of an exist graph. +<li>clone_graph_name: name of an existed graph. To clone from an existing graph, the user can choose to transfer the configuration file, which will replace the configuration in the existing graph</li> </ul> <h5 id="method--url-3">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph </span></span></code></pre></div><h5 id="request-body-optional">Request Body [Optional]</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy </span></span><span style="display:flex;"><span>backend=rocksdb </span></span><span style="display:flex;"><span>serializer=binary </span></span><span style="display:flex;"><span>store=hugegraph_clone </span></span><span style="display:flex;"><span>rocksdb.data_path=./hg2 </span></span><span style="display:flex;"><span>rocksdb.wal_path=./hg2 </span></span></code></pre></div><h5 id="response-status-3">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-2">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph_clone&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph_clone&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> -</span></span></code></pre></div><h4 id="615-create-graphthis-operation-requires-administrator-privileges">6.1.5 Create graph，<strong>This operation requires administrator privileges</strong></h4> +</span></span></code></pre></div><h4 id="615-create-graphthis-operation-requires-administrator-privileges">6.1.5 Create graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="method--url-4">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>POST http://localhost:8080/graphs/hugegraph2 </span></span></code></pre></div><h5 id="request-body">Request Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.auth.HugeFactoryAuthProxy +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy </span></span><span style="display:flex;"><span>backend=rocksdb </span></span><span style="display:flex;"><span>serializer=binary </span></span><span style="display:flex;"><span>store=hugegraph2 </span></span><span style="display:flex;"><span>rocksdb.data_path=./hg2 </span></span><span style="display:flex;"><span>rocksdb.wal_path=./hg2 </span></span></code></pre></div><h5 id="response-status-4">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-3">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;name&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph2&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;backend&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;name&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;hugegraph2&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;backend&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;rocksdb&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="616-delete-graph-and-its-data">6.1.6 Delete graph and it&rsquo;s data</h4> <h5 id="params-2">Params</h5> -<p>Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the API to -avoid false calls by users：</p> +<p>Since deleting a graph is a dangerous operation, we have added parameters for confirmation to the +API to +avoid false calls by users:</p> <ul> <li>confirm_message: default by <code>I'm sure to drop the graph</code></li> </ul> <h5 id="method--url-5">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph </span></span></code></pre></div><h5 id="response-status-5">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">204</span> </span></span></code></pre></div><h3 id="62-conf">6.2 Conf</h3> -<h4 id="621-get-configuration-for-a-graphthis-operation-requires-administrator-privileges">6.2.1 Get configuration for a graph，<strong>This operation requires administrator privileges</strong></h4> +<h4 id="621-get-configuration-for-a-graphthis-operation-requires-administrator-privileges">6.2.1 Get configuration for a graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="method--url-6">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/conf </span></span></code></pre></div><h5 id="response-status-6">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-4">Response Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span># gremlin entrence to create graph -</span></span><span style="display:flex;"><span>gremlin.graph=com.baidu.hugegraph.HugeFactory -</span></span><span style="display:flex;"><span> +</span></span><span style="display:flex;"><span>gremlin.graph=org.apache.hugegraph.HugeFactory </span></span><span style="display:flex;"><span># cache config </span></span><span style="display:flex;"><span>#schema.cache_capacity=1048576 </span></span><span style="display:flex;"><span>#graph.cache_capacity=10485760 @@ -14596,14 +14598,14 @@ avoid false calls by users：</p> </span></span><span style="display:flex;"><span>serializer=cassandra </span></span><span style="display:flex;"><span> </span></span><span style="display:flex;"><span>store=hugegraph -</span></span><span style="display:flex;"><span>... +</span></span><span style="display:flex;"><span>...= </span></span></code></pre></div><h3 id="63-mode">6.3 Mode</h3> -<p>Allowed graph mode values are：NONE，RESTORING，MERGING，LOADING</p> +<p>Allowed graph mode values are: NONE, RESTORING, MERGING, LOADING</p> <ul> <li>None mode is regular mode <ul> -<li>Not allowed create schema with specified id</li> -<li>Not support create vertex with id for AUTOMATIC id strategy</li> +<li>Not allowed to create schema with specified id</li> +<li>Not support creating vertex with id for AUTOMATIC id strategy</li> </ul> </li> <li>LOADING mode used to load data via hugegraph-loader. @@ -14612,9 +14614,9 @@ avoid false calls by users：</p> </ul> </li> </ul> -<p>Restore has two different modes： Restoring and Merging</p> +<p>Restore has two different modes: Restoring and Merging</p> <ul> -<li>Restoring mode is used to restore schema and graph data to an new graph. +<li>Restoring mode is used to restore schema and graph data to a new graph. <ul> <li>Support create schema with specified id</li> <li>Support create vertex with id for AUTOMATIC id strategy</li> @@ -14622,7 +14624,7 @@ avoid false calls by users：</p> </li> <li>Merging mode is used to merge schema and graph data to an existing graph. <ul> -<li>Not allowed create schema with specified id</li> +<li>Not allowed to create schema with specified id</li> <li>Support create vertex with id for AUTOMATIC id strategy</li> </ul> </li> @@ -14634,13 +14636,13 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-7">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/mode </span></span></code></pre></div><h5 id="response-status-7">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-5">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;NONE&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><blockquote> -<p>Allowed graph mode values are：NONE，RESTORING，MERGING</p> +<p>Allowed graph mode values are: NONE, RESTORING, MERGING</p> </blockquote> <h4 id="632-modify-graph-mode-this-operation-requires-administrator-privileges">6.3.2 Modify graph mode. <strong>This operation requires administrator privileges</strong></h4> <h5 id="method--url-8">Method &amp; Url</h5> @@ -14648,13 +14650,13 @@ When you complete the restore, change the graph mode to None.</p> </span></span></code></pre></div><h5 id="request-body-1">Request Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&#34;RESTORING&#34; </span></span></code></pre></div><blockquote> -<p>Allowed graph mode values are：NONE，RESTORING，MERGING</p> +<p>Allowed graph mode values are: NONE, RESTORING, MERGING</p> </blockquote> <h5 id="response-status-8">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-6">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;RESTORING&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;RESTORING&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="633-get-graphs-read-mode">6.3.3 Get graph&rsquo;s read mode.</h4> <h5 id="params-3">Params</h5> @@ -14664,10 +14666,10 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-9">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>GET http://localhost:8080/graphs/hugegraph/graph_read_mode </span></span></code></pre></div><h5 id="response-status-9">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-7">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graph_read_mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ALL&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graph_read_mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;ALL&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="634-modify-graphs-read-mode-this-operation-requires-administrator-privileges">6.3.4 Modify graph&rsquo;s read mode. <strong>This operation requires administrator privileges</strong></h4> <h5 id="params-4">Params</h5> @@ -14679,13 +14681,13 @@ When you complete the restore, change the graph mode to None.</p> </span></span></code></pre></div><h5 id="request-body-2">Request Body</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>&#34;OLTP_ONLY&#34; </span></span></code></pre></div><blockquote> -<p>Allowed read mode values are：ALL，OLTP_ONLY，OLAP_ONLY</p> +<p>Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY</p> </blockquote> <h5 id="response-status-10">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-8">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;graph_read_mode&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OLTP_ONLY&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;graph_read_mode&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OLTP_ONLY&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h3 id="64-snapshot">6.4 Snapshot</h3> <h4 id="641-create-a-snapshot">6.4.1 Create a snapshot</h4> @@ -14696,10 +14698,10 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-11">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/snapshot_create </span></span></code></pre></div><h5 id="response-status-11">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-9">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_created&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_created&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h4 id="642-resume-a-snapshot">6.4.2 Resume a snapshot</h4> <h5 id="params-6">Params</h5> @@ -14709,13 +14711,13 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-12">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/snapshot_resume </span></span></code></pre></div><h5 id="response-status-12">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-10">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;hugegraph&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_resumed&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;hugegraph&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;snapshot_resumed&#34;</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div><h3 id="65-compact">6.5 Compact</h3> -<h4 id="651-manually-compact-graphthis-operation-requires-administrator-privileges">6.5.1 Manually compact graph，<strong>This operation requires administrator privileges</strong></h4> +<h4 id="651-manually-compact-graphthis-operation-requires-administrator-privileges">6.5.1 Manually compact graph,<strong>This operation requires administrator privileges</strong></h4> <h5 id="params-7">Params</h5> <ul> <li>name: name of a graph</li> @@ -14723,13 +14725,13 @@ When you complete the restore, change the graph mode to None.</p> <h5 id="method--url-13">Method &amp; Url</h5> <div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-fallback" data-lang="fallback"><span style="display:flex;"><span>PUT http://localhost:8080/graphs/hugegraph/compact </span></span></code></pre></div><h5 id="response-status-13">Response Status</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#0000cf;font-weight:bold">200</span> </span></span></code></pre></div><h5 id="response-body-11">Response Body</h5> -<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-json" data-lang="json"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;nodes&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;cluster_id&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#000;font-weight:bold">,</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;servers&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> -</span></span><span style="display:flex;"><span> <span style="color:#204a87;font-weight:bold">&#34;local&#34;</span><span style="color:#000;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OK&#34;</span> +<div class="highlight"><pre tabindex="0" style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4;"><code class="language-javascript" data-lang="javascript"><span style="display:flex;"><span><span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;nodes&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#0000cf;font-weight:bold">1</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;cluster_id&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#000;font-weight:bold">,</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;servers&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#000;font-weight:bold">{</span> +</span></span><span style="display:flex;"><span> <span style="color:#4e9a06">&#34;local&#34;</span><span style="color:#ce5c00;font-weight:bold">:</span> <span style="color:#4e9a06">&#34;OK&#34;</span> </span></span><span style="display:flex;"><span> <span style="color:#000;font-weight:bold">}</span> </span></span><span style="display:flex;"><span><span style="color:#000;font-weight:bold">}</span> </span></span></code></pre></div>Docs: Task API/docs/clients/restful-api/task/Mon, 01 Jan 0001 00:00:00 +0000/docs/clients/restful-api/task/ diff --git a/en/sitemap.xml b/en/sitemap.xml index c5f523397..511913774 100644 --- a/en/sitemap.xml +++ b/en/sitemap.xml @@ -1 +1 @@ -/docs/guides/architectural/2023-06-25T21:06:07+08:00/docs/config/config-guide/2023-06-21T14:48:04+08:00/docs/language/hugegraph-gremlin/2023-05-14T07:29:41-05:00/docs/contribution-guidelines/contribute/2023-09-09T20:50:32+08:00/docs/performance/hugegraph-benchmark-0.5.6/2023-05-14T22:31:02-05:00/docs/quickstart/hugegraph-server/2023-09-12T12:18:04+08:00/docs/introduction/readme/2023-06-18T14:57:33+08:00/docs/changelog/hugegraph-1.0.0-release-notes/2023-01-09T07:41:46+08:00/docs/clients/restful-api/2023-07-31T23:55:30+08:00/docs/clients/restful-api/schema/2023-05-14T19:35:13+08:00/docs/performance/api-preformance/hugegraph-api-0.5.6-rocksdb/2023-05-15T22:47:44-05:00/docs/config/config-option/2023-02-08T20:56:09+08:00/docs/guides/desgin-concept/2023-05-14T07:20:21-05:00/docs/download/download/2023-06-17T14:43:04+08:00/docs/language/hugegraph-example/2023-02-02T01:21:10+08:00/docs/clients/hugegraph-client/2023-01-01T16:16:43+08:00/docs/performance/api-preformance/2023-06-17T14:43:04+08:00/docs/quickstart/hugegraph-loader/2023-05-17T23:12:35+08:00/docs/clients/restful-api/propertykey/2023-05-19T05:15:56-05:00/docs/changelog/hugegraph-0.12.0-release-notes/2023-05-18T06:11:19-05:00/docs/contribution-guidelines/subscribe/2023-06-17T14:43:04+08:00/docs/performance/api-preformance/hugegraph-api-0.5.6-cassandra/2023-05-16T23:30:00-05:00/docs/config/config-authentication/2023-05-19T05:12:35-05:00/docs/clients/gremlin-console/2023-06-12T23:52:07+08:00/docs/guides/custom-plugin/2023-05-14T07:22:46-05:00/docs/performance/hugegraph-loader-performance/2023-05-18T00:34:48-05:00/docs/quickstart/hugegraph-tools/2023-05-09T21:27:34+08:00/docs/quickstart/2022-04-17T11:36:55+08:00/docs/contribution-guidelines/validate-release/2023-02-15T16:14:21+08:00/docs/clients/restful-api/vertexlabel/2023-05-19T04:03:23-05:00/docs/guides/backup-restore/2023-05-14T07:26:12-05:00/docs/config/2022-04-17T11:36:55+08:00/docs/config/config-https/2023-05-19T05:04:16-05:00/docs/clients/restful-api/edgelabel/2023-05-19T05:17:26-05:00/docs/contribution-guidelines/hugegraph-server-idea-setup/2023-06-25T21:06:07+08:00/docs/quickstart/hugegraph-hubble/2023-09-12T12:18:04+08:00/docs/clients/2022-04-17T11:36:55+08:00/docs/config/config-computer/2023-01-01T16:16:43+08:00/docs/guides/faq/2023-05-14T07:28:41-05:00/docs/clients/restful-api/indexlabel/2023-05-19T05:18:17-05:00/docs/quickstart/hugegraph-client/2023-05-14T22:39:27+08:00/docs/guides/2022-04-17T11:36:55+08:00/docs/clients/restful-api/rebuild/2022-05-09T18:43:53+08:00/docs/quickstart/hugegraph-computer/2023-06-25T21:06:46+08:00/docs/language/2022-04-17T11:36:55+08:00/docs/clients/restful-api/vertex/2023-06-04T23:04:47+08:00/docs/clients/restful-api/edge/2023-06-29T10:17:29+08:00/docs/performance/2022-04-17T11:36:55+08:00/docs/contribution-guidelines/2022-12-30T19:36:31+08:00/docs/clients/restful-api/traverser/2023-09-15T11:15:58+08:00/docs/changelog/2022-04-28T21:26:41+08:00/docs/clients/restful-api/rank/2022-09-15T12:59:59+08:00/docs/clients/restful-api/variable/2023-05-21T04:38:57-05:00/docs/clients/restful-api/graphs/2022-05-27T09:27:37+08:00/docs/clients/restful-api/task/2022-09-15T12:59:59+08:00/docs/clients/restful-api/gremlin/2023-05-21T04:39:11-05:00/docs/clients/restful-api/cypher/2023-07-31T23:55:30+08:00/docs/clients/restful-api/auth/2023-07-31T23:55:30+08:00/docs/clients/restful-api/other/2023-07-31T23:55:30+08:00/docs/2022-12-30T19:57:48+08:00/blog/news/2022-03-21T18:55:33+08:00/blog/releases/2022-03-21T18:55:33+08:00/blog/2018/10/06/easy-documentation-with-docsy/2022-03-21T18:55:33+08:00/blog/2018/10/06/the-second-blog-post/2022-03-21T18:55:33+08:00/blog/2018/01/04/another-great-release/2022-03-21T18:55:33+08:00/docs/cla/2022-03-21T19:51:14+08:00/docs/performance/hugegraph-benchmark-0.4.4/2022-09-15T12:59:59+08:00/docs/summary/2023-07-31T23:55:30+08:00/blog/2022-03-21T18:55:33+08:00/categories//community/2022-03-21T18:55:33+08:00/2023-01-15T13:44:01+00:00/search/2022-03-21T18:55:33+08:00/tags/ \ No newline at end of file +/docs/guides/architectural/2023-06-25T21:06:07+08:00/docs/config/config-guide/2023-06-21T14:48:04+08:00/docs/language/hugegraph-gremlin/2023-05-14T07:29:41-05:00/docs/contribution-guidelines/contribute/2023-09-09T20:50:32+08:00/docs/performance/hugegraph-benchmark-0.5.6/2023-05-14T22:31:02-05:00/docs/quickstart/hugegraph-server/2023-09-12T12:18:04+08:00/docs/introduction/readme/2023-06-18T14:57:33+08:00/docs/changelog/hugegraph-1.0.0-release-notes/2023-01-09T07:41:46+08:00/docs/clients/restful-api/2023-07-31T23:55:30+08:00/docs/clients/restful-api/schema/2023-05-14T19:35:13+08:00/docs/performance/api-preformance/hugegraph-api-0.5.6-rocksdb/2023-05-15T22:47:44-05:00/docs/config/config-option/2023-02-08T20:56:09+08:00/docs/guides/desgin-concept/2023-05-14T07:20:21-05:00/docs/download/download/2023-06-17T14:43:04+08:00/docs/language/hugegraph-example/2023-02-02T01:21:10+08:00/docs/clients/hugegraph-client/2023-01-01T16:16:43+08:00/docs/performance/api-preformance/2023-06-17T14:43:04+08:00/docs/quickstart/hugegraph-loader/2023-05-17T23:12:35+08:00/docs/clients/restful-api/propertykey/2023-05-19T05:15:56-05:00/docs/changelog/hugegraph-0.12.0-release-notes/2023-05-18T06:11:19-05:00/docs/contribution-guidelines/subscribe/2023-06-17T14:43:04+08:00/docs/performance/api-preformance/hugegraph-api-0.5.6-cassandra/2023-05-16T23:30:00-05:00/docs/config/config-authentication/2023-05-19T05:12:35-05:00/docs/clients/gremlin-console/2023-06-12T23:52:07+08:00/docs/guides/custom-plugin/2023-05-14T07:22:46-05:00/docs/performance/hugegraph-loader-performance/2023-05-18T00:34:48-05:00/docs/quickstart/hugegraph-tools/2023-05-09T21:27:34+08:00/docs/quickstart/2022-04-17T11:36:55+08:00/docs/contribution-guidelines/validate-release/2023-02-15T16:14:21+08:00/docs/clients/restful-api/vertexlabel/2023-05-19T04:03:23-05:00/docs/guides/backup-restore/2023-05-14T07:26:12-05:00/docs/config/2022-04-17T11:36:55+08:00/docs/config/config-https/2023-05-19T05:04:16-05:00/docs/clients/restful-api/edgelabel/2023-05-19T05:17:26-05:00/docs/contribution-guidelines/hugegraph-server-idea-setup/2023-06-25T21:06:07+08:00/docs/quickstart/hugegraph-hubble/2023-09-12T12:18:04+08:00/docs/clients/2022-04-17T11:36:55+08:00/docs/config/config-computer/2023-01-01T16:16:43+08:00/docs/guides/faq/2023-05-14T07:28:41-05:00/docs/clients/restful-api/indexlabel/2023-05-19T05:18:17-05:00/docs/quickstart/hugegraph-client/2023-05-14T22:39:27+08:00/docs/guides/2022-04-17T11:36:55+08:00/docs/clients/restful-api/rebuild/2022-05-09T18:43:53+08:00/docs/quickstart/hugegraph-computer/2023-06-25T21:06:46+08:00/docs/language/2022-04-17T11:36:55+08:00/docs/clients/restful-api/vertex/2023-06-04T23:04:47+08:00/docs/clients/restful-api/edge/2023-06-29T10:17:29+08:00/docs/performance/2022-04-17T11:36:55+08:00/docs/contribution-guidelines/2022-12-30T19:36:31+08:00/docs/clients/restful-api/traverser/2023-09-15T11:15:58+08:00/docs/changelog/2022-04-28T21:26:41+08:00/docs/clients/restful-api/rank/2022-09-15T12:59:59+08:00/docs/clients/restful-api/variable/2023-05-21T04:38:57-05:00/docs/clients/restful-api/graphs/2023-09-18T17:50:28+08:00/docs/clients/restful-api/task/2022-09-15T12:59:59+08:00/docs/clients/restful-api/gremlin/2023-05-21T04:39:11-05:00/docs/clients/restful-api/cypher/2023-07-31T23:55:30+08:00/docs/clients/restful-api/auth/2023-07-31T23:55:30+08:00/docs/clients/restful-api/other/2023-07-31T23:55:30+08:00/docs/2022-12-30T19:57:48+08:00/blog/news/2022-03-21T18:55:33+08:00/blog/releases/2022-03-21T18:55:33+08:00/blog/2018/10/06/easy-documentation-with-docsy/2022-03-21T18:55:33+08:00/blog/2018/10/06/the-second-blog-post/2022-03-21T18:55:33+08:00/blog/2018/01/04/another-great-release/2022-03-21T18:55:33+08:00/docs/cla/2022-03-21T19:51:14+08:00/docs/performance/hugegraph-benchmark-0.4.4/2022-09-15T12:59:59+08:00/docs/summary/2023-07-31T23:55:30+08:00/blog/2022-03-21T18:55:33+08:00/categories//community/2022-03-21T18:55:33+08:00/2023-01-15T13:44:01+00:00/search/2022-03-21T18:55:33+08:00/tags/ \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml index 862f254dc..01a312941 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -/en/sitemap.xml2023-09-15T11:15:58+08:00/cn/sitemap.xml2023-09-15T11:15:58+08:00 \ No newline at end of file +/en/sitemap.xml2023-09-18T17:50:28+08:00/cn/sitemap.xml2023-09-18T17:50:28+08:00 \ No newline at end of file