Query Editor
  • 30 Aug 2022
  • 1 Minute to read
  • Dark

Query Editor

  • Dark

Article Summary

The Query Editor allows users to write queries against any established database connection. These queries can be saved for future use and are available for quick access. The results of any query can be downloaded and saved as a CSV file.

The option Allow Designers to Use Query Editor under System > Settings > Designer Studio Settings > QUERY EDITOR permits all Designer users to access the Query Editor and the ability to execute queries if it is checked.

Accessing the Query Editor

The Query Editor can be found by right-clicking any Designer Project Folder and selecting Other > Query Editor.

Using the Query Editor

To ensure that data is not caught in the cache, changes in the Query Editor should be followed by a service restart.
  1. Selecting Query Editor will open the New Database Query window. On the right side of the window is the Connection dropdown menu that allows the user to choose any established database connection. 
  2. In the search bar, enter "entity_account" to search the database connection for the entity_account Table. To inspect the Table schema, expand the list by clicking to the left of the Table name.
  3. Generate a query on the Table by selecting a query on the action menu when hovering over a Table. In the entity_account action menu, select Generate "Select" Query.

    Alternate Query Method 
    As the Query Editor allows the ability to perform queries on Tables within a selected database, SQL Queries may also be generated manually by providing them as text input in the box on the left-hand side and then clicking RUN.
  4. On the left-hand panel, click RUN.
  5. After the query runs, users can take the query results and export them to a CSV file by clicking Download as CSV. If desired, users also can save the query for future use by clicking SAVE, naming the query, and selecting Save.
  6. In the Designer Project, users can see saved queries and re-run them via the action menu.

For further information on Administration, visit the Decisions Forum.

Was this article helpful?