Get Started with GSQL Editor

The GSQL Editor is a powerful tool for developing and executing GSQL queries, allowing you to unlock insights from your graph databases.

Get Started with the GSQL Editor UI

The GSQL Editor contains 4 work areas:

Screenshot 2024 10 11 at 11.39.23

Additionally, you can use shortcuts to run a GSQL query.

gsql editor shorcuts

See How to Edit, Run, and Share a GSQL Query for more details.

File List

The GSQL File List in the GSQL Editor provides an overview of the GSQL files in your workspace. It helps you organize and manage your GSQL queries effectively with a list of GSQL files and folders present in your organization.

  • Navigate through the files and folders by clicking on their names in the list.

    Screenshot 2024 10 11 at 10.59.49

  • It also includes a search bar that allows you to search for specific files by their names.

    This feature helps you quickly locate the desired GSQL file, especially when you have a large number of files in your workspace.
    Screenshot 2024 04 18 at 10.08.25 AM

  • Additionally, click on + button to create a folder or a GSQL file.

    Screenshot 2024 04 18 at 10.08.58 AM

  • You can also order the file list by selecting an option from the order list

    Screenshot 2024 04 18 at 10.09.33 AM

Folders

The GSQL Editor in TigerGraph Cloud 4 has two types of folders presented in the list:

Shared Folder

The Shared Folder is a special type of folder that facilitates collaboration and sharing of GSQL files. The folder contains all GSQL files that are shared with you from other users with in the organization.

For more information about sharing GSQL files, please refer to Share GSQL Files.

User-defined Folders

These are folders created by individual users to organize their GSQL files within their personal workspace. User-defined folders allow you to group related queries or scripts together based on your own preferences. You can create, rename, and/or delete these folders as needed to manage your GSQL files effectively.

Create a Folder

To create your first folder:

  1. Click on the Folder from the + menu.

    gsql editor folder 1

  2. Name the folder.

    gsql editor folder 2

  3. You can add a new file to the folder by clicking on the + button.

  4. You can also rename or delete the folder via the … menu.

    gsql editor folder 3

Query List

The Query List in the GSQL Editor provides an overview of all custom queries for each graph. It helps you manage your queries efficiently, allowing you to create, edit, delete, and install queries.

  • View all custom queries for the current graph.

queries

  • Create a query by clicking on the + button on the side of the target graph.

add query

This feature helps you quickly view and edit custom queries on your graph.
query details

  • Edit existing queries by selecting the query and clicking the Edit button.

  • Delete queries that are no longer needed by selecting the query and clicking the Delete button.

  • If the query is not installed, you can install the query by selecting the query and clicking the Install button.

install query

Edit Schema

The schema defines the structure of your graph database, influencing its performance and functionality. You can easily open the Schema Designer in GSQL Editor by clicking on the right button.

For more details please see Get Started with Schema Designer.

Next Steps

Next, learn more about how to How to Edit, Run, and Share a GSQL Query.

Or return to the Overview page for a different topic.