Graphs API

6.1 Graphs

6.1.1 List all graphs

Method & Url
  1. GET http://localhost:8080/graphs
Response Status
  1. 200
Response Body
  1. {
  2.   "graphs": [
  3.     "hugegraph",
  4.     "hugegraph1"
  5.   ]
  6. }

6.1.2 Get details of the graph

Method & Url
  1. GET http://localhost:8080/graphs/hugegraph
Response Status
  1. 200
Response Body
  1. {
  2.   "name": "hugegraph",
  3.   "backend": "cassandra"
  4. }

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
  1. DELETE http://localhost:8080/graphs/hugegraph/clear?confirm_message=I%27m+sure+to+delete+all+data
Response Status
  1. 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
  1. POST http://localhost:8080/graphs/hugegraph_clone?clone_graph_name=hugegraph
Request Body [Optional]
  1. gremlin.graph=org.apache.hugegraph.auth.HugeFactoryAuthProxy
  2. backend=rocksdb
  3. serializer=binary
  4. store=hugegraph_clone
  5. rocksdb.data_path=./hg2
  6. rocksdb.wal_path=./hg2
Response Status
  1. 200
Response Body
  1. {
  2.   "name": "hugegraph_clone",
  3.   "backend": "rocksdb"
  4. }

6.1.5 Create graph,This operation requires administrator privileges

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

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
  1. DELETE http://localhost:8080/graphs/hugegraph_clone?confirm_message=I%27m%20sure%20to%20drop%20the%20graph
Response Status
  1. 204

6.2 Conf

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

Method & Url
  1. GET http://localhost:8080/graphs/hugegraph/conf
Response Status
  1. 200
Response Body
  1. # gremlin entrence to create graph
  2. gremlin.graph=org.apache.hugegraph.HugeFactory
  3. # cache config
  4. #schema.cache_capacity=1048576
  5. #graph.cache_capacity=10485760
  6. #graph.cache_expire=600
  8. # schema illegal name template
  9. #schema.illegal_name_regex=\s+|~.*
  11. #vertex.default_label=vertex
  13. backend=cassandra
  14. serializer=cassandra
  16. store=hugegraph
  17. ...=

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
  1. GET http://localhost:8080/graphs/hugegraph/mode
Response Status
  1. 200
Response Body
  1. {
  2.   "mode": "NONE"
  3. }

Allowed graph mode values are: NONE, RESTORING, MERGING

6.3.2 Modify graph mode. This operation requires administrator privileges

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

Allowed graph mode values are: NONE, RESTORING, MERGING

Response Status
  1. 200
Response Body
  1. {
  2.   "mode": "RESTORING"
  3. }

6.3.3 Get graph’s read mode.

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

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

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

Allowed read mode values are: ALL, OLTP_ONLY, OLAP_ONLY

Response Status
  1. 200
Response Body
  1. {
  2.   "graph_read_mode": "OLTP_ONLY"
  3. }

6.4 Snapshot

6.4.1 Create a snapshot

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

6.4.2 Resume a snapshot

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

6.5 Compact

6.5.1 Manually compact graph,This operation requires administrator privileges

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

Last modified September 18, 2023: doc: update gremlin config in graphs.md (#282) (3baae60d)