Skip to content

DOC-3156: Update query install title and add multiple query example [… #926

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Tushar-TG-14 wants to merge 1 commit into
base: 4.2
Choose a base branch
from
Open

DOC-3156: Update query install title and add multiple query example [… #926

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions modules/API/pages/built-in-endpoints.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2402,11 +2402,11 @@ The JSON response object contains three fields:
|===

[#_install_a_query]
=== Install a query
=== Install one or more queries

`POST /gsql/v1/queries/install`

Once queries has been created for a graph, the user can use the `POST /gsql/v1/queries/install` endpoint to make a request to install one or multiple queries.
Once queries has been created for a graph, the user can use the `POST /gsql/v1/queries/install` endpoint to install one or multiple queries.

Once the GSQL server has received the `POST` request, it creates an installation request and returns a request location containing a request ID, with which you can <<_check_query_installation_status,check the installation status of all the queries in the request>>.
An installation request will wait in the background for any currently running processes to complete.
Expand Down Expand Up @@ -2460,6 +2460,35 @@ Response::
--
====

==== Installing multiple queries

You can install multiple queries by passing the `queries` parameter multiple times in the request.

[tabs]
====
Request::
+
--
[source.wrap,console]
----
curl --user tigergraph:tigergraph -X POST "http://localhost:14240/gsql/v1/queries/install?graph=social&queries=query1&queries=query2&queries=query3"
----
--
Response::
+
--
[source.wrap,json]
----
{
"location": "/gsql/queries/install/5678",
"error": false,
"message": "Request 5678 successfully created",
"results": ""
}
----
--
====

[#_check_query_installation_status]
=== Check query installation status

Expand Down