Cypher API

9.1 Cypher

9.1.1 Sending a cypher statement (GET) to HugeGraphServer for synchronous execution

Method & Url
1. GET /graphs/{graph}/cypher?cypher={cypher}
Params
  • graph: Graph name
  • cypher: Cypher statement
Example
1. GET http://localhost:8080/graphs/hugecypher1/cypher?cypher=match(n:person) return n.name as name order by n.name limit 1
Response Status
1. 200
Response Body
1. {
2. "requestId": "766b9f48-2f10-40d9-951a-3027d0748ab7",
3. "status": {
4. "message": "",
5. "code": 200,
6. "attributes": {
7. }
8. },
9. "result": {
10. "data": [
11. {
12. "name": "hello"
13. }
14. ],
15. "meta": {
16. }
17. }
18. }

9.1.2 Sending a cypher statement (POST) to HugeGraphServer for synchronous execution

Method & Url
1. POST /graphs/{graph}/cypher
Params
  • graph: Graph name
Body

{cypher}

  • cypher: Cypher statement

Note:

It is not in JSON format, but a plain text Cypher statement.

Example
1. POST http://localhost:8080/graphs/hugecypher1/cypher
Request Body
1. match(n:person) return n.name as name order by n.name limit 1
Response Status
1. 200
Response Body
1. {
2. "requestId": "f096bee0-e249-498f-b5a3-ea684fc84f57",
3. "status": {
4. "message": "",
5. "code": 200,
6. "attributes": {
7. }
8. },
9. "result": {
10. "data": [
11. {
12. "name": "hello"
13. }
14. ],
15. "meta": {
16. }
17. }
18. }

Last modified July 31, 2023: doc: added cypher api (#280) (18547af3)