From b7c5f4e7d5677af96e3909047ad13f002496f665 Mon Sep 17 00:00:00 2001 From: Priyanka Danesh Gunaki Date: Tue, 21 Jul 2026 23:45:31 +0530 Subject: [PATCH 1/4] DOC-2667 Compare restpp and gsql --- modules/API/pages/built-in-endpoints.adoc | 3 +++ modules/API/pages/gsql-endpoints.adoc | 33 +++++++++++++++++++++++ 2 files changed, 36 insertions(+) diff --git a/modules/API/pages/built-in-endpoints.adoc b/modules/API/pages/built-in-endpoints.adoc index ea076105..51d947fa 100644 --- a/modules/API/pages/built-in-endpoints.adoc +++ b/modules/API/pages/built-in-endpoints.adoc @@ -2932,6 +2932,9 @@ curl -X POST --data-binary @./ "http://localhost:14240/restpp/query At the read committed level, it is guaranteed that any data read is committed at the moment it is read. By default, it is off. |=== +For a comparison of the RESTPP and GSQL endpoints for running installed queries, including differences in parameter formats and query execution, see xref:gsql-endpoints.adoc#compare-the-restpp-and-gsql-query-endpoints[]. + + ==== Query parameter Passing When using a `POST` request to run an installed query, the query parameters are passed in through the request body and xref:API:index.adoc#_formatting_data_in_json[encoded in JSON format]. diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 34298ca7..3f8f6734 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3244,6 +3244,39 @@ Sample Response:: ''' +[[compare-restpp-gsql-query-endpoints]] +== Comparing the RESTPP and GSQL query endpoints + +TigerGraph provides two endpoints for running installed queries: + +* xref:built-in-endpoints.adoc#_run_an_installed_query_post[RESTPP endpoint] +* xref:gsql-endpoints.adoc#_run_query[GSQL endpoint] + +Both endpoints execute installed queries and return the same results. However, they differ in the format used to pass query parameters and how query requests are processed. + +[cols="2,3,3",options="header"] +|=== +|Feature +|RESTPP endpoint +|GSQL endpoint + +|Endpoint +|`/query/{graph_name}/{query_name}` +|`/gsql/v1/queries/{queryName}` + +|HTTP method +|`GET` or `POST` +|`POST` + +|Query parameter format +|Uses the RESTPP parameter format. +|Uses the GSQL parameter format. + +|Query execution +|Executes the installed query directly. +|Internally invokes the RESTPP endpoint to execute the installed query. +|=== + === run query `POST /gsql/v1/queries/{queryName}` From 79d04039859ee84027121c256193b69e812a9231 Mon Sep 17 00:00:00 2001 From: priyankagunaki-cloud Date: Wed, 22 Jul 2026 00:07:18 +0530 Subject: [PATCH 2/4] Update gsql-endpoints.adoc --- modules/API/pages/gsql-endpoints.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 3f8f6734..02b0c413 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3268,9 +3268,9 @@ Both endpoints execute installed queries and return the same results. However, t |`GET` or `POST` |`POST` -|Query parameter format -|Uses the RESTPP parameter format. -|Uses the GSQL parameter format. +|`VERTEX` and `SET` parameter format +|Uses the RESTPP parameter format for `VERTEX` and `SET` query parameters. +|Uses the GSQL parameter format for `VERTEX` and `SET` query parameters. |Query execution |Executes the installed query directly. From 931767858e72dcc4b8b174d672b42048a5c7c728 Mon Sep 17 00:00:00 2001 From: priyankagunaki-cloud Date: Tue, 28 Jul 2026 14:28:39 +0530 Subject: [PATCH 3/4] Update gsql-endpoints.adoc --- modules/API/pages/gsql-endpoints.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 02b0c413..1ddae09c 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3262,7 +3262,7 @@ Both endpoints execute installed queries and return the same results. However, t |Endpoint |`/query/{graph_name}/{query_name}` -|`/gsql/v1/queries/{queryName}` +|`/gsql/v1/queries/{query_name}` |HTTP method |`GET` or `POST` From c9bde6f9afd38529fa91f8230e546092f7a1f9da Mon Sep 17 00:00:00 2001 From: priyankagunaki-cloud Date: Tue, 28 Jul 2026 15:04:32 +0530 Subject: [PATCH 4/4] Update gsql-endpoints.adoc --- modules/API/pages/gsql-endpoints.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/API/pages/gsql-endpoints.adoc b/modules/API/pages/gsql-endpoints.adoc index 1ddae09c..b89870d7 100644 --- a/modules/API/pages/gsql-endpoints.adoc +++ b/modules/API/pages/gsql-endpoints.adoc @@ -3269,8 +3269,8 @@ Both endpoints execute installed queries and return the same results. However, t |`POST` |`VERTEX` and `SET` parameter format -|Uses the RESTPP parameter format for `VERTEX` and `SET` query parameters. -|Uses the GSQL parameter format for `VERTEX` and `SET` query parameters. +|Uses the RESTPP parameter format. See xref:built-in-endpoints.adoc#query-parameter-passing[Query parameter Passing]. +|Uses the GSQL parameter format. See xref:gsql-endpoints.adoc#format-for-parameters-of-query-being-run[Format for Parameters of Query Being Run]. |Query execution |Executes the installed query directly.