Skip to content

Commit a532a89

Browse files
committed
first draft
1 parent 339a112 commit a532a89

File tree

4 files changed

+108
-18
lines changed

4 files changed

+108
-18
lines changed

docs/app/dashboards.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ You can freely resize every widget to match the layout you want to create.
1010

1111
## Creating a Dashboard
1212

13-
14-
1513
<div style="position: relative; padding-bottom: calc(66.66666666666666% + 41px); height: 0;"><iframe src="https://demo.arcade.software/xTAXmlo0nCL0FOn38hW9?embed" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;" title="Creating a dashboard"></iframe></div>
1614

1715

@@ -50,14 +48,15 @@ You can add text widgets to your dashboard.
5048

5149
Text widgets support a subset of Markdown. You can manipulate text and embed images and GIFs.
5250

53-
### Embedding Images and GIFs
51+
## Embedding Images and GIFs
5452

55-
Our text boxes can also be used to embed images or GIFs into your Dashboard.
53+
Text boxes can also be used to embed images or GIFs into your Dashboard.
5654

5755
The Syntax for embedding images is:
5856

59-
| [Image](https://www.markdownguide.org/basic-syntax/#images-1) | `![alt text](image url)` |
60-
| ------------------------------------------------------------- | ------------------------ |
57+
``` markdown
58+
![alt text](image url)
59+
```
6160

6261
Since you can't store images locally on our servers, you need to upload your images somewhere else or find the raw file somewhere on the internet.
6362

@@ -70,3 +69,24 @@ In practice this might look like this:
7069
You can resize the image by simply resizing the widget it is contained in.
7170

7271
You can combine images and text in one widget.
72+
73+
## Keeping your Dashboard up to date
74+
75+
Dashboards on Dune are not updated automatically. You can refresh your Dashboard by clicking on the "Run" button in the top right corner.
76+
77+
Alternatively, you can schedule your Dashboard to be refreshed in regular intervals.
78+
79+
<div style="position: relative; padding-bottom: calc(63.83333333333333% + 41px); height: 0; width: 100%"><iframe src="https://demo.arcade.software/doDebCcmeiVj5xKiq4nK?embed" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;" title="Meta Monitoring"></iframe></div>
80+
81+
To schedule a dashboard:
82+
83+
1. Click on the "clock" icon in the top right corner
84+
2. Select the frequency you want your Dashboard to be refreshed
85+
3. Select the execution tier you want to use
86+
4. Click on "Save"
87+
88+
You can also schedule individual queries to be refreshed. This is useful if you have a Dashboard with many queries and only want to refresh a few of them. Learn more about scheduling queries [here](/query-editor/query-scheduler.md).
89+
90+
## Sharing your Dashboard
91+
92+
You can share your public Dashboard by simply sharing the URL. For private dashboards, viewers need to be part of the same team as the team that owns the Dashboard. Alternatively, you can also share your Dashboard with individual users via the "Share" button in the top right corner.

docs/app/query-editor/query-scheduler.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,8 @@ Before we dive into the details, let's first take a look at when queries are exe
4444

4545
- **Interactive executions** are manually triggered by a user clicking the "Run" button in the query editor page or refreshing an entire dashboard. Interactive executions can be routed via the community, medium, or large cluster, depending on the query engine selected.
4646

47-
- **Automatic executions** are triggered whenever any user on Dune encounters a widget on a dashboard and the widget's underlying query results are "expired". As of now, query results are set to expire every 6 hours, although this is subject to change. These automatic executions are always routed via the community cluster.
48-
4947
- **Scheduled executions** are triggered at a specific time and frequency. Scheduled executions can be routed via the medium or large cluster, depending on the execution tier selected.
5048

51-
52-
5349
#### 1. Increase the execution frequency of your queries
5450

5551
To bypass the usual 6-hour expiration time of query results, you can schedule your queries to run at a higher frequency. This will ensure that your dashboard displays the most up-to-date data.
@@ -60,12 +56,6 @@ All automatic query executions are routed via the community cluster. This can le
6056

6157
If you schedule your queries instead of relying on automatic executions, you can choose a higher execution tier, which will ensure that your queries are executed reliably and in a timely manner.
6258

63-
### Additional Info
64-
➕ We plan to extend the functionality of query scheduling with webhooks, alerts, and the ability to update materialized views. We are also working on a allowing you to schedule a whole dashboard at once. Stay tuned for updates!
65-
66-
💭 Have an idea for additional features for scheduled queries? Please [submit them here](https://feedback.dune.com/)! We value your input and are regularly implementing improvements based on user feedback.
67-
68-
69-
### dashboard schedule arcade
59+
### Scheduling entire dashboards
7060

71-
<div style="position: relative; padding-bottom: calc(63.83333333333333% + 41px); height: 0; width: 100%"><iframe src="https://demo.arcade.software/doDebCcmeiVj5xKiq4nK?embed" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;" title="Meta Monitoring"></iframe></div>
61+
Instead of scheduling individual queries, you can also schedule entire dashboards. Learn more about scheduling dashboards [here](/app/dashboards.md#keeping-your-dashboard-up-to-date).

docs/query/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
nav:
22
- index.md
3+
- query-executions.md
34
- DuneSQL: DuneSQL-reference
45
- Writing efficient Queries: writing-efficient-queries.md
56
- Querying a query: query-a-query.md

docs/query/query-executions.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
title: Executions
3+
description: When and how do queries on Dune get executed?
4+
---
5+
6+
# Overview
7+
8+
**Queries on Dune need to be triggered and will be executed on one of our query engines.**
9+
10+
Query executions can be triggered by any user/team in Dune for public queries and by the owner of the query for private queries. Query executions can be triggered through the query editor, the dashboard editor, or via the API. We also automatically refresh popular dashboards automatically in regular intervals.
11+
12+
The query engine determines the amount of resources allocated to your query. The larger the query engine, the more resources are allocated to your query. This means that queries executed on a larger query engine will run faster and are less likely to time out.
13+
14+
## Query executions triggers
15+
16+
Query executions on Dune are triggered in four ways:
17+
18+
1. **Interactive executions** are manually triggered by a user clicking the "Run" button in the query editor page or refreshing an entire dashboard. Interactive executions can be routed via the community, medium, or large cluster, depending on the query engine selected.
19+
20+
2. **Scheduled executions** are triggered at a specific time and frequency. Scheduled executions can be routed via the medium or large cluster, depending on the execution tier selected.
21+
22+
3. **API executions** are triggered by an API call. API executions can be routed via the community, medium, or large cluster, depending on the query engine selected.
23+
24+
4. **Popular dashboards** are automatically refreshed based on their popularity. We measure popularity based on the number of views a dashboard has received. The most popular dashboards are refreshed every 30 minutes, the least popular dashboards are refreshed every 6 hours. Popular dashboards are refreshed via the community cluster.
25+
26+
27+
<div class="cards grid" markdown>
28+
29+
- #### Interactive executions
30+
31+
---
32+
33+
Trigger: user clicks "Run" button in query editor or refreshes dashboard
34+
35+
[→ Interactive executions](../app/query-editor/query-window.md)
36+
37+
- #### Scheduled executions
38+
39+
---
40+
41+
Trigger: scheduled dashboard or query
42+
43+
[→ Scheduled executions](../app/query-editor/query-scheduler.md)
44+
45+
- #### API executions
46+
47+
---
48+
49+
Trigger: API call
50+
51+
[→ API executions](../api/api-reference/execute-queries/index.md)
52+
53+
- #### Popular dashboards
54+
55+
---
56+
57+
Trigger: Dashboard popularity
58+
59+
60+
</div>
61+
62+
63+
## Query engine size
64+
65+
Dune has three query engine sizes: community, medium, and large. The query engine size determines the amount of resources allocated to your query. The larger the query engine, the more resources are allocated to your query. This means that queries executed on a larger query engine will run faster and are less likely to time out.
66+
67+
### Community engine
68+
69+
The community engine is the default query engine for all queries on Dune. It is a shared cluster, meaning that it is used by all Dune users. This means that the community cluster can be busy at times, which can lead to long loading times for the viewer if the query is resource-intensive. In the worst case, the query may even time out.
70+
71+
### Medium engine
72+
73+
The medium engine is built to handle most queries on Dune. It is cheap, reliable and fast. The medium engine will scale up and down depening on the demand. In contrast to the community engine, that means that running a query on the medium engine will not be affected by other users' queries.
74+
75+
### Large engine
76+
77+
The large engine is built to handle the most resource-intensive queries on Dune. It's blazing fast, reliable and can easily deal with large amounts of data. The large engine also scales up and down depending on the demand. Running a query on the large engine will not be affected by other users' queries.
78+
In addition to that, the large engine is also the only engine that can handle queries that requires lots of planning time. This mostly happens when you query a large amount of data, when you use a lot of joins or large aggregate window functions.
79+

0 commit comments

Comments
 (0)