Skip to content

DOC-3172: Revise run configuration instructions for GSQL queries #82

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-3172: Revise run configuration instructions for GSQL queries #82

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
26 changes: 21 additions & 5 deletions modules/graphstudio/pages/write-queries.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,14 +94,30 @@ image:write-queries-run-install-query-with-param_3.3.png[image]

== Run Configuration

You can set runtime configurations of the GSQL query by clicking the small downward-pointing arrow button image:3.9.png[image] to the right of the Run Query button. A menu will appear with the btn:[Run Configuration] button; click this button.
You can configure runtime settings for a GSQL query by clicking the downward-pointing arrow button to the right of the Run Query button. A menu appears with the *Run Configuration* option.

image:write-queries-use-default-timeout_3.3.png[image]
image:run-configuration-panel.png[image]

This opens the Run Configuration panel, where you can set the GSQL query timeout.
The Run Configuration panel allows you to configure runtime settings for the query before execution.

By default, it uses the timeout specified with the `RESTPP.Factory.DefaultQueryTimeoutSec` server parameter, which is 16 seconds.
See the xref:{page-component-version}@tigergraph-server:reference:configuration-parameters.adoc#_restpp[TigerGraph Server Command Glossary] for more information.
The following runtime options are available:

* *Query Profile*: Enables query profiling and displays query execution details after the query completes.
* *Timeout*: Sets the query timeout value in seconds.
* *Memory Limit*: Sets a memory limit for query execution.
* *GSQL Replica*: Selects the GSQL replica used for query execution.

Click *Apply Default* to restore the default runtime settings.

By default, GraphStudio uses the timeout specified by the `RESTPP.Factory.DefaultQueryTimeoutSec` server parameter. See the xref:management:command-line:gadmin-command.adoc[TigerGraph Server Command Glossary] for more information.

=== View Query Profile Results

When Query Profile is enabled, GraphStudio displays a visual query execution profile after query execution completes.

The profile view shows execution stages, execution timing, scheduling information, and topology statistics to help analyze query execution flow and performance.

image:query-profile-visualization.png[image]

== Delete Query

Expand Down