Error Codes
The reference page for status codes on the TigerGraph platform.
This page documents the status codes and exit codes on the TigerGraph platform. Each status code follows the format: <component>-<code> , while exit codes are numeric values between 0 - 255.
If the system was handling a user request, the status code and message will be in the JSON response (see GSQL Query Output Format ). For internal errors, the error information may be in a log file.
The GSQL Client will exit with a non-zero code if there’s an error while handling a user request. To view the exit code of the GSQL client, run the command echo $? and the exit code of the most recent command will be printed to the terminal.
Return codes
REST
This section covers return codes from the REST++ server.
0000 - 0999
Codes in this range are success codes. When the conditions for multiple codes are true, the lowest code is returned.
Code | Description |
| General successful completion |
| Successful vertex insertion or update |
| Successful edge insertion or update |
| Successful vertex and edge insertion or update |
| Empty response |
1000 - 1999
RESTPP endpoint errors.
Code | Description |
| The endpoint does not exist. |
| The query could not run because there is no graph schema. |
| The graph cannot be found. |
2000 - 2999
Payload errors.
Code | Description |
| The JSON payload is invalid. |
| The payload contains vertices of an invalid type. |
| The payload contains edges of an invalid type. |
3000 - 3999
RESTPP general errors.
Code | Description |
| The query timed out from the timeout limit set by the request header. |
| The query timed out from the timeout limit set by the built-in endpoint. |
| The query timed out from the timeout limit set by the |
10000+
Other RESTPP errors.
Code | Description |
| The endpoint has been removed. |
| There was an exception when starting a scheduler. |
| There was an exception when processing results. |
| The request is in an orphan state due to malfunction in user-defined schedulers. |
| Access denied due to an invalid token. |
| RESTPP failed to get a response from GSE or GPE in time. |
| No running GSE or GPE instance detected. |
| The query was aborted by the user. |
| The query failed due to insufficient disk space. |
GSQL
0000 - 0999
Codes in this range are success codes. GSQL will return the smallest code when the conditions are met for multiple codes.
Code | Description |
| The query is successful. |
| Vertices and edges were updated or inserted successfully. |
| Vertices were updated or inserted successfully. |
| Edges were updated or inserted successfully. |
1000 - 1999
Query parameter errors.
Code | Description |
| The query contains a parameter with a |
| General parameter error. |
| Invalid parameters. |
2000 - 2499
JSON string related errors.
Code | Description |
| JSON object format error. |
| JSON array format error. |
2500 - 2999
Operator errors.
Code | Description |
| Division by zero error. |
| The query contains incorrectly formatted |
| The query contains illegal patterns. |
| The query contains invalid operators. |
| The parameter provided is of the wrong primitive type. |
| The query contains an invalid array index. |
| The query contains an out-of-bounds array index. |
3000 - 3999
Dynamic expression errors and expression function errors.
Code | Description |
| The query references non-existent attributes. |
| The query references non-existent vertex types. |
4500 - 4999
Vertex type, edge type, and ID translation errors
Code | Description |
| The query references a vertex type that does not exist. |
| The query references an edge type that does not exist. |
| The query references an invalid vertex ID. |
| The query contains an invalid vertex attribute. |
| The query contains an invalid edge attribute. |
| The number of edge attributes is invalid. |
| An edge points from an invalid source vertex. |
| An edge points to an invalid target vertex. |
| An edge has both invalid source and target vertices. |
5000 - 5499
Print errors.
Code | Description |
| A file referenced in the query cannot be opened. |
| A file referenced in the query does not exist. |
| GSQL was denied access to a file referenced in the query. |
| A file referenced in the query cannot be read. |
6000 - 6499
Errors related to updating the graph.
Code | Description |
| The query inserts an edge with an unknown vertex. |
| Unsupported type of attribute update. |
6500 - 6999
Code | Description |
| The query was aborted by the system. |
7000 - 7999
Built-in query errors.
Code | Description |
| The query timed out. |
8000 - 8999
Unexpected exceptions (C++).
Code | Description |
| Boost library exception |
| Runtime exception |
|
|
| All other exceptions |
40000+
User-defined exception errors.
SYS
This section covers engine-related errors.
Code | Description |
| The engine is not available. |
| The query was rejected because the memory limit has been reached. |
| The query is aborted. |
| The endpoint has been removed. |
GSQL client exit codes
The GSQL client will exit with non-zero code if there’s an error while handling a user request. To check the exit code, run the Linux command echo $? and the exit code of the most recent command will be printed in the console.
Exit Code | Description |
0 | No error |
41 | Login or authentication error. The GSQL will also exit with this code if a graph with the supplied graph name cannot be found. |
201 | Invalid argument error |
202 | Connection error |
203 | Compatibility error |
204 | Session timeout |
211* | Syntax error |
212 | Runtime error |
213* | No graph in use error |
255 | Unknown error |
*: The exit codes marked with a star (*) are only applicable when a GSQL script is given as an argument.
Last updated