- Overview
- Platform setup and administration
- Platform setup and administration
- Platform architecture
- Data Bridge onboarding overview
- Connecting a Peak-managed data lake
- Connecting a customer-managed data lake
- Creating an AWS IAM role for Data Bridge
- Connecting a Snowflake data warehouse
- Connecting a Redshift data warehouse (public connectivity)
- Connecting a Redshift data warehouse (private connectivity)
- Reauthorizing a Snowflake OAuth connection
- Using Snowflake with Peak
- SQL Explorer overview
- Roles and permissions
- User management
- Inventory management solution
- Commercial pricing solution
- Merchandising solution
Supply Chain & Retail Solutions user guide
SQL Explorer overview
SQL Explorer is Peak's built-in SQL client and data visualization tool. It lets you create, edit, and save SQL queries, and visualize results using a range of ready-made charts.
Opening SQL Explorer
In Peak, go to Tools and select SQL Explorer.
From the SQL Explorer screen, you can:
- View and search your saved queries.
- Delete queries.
- Launch the SQL Editor to create new queries or edit saved ones.
Exploring saved queries
Hover over a saved query to access the following options:
| Option | Description |
|---|---|
| Info | Displays the user who created the query, when it was last updated, the query path, and the CSV path. The query path can be copied. |
| Edit | Opens the query in the SQL Editor. |
| Delete | Deletes the query. |
SQL Editor features
The SQL Editor provides the following capabilities:
- Multi-tab environment for running multiple queries simultaneously
- Automatic handling of unresponsive queries
- Autoformat and autocomplete for SQL code
- Query history with execution status
- Support for multiple databases and schemas
- Result visualization with charts
- Copy results and copy query functions
- Configurable row limits
- Selective script execution
- Save query output as CSV to Amazon S3
- Query beautifier
Working in multiple tabs
The SQL Editor uses tabs so you can edit and run multiple queries at the same time. If one query becomes unresponsive, a new worker node starts automatically to handle your other queries. You can then stop the unresponsive query and adjust it as needed, for example by reducing the row limit.
Using autoformat and autocomplete
The SQL Editor includes a code library to assist with query writing. It provides code completion, suggested keywords, and autocomplete for table and column names.
Reviewing query history
The SQL Editor keeps a history of executed queries. Each entry shows:
- Success or failure status
- Start time
- Duration
- Progress (if the query is still running)
Browsing schemas
SQL Explorer supports multiple database types, including Redshift and Snowflake. You can view the available schemas for the selected database and preview schema tables along with their attribute names and data types.
Visualizing results
After a query runs successfully, select Visualize to explore results using ready-made charts.
The Visualize button is not available in the following conditions:
- The query ran but returned no results.
- Multiple queries are running and none has been selected.
- You change the schema, database, or interact with the current tab after running a query.
Copying results
After a query runs successfully, select Copy Results to copy the output and paste it into another application while preserving the tabular formatting.
To copy the query text itself, select Copy Query. This preserves the query formatting when pasting.
Setting row limits
You can set a row limit for query results. Available options are:
- 500
- 1,000
- 2,000
- No Limit
If you select No Limit, you can define your own limits directly in your SQL queries. If you select a specific row limit, you cannot use TOP or LIMIT in your SQL queries.
The system returns results up to 5 MB or 10,000 rows, whichever is less.
Running partial scripts
A script can contain multiple SQL queries. You can select specific queries within a script and run only those, or abort a query that is currently running.
Saving query output as CSV
You can save query output as a .csv file on Amazon S3. Saved files are accessible from Downloads, in the Manage section.
Formatting queries
The Beautifier formats your SQL queries by adding spaces, tabs, and line breaks where needed. It supports SELECT, INSERT, UPDATE, and DELETE statements and works regardless of the target database.
The following formatting conventions apply:
- Two-space indentation
- Multiple queries separated by an empty line
SQL dialect detection: The SQL Editor detects the dialect based on the selected database. For example, selecting a Redshift database applies Redshift-specific formatting rules.
Per-tab formatting: Each tab can use a different SQL dialect. The Beautifier applies formatting based on the database selected in that tab.