Skip to content

docs(workspace): add links to SQL Runner #6618

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

Merged
merged 1 commit into from
May 17, 2023
Merged

docs(workspace): add links to SQL Runner #6618

Show file tree
Hide file tree
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
10 changes: 10 additions & 0 deletions docs/content/Workspace/Developer-Playground.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,15 @@ Security Context</Btn>:
You can paste in an existing JWT if desired; or create a brand-new one by
providing a JSON object that represents the decoded JWT.

## Executing generated SQL

To see the SQL generated by a query, click <Btn>Generated SQL</Btn>:

<Screenshot src="https://ucarecdn.com/43011e86-8a0e-414b-a192-3c07a47c2694/" />

If you're using Cube Cloud, you can copy this SQL and run it in your data source
using the [SQL Runner][ref-workspace-sqlrunner].

## Using the Rollup Designer

The Rollup Designer provides an easy way to create and edit
Expand Down Expand Up @@ -118,3 +127,4 @@ model. You can then run the query again to see the results:
[ref-preaggs-ref-partitiongranularity]:
/schema/reference/pre-aggregations#parameters-partition-granularity
[ref-preaggs-ref-indexes]: /schema/reference/pre-aggregations#parameters-indexes
[ref-workspace-sqlrunner]: /cloud/sql-runner
9 changes: 9 additions & 0 deletions docs/content/Workspace/Inspecting-Queries.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,14 @@ pre-aggregation:

<Screenshot src="https://ucarecdn.com/537f7269-654d-479c-a0cc-abc2941f9b5a/" />

You can also run the SQL query directly against your data source using the [SQL
Runner][ref-workspace-sqlrunner] by clicking <Btn>▶️</Btn>:

<Screenshot
highlight="inset(51.5% 2.5% 44% 94% round 10px)"
src="https://ucarecdn.com/537f7269-654d-479c-a0cc-abc2941f9b5a/"
/>

### <--{"id" : "Inspecting API Queries"}--> Pre-Aggregations

The <Btn>Pre-Aggregations</Btn> tab shows the
Expand Down Expand Up @@ -186,3 +194,4 @@ while the query is in the query execution queue:
[ref-conf-db]: /config/databases
[ref-deployment-api-instance]: /deployment/overview#api-instances
[ref-deployment-refresh-worker]: /deployment/overview#refresh-worker
[ref-workspace-sqlrunner]: /cloud/sql-runner