Skip to content
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

DOC-2374 #678

Open
wants to merge 2 commits into
base: 4.1
Choose a base branch
from
Open

DOC-2374 #678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f96493
DOC-2374
anjaliIthapeTG Jan 21, 2025
e23faf2
Update workload-management.adoc
anjaliIthapeTG Jan 22, 2025
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
21 changes: 21 additions & 0 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 @@ -2867,6 +2867,27 @@ curl --fail -u <my_username>:<my_password> -X POST "http://localhost:14240/gsql/
PRINT a;
}'
----
==== Declaring the Workload Queue

The workload queue can be specified in two ways:

* Request Header

[source.wrap,bash]
----
curl -s -u tigergraph:tigergraph -H 'Workload-Queue: OLTP' 'localhost:14240/gsqlserver/interpreted_query' \
-d 'INTERPRET QUERY () FOR GRAPH g { print 2; }'
----

* GSQL Command

[source.wrap,bash]
----
curl -s -H "Authorization: Bearer <USER TOKEN>" -H 'Workload-Queue: OLTP' 'localhost:14240/gsqlserver/interpreted_query' \
-d 'INTERPRET QUERY -QUEUE OLTP () FOR GRAPH g { print 2; }'
----

[NOTE]:If both methods are used in a single request, the workload queue specified in the header and the GSQL command must match.

=== List running queries of a graph

Expand Down
22 changes: 22 additions & 0 deletions modules/system-management/pages/workload-management.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,28 @@ Setting the values too high may degrade performance. It’s recommended to keep
Any configuration changes require a GPE restart to take effect.
====

==== Declaring the Workload Queue

The workload queue can be specified in two ways:

* Request Header

[source.wrap,bash]
----
curl -s -u tigergraph:tigergraph -H 'Workload-Queue: OLTP' 'localhost:14240/gsqlserver/interpreted_query' \
-d 'INTERPRET QUERY () FOR GRAPH g { print 2; }'
----

* GSQL Command

[source.wrap,bash]
----
curl -s -H "Authorization: Bearer <USER TOKEN>" -H 'Workload-Queue: OLTP' 'localhost:14240/gsqlserver/interpreted_query' \
-d 'INTERPRET QUERY -QUEUE OLTP () FOR GRAPH g { print 2; }'
----

[NOTE]:If both methods are used in a single request, the workload queue specified in the header and the GSQL command must match.

=== List Workload Queues
Displays a list of all workload queues available to the current user, including their configurations and permissions.

Expand Down