Executing GQL Queries

Function

GQL is a declarative query language with its core syntax resembling Cypher. Use GQL to query data in GES and retrieve results. For detailed information on GQL queries, refer to GQL Syntax.

URI

Request Parameters

1. You can add the explain or profile prefix before a statement to display the query plan. The explain prefix displays only the query plan but does not execute the statement. The profile prefix displays the query plan and executes the statement.
2. In asynchronous mode (executionMode is async), GQL query results of the memory edition can be exported to CSV files. This edition currently allows returning the following value types: vertex and edge single-value properties, vertex and edge IDs, and group count results. Object types cannot be exported in the current version. They are treated as null values in CSV files. For more details, refer to Exporting Job Execution Results to Files (2.2.1).

Response Parameters

Example Request

POST http://{SERVER_URL}/ges/v1.0/{project_id}/graphs/{graph_name}/action?action_id=execute-gql-query
{
	"statements": [{
		"statement": "match (n) return n limit 1",
        "runtime":"block",
		"parameters": {},
		"resultDataContents": ["raw"]
	}],
    "includeStats": true
}

Example Response

• Example response for a successful synchronous request

  Status code: 200

  Http Status Code: 200
  {
      "results": [
          {
              "columns": ["n"],
              "data": [
                  {
                      "row": [
                          {
                              "occupation": "artist",
                              "gender": "F",
                              "Zip-code": "98133",
                              "userid": 0,
                              "age": "25-34"
                          }
                      ],
                      "meta": [
                          {
                              "id": "46",
                              "type": "node",
                              "labels": [
                                  "user"
                              ]
                          }
                      ]
                  }
              ],
              "stats": {
                  "contains_updates": false,
                  "edges_created": 0,
                  "edges_deleted": 0,
                  "labels_set": 0,
                  "properties_set": 0,
                  "vertices_created": 0,
                  "vertices_deleted": 0
              }
          }
      ],
      "errors": []
  }

• Example response for a successful asynchronous request

  Status code: 200

  Http Status Code: 200
  {
      "results": [
          {
              "columns": ["n"],
              "data": [
                  {
                      "row": [
                          {
                              "occupation": "artist",
                              "gender": "F",
                              "Zip-code": "98133",
                              "userid": 0,
                              "age": "25-34"
                          }
                      ],
                      "meta": [
                          {
                              "id": "46",
                              "type": "node",
                              "labels": [
                                  "user"
                              ]
                          }
                      ]
                  }
              ],
              "stats": {
                  "contains_updates": false,
                  "edges_created": 0,
                  "edges_deleted": 0,
                  "labels_set": 0,
                  "properties_set": 0,
                  "vertices_created": 0,
                  "vertices_deleted": 0
              }
          }
      ],
      "errors": []
  }

Status code: 400

Http Status Code: 200
{
    "results": [],
    "errors": [
        {
            "code": "GES.8904",
            "message": "Label index in vertices is not found."
        }
    ]
}

Status Codes