GITBOOK-591: Adding "Query referencing" docs

This commit is contained in:
Winnie Chen 2024-11-20 15:11:13 +00:00 committed by gitbook-bot
parent 38d685a807
commit 9ba89a40c2
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
31 changed files with 175 additions and 119 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 164 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 161 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 269 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 329 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 524 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 489 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 393 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 481 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 696 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 453 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 348 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 347 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 82 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 234 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

View File

@ -54,14 +54,14 @@
* [Studio in Depth](data/data-products/data-studio-sql-analysts/studio-in-depth/README.md)
* [Query Editor](data/data-products/data-studio-sql-analysts/studio-in-depth/query-editor/README.md)
* [Pro Tips for Querying](data/data-products/data-studio-sql-analysts/studio-in-depth/query-editor/pro-tips-for-querying.md)
* [Query Referencing](data/data-products/data-studio-sql-analysts/studio-in-depth/query-editor/query-referencing.md)
* [Keyboard Shortcuts](data/data-products/data-studio-sql-analysts/studio-in-depth/query-editor/keyboard-shortcuts.md)
* [Hex-to-Integer Function](data/data-products/data-studio-sql-analysts/studio-in-depth/query-editor/hex-to-integer-function.md)
* [Create a Chart](data/data-products/data-studio-sql-analysts/studio-in-depth/create-a-chart/README.md)
* [Advanced Visualization](data/data-products/data-studio-sql-analysts/studio-in-depth/create-a-chart/advanced-visualization.md)
* [Build a Dashboard](data/data-products/data-studio-sql-analysts/studio-in-depth/dashboard-editor/README.md)
* [Markdown Reference](data/data-products/data-studio-sql-analysts/studio-in-depth/dashboard-editor/markdown-reference.md)
* [Dashboard V2 (Beta)](data/data-products/data-studio-sql-analysts/studio-in-depth/dashboard-v2-beta.md)
* [Team Accounts](data/data-products/data-studio-sql-analysts/team-accounts.md)
* [Build a Dashboard](data/data-products/data-studio-sql-analysts/studio-in-depth/build-a-dashboard/README.md)
* [Markdown Reference](data/data-products/data-studio-sql-analysts/studio-in-depth/build-a-dashboard/markdown-reference.md)
* [Team Accounts](data/data-products/data-studio-sql-analysts/studio-in-depth/team-accounts.md)
* [Tutorials](data/data-products/data-studio-sql-analysts/tutorials/README.md)
* [How to Analyze Web3 Data](data/data-products/data-studio-sql-analysts/tutorials/how-to-analyze-web3-data.md)
* [Video Tutorials](data/data-products/data-studio-sql-analysts/tutorials/tutorials/README.md)

View File

@ -9,14 +9,14 @@ description: >-
This section will cover:
* [How does ranking work on the discover page?](discover.md#ranking-on-the-discover-page)
* [How does ranking work on the Insights page?](discover.md#ranking-on-the-discover-page)
* [How to find a dashboard I'm interested in?](discover.md#searching-on-the-discover-page)
* [How to find an analyst I know?](discover.md#analyst-view)
* [How to interact with a dashboard?](discover.md#interacting-with-a-dashboard)
***
"Top Dashboards refers to the first dashboards listed on the [discover page](http://flipsidecrypto.xyz). These are the dashboards that fill the landing page, primed for maximum exposure to alpha-seekers. 
"Top Dashboards refers to the first dashboards listed on the [Insights page](https://flipsidecrypto.xyz/insights/dashboards). These are the dashboards that fill the landing page, primed for maximum exposure to alpha-seekers. 
<figure><img src="../../../.gitbook/assets/Screenshot 2023-03-09 at 1.57.18 PM.png" alt=""><figcaption><p>Top 8 </p></figcaption></figure>
@ -32,14 +32,14 @@ That's a bit of 🧪 a l c h e m y ✨ that will stay a secret. But we can tell
***
### Finding things from the Discover page
### Finding things from the Insights page
There are 100K+ dashboards on Flipside 🤯 Here's how to find the ones you're interested in!&#x20;
<figure><img src="../../../.gitbook/assets/Group 2149.png" alt=""><figcaption><p>Ways to browse dashboards on Flipside. </p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2024-11-20 at 10.07.49AM.png" alt=""><figcaption></figcaption></figure>
* **Search for a topic:** if you have a topic in mind (like: "impermanent loss osmosis"), type it into the search bar to see all the relevant dashboards.&#x20;
* **Find an analyst:** if you have someone in mind, you can search for them from the ["Analyst View"](discover.md#analyst-view)
* **Find an analyst:** if you have someone in mind, you can search for them from the "[Analyst View](https://flipsidecrypto.xyz/insights/analysts)"
* **Focus on a project:** if you have a project you're interested in, simply use the filter on the right-hand side to only see dashboards relevant to that project.&#x20;
***
@ -48,11 +48,11 @@ There are 100K+ dashboards on Flipside 🤯 Here's how to find the ones you're i
To search for an analyst, all you have to do is turn the toggle in the hero section from **"Dashboards"** to **"Analysts"**. Similar to how dashboards are ranked on the Discover page, analysts are also ranked in this view. Analysts closer to the top of the page are those who have created impactful and influential dashboards.&#x20;
From [this view](https://flipsidecrypto.xyz/analysts), you can type an analyst's name into the search bar to find their profile, or explore different analyst profiles by going down the page.&#x20;
From [this view](https://flipsidecrypto.xyz/insights/analysts), you can type an analyst's name into the search bar to find their profile, or explore different analyst profiles by going down the page.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-05-30 at 8.57.42 PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2024-11-20 at 10.08.41AM.png" alt=""><figcaption></figcaption></figure>
Once you find the analyst you're looking for, you can click on their profile to find their top dashboards, and potentially a few ways to get in touch with them. This is a great way to connect with other analysts in the space so make sure you build out your own [profile](broken-reference) too!
Once you find the analyst you're looking for, you can click on their profile to find their top dashboards, and potentially a few ways to get in touch with them. This is a great way to connect with other analysts in the space so make sure you build out your [own profile](https://flipsidecrypto.xyz/settings/profile) too!
<figure><img src="../../../.gitbook/assets/Screenshot 2023-05-30 at 9.05.49 PM.png" alt=""><figcaption></figcaption></figure>
@ -72,9 +72,7 @@ Here are some ways you can interact with a dashboard:
* **Check the query:** if you're curious about a query behind a chart, simply click on the chart title to view it.
* **Fork a query:** build on any query you find interesting by copying it into your workspace.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-05-05 at 11.34.31 AM.png" alt=""><figcaption><p>Click "Fork" to make a copy of the query. </p></figcaption></figure>
<figure><img src="../../../.gitbook/assets/Screenshot 2024-11-20 at 10.10.12AM.png" alt=""><figcaption></figcaption></figure>
* **Refresh:** Click the 🔁 button on the top right corner to run all the queries powering this dashboard to see the latest information.
* **Like:** if you liked what you saw, hit the ❤️ button — "likes" impact the rankings and you'll help more people see good work by voting for things you enjoy.
* **Share:** found something interesting, share it with your community on Twitter!

View File

@ -73,7 +73,7 @@ order by sales_count desc
limit 8
```
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-12-11 at 9.51.25PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.59.06AM.png" alt=""><figcaption></figcaption></figure>
***
@ -81,11 +81,11 @@ limit 8
Steps:
1. Click "Add Chart" right below the query panel.&#x20;
1. Click "Create Visualization" button right next to your query title.&#x20;
2. Choose the chart type that best captures your data's essence. Bar, line, pie?&#x20;
3. Define the data points by setting your X and Y axes.&#x20;
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-12-11 at 9.49.47PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 10.00.41AM.png" alt=""><figcaption></figcaption></figure>
***

View File

@ -12,17 +12,17 @@ To get started, open a new query in your Studio (an easy way to do this is to vi
To understand exactly what data is included in a table before you query it, click "Preview":
<figure><img src="../../../../.gitbook/assets/Untitled design-12.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.47.15AM.png" alt=""><figcaption></figcaption></figure>
This will populate a sample of the table for you instantly in your Studio.
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-12-06 at 8.48.15 AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.47.56AM.png" alt=""><figcaption></figcaption></figure>
## Add to query
To auto-populate the name of the table in your query, you can use the double-arrow "Add to query" button:
<figure><img src="../../../../.gitbook/assets/Untitled design-13.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.50.39AM.png" alt=""><figcaption></figcaption></figure>
Now you understand how to navigate the database and find the tables that contain the data you need, so you're ready to start writing your own SQL queries and generating onchain insights.&#x20;
@ -36,23 +36,21 @@ You can fork a query from any public dashboard you like. Here's how:
### **Find a dashboard**&#x20;
From the [Discover page](https://flipsidecrypto.com/discover), choose any dashboard you find interesting.
From the [Insights page](https://flipsidecrypto.xyz/insights/dashboards), choose any dashboard you find interesting.
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-12-06 at 8.56.50 AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.51.48AM.png" alt=""><figcaption></figcaption></figure>
### **Click a chart title**
Choose a visualization you'd like to replicate, and click its title. For example, let's click on "SOL volume in period":
Choose a visualization you'd like to replicate, and click on the **\</> icon**. For example, let's click take a look at **"Total Stablecoin Supply"**:
<figure><img src="../../../../.gitbook/assets/Untitled design-14.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.54.40AM.png" alt=""><figcaption></figcaption></figure>
### Fork the query
Clicking a chart title in a public dashboard will show you the query and resulting table the author used to create it. That can often give you the ideas you need for your own query.&#x20;
Clicking the **"\</>"** icon in a public dashboard will show you the query and resulting table the author used to create it. That can often give you the ideas you need for your own query.&#x20;
But if you want to use or edit the same query, you can just click "Fork" in the top right corner, which will auto-populate the same query and visualization settings in your studio:
<figure><img src="../../../../.gitbook/assets/Untitled design-15.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-11-20 at 9.56.19AM.png" alt=""><figcaption></figcaption></figure>

View File

@ -2,10 +2,10 @@
The Studio has a few basic components, here's how they fit together:
* [**Discover**](../discover.md) — the best way to keep your finger on the pulse of what's happening in crypto data. Here you can see what dashboards are trending for different chains and projects, fav ones you like, keyword search for specific topics, and see which analysts are consistently topping the charts.
* [**Insights**](../discover.md) — the best way to keep your finger on the pulse of what's happening in crypto data. Here you can see what dashboards are trending for different chains and projects, fav ones you like, keyword search for specific topics, and see which analysts are consistently topping the charts.
* **Work items** — where the work lives: get here by clicking on the folder icon in the side nav. Keyword search to open any work you've done in the past. Group files by creating collections and nesting collections. Organize by using features like multi-select and drag & drop.&#x20;
* [**Query Editor**](query-editor/) — where the work happens: get here by navigating to the Studio in the top nav. Run SQL queries, get results, visualize them, and publish them on a dashboard, all from one place in the app. Seamlessly switch between any of your queries and dashboards with our tabs system, and use the Data Explorer to preview data tables, and add table names directly to your queries.&#x20;
* [**Dashboard Editor**](dashboard-editor/) — where you share your findings with the world: add charts, results tables, text and images to your dashboards, send them to your friends with our copy link feature, or tweet the link directly from the dashboard. Organize your findings with dashboard tabs, and let people customize or update your dashboard with parameters.
* **Profiles** your profile is the place where people can find all your best work, search and filter it, and see how to get get in touch with you if that's something you want! Update your avatar and background image, and add social contact details for Twitter, Telegram, and Discord.
* [**Dashboard Editor**](build-a-dashboard/) — where you share your findings with the world: add charts, results tables, text and images to your dashboards, send them to your friends with our copy link feature, or tweet the link directly from the dashboard. Organize your findings with dashboard tabs, and let people customize or update your dashboard with parameters.
* [**Profiles**](https://flipsidecrypto.xyz/settings/profile) your profile is the place where people can find all your best work, search and filter it, and see how to get get in touch with you if that's something you want! Update your avatar and background image, and add social contact details for Twitter, Telegram, and Discord.
We're adding more documentation for the Studio over time — if you have questions or suggestions for things to add, please let us know by [opening a ticket](../../../../support/open-a-ticket.md).

View File

@ -4,11 +4,11 @@ description: >-
create richer, more interactive narratives!
---
# Dashboard V2 (Beta)
# Build a Dashboard
### Learning the basics of the new builder&#x20;
### Learning the basics of dashboard builder&#x20;
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-07-22 at 3.18.43PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../../.gitbook/assets/Screenshot 2024-07-22 at 3.18.43PM.png" alt=""><figcaption></figcaption></figure>
#### **New UX pattern with the dual panel builder**
@ -27,16 +27,16 @@ description: >-
**Scoped Parameters:** parameters are now specific to individual layouts, ensuring your audiences know exactly which visualizations the parameters apply to.&#x20;
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-07-23 at 9.48.37AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../../.gitbook/assets/Screenshot 2024-07-23 at 9.48.37AM.png" alt=""><figcaption></figcaption></figure>
**Custom dashboard thumbnails:** Upload custom thumbnails for your dashboards, giving them a unique visual identity that reflects their content.&#x20;
<div align="left">
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-07-24 at 6.15.57AM.png" alt="" width="268"><figcaption></figcaption></figure>
<figure><img src="../../../../../.gitbook/assets/Screenshot 2024-07-24 at 6.15.57AM.png" alt="" width="268"><figcaption></figcaption></figure>
</div>
**Streamlined Workflow:** you can now directly edit the details of any chart within the dashboard builder itself. This eliminates the need to jump back and forth between the chart builder and the dashboard,
<figure><img src="../../../../.gitbook/assets/Screenshot 2024-07-24 at 6.25.01AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../../.gitbook/assets/Screenshot 2024-07-24 at 6.25.01AM.png" alt=""><figcaption></figcaption></figure>

View File

@ -1,73 +0,0 @@
---
description: Tell a story with data and share your findings with the world
---
# Build a Dashboard
This section will cover:
* [What can you add to a dashboard?](./#overview-of-dashboard-components)
* [How to add content to a dashboard?](./#building-a-dashboard)
* [How to publish a dashboard?](./#publishing-a-dashboard)
***
### Overview of Dashboard Components
Before we go over how to populate a dashboard, we'll go over the different components of a dashboard.&#x20;
<figure><img src="../../../../../.gitbook/assets/Screenshot 2023-03-10 at 1.16.16 PM.png" alt=""><figcaption></figcaption></figure>
In the example dashboard above, we get a glimpse of how different components look on a dashboard. Starting from the top of the screen, and moving down, we see an example of each of the following:
* **Dashboard Title and Description:** be sure to update these! They help people understand what to expect from your dashboards, and make them easier to find on the Discover page.
* **Tabs:** use these as "pages" of a dashboard, that readers can flip through. Analysts often use tabs to organize information by topic.&#x20;
* **Headings:** are header components that can be styled using the **\[A]** in the top right corner of the header box. You can choose the text color, background, text size, and alignment.&#x20;
<figure><img src="../../../../../.gitbook/assets/Screenshot 2023-03-14 at 10.06.20 AM.png" alt=""><figcaption><p>Heading styles. </p></figcaption></figure>
* **Text boxes:** these are regular text boxes that are best suited for paragraphs. The style of these text boxes can be adjusted using [markdown](https://www.markdownguide.org/basic-syntax/).&#x20;
* **Images:** this helps bring your story to life. You can upload a PNG, SVG, GIF, or JPEG.
* **Charts and Tables:** the star of the show, you can add charts and tables from your queries to the dashboard.&#x20;
***
### **Building A Dashboard**
Now that we have the basics covered, we'll introduce three different ways you can add content to your dashboard.&#x20;
* **From the query editor:** to add tables and charts from the editor, click the "Add to Dashboard" button in the top right corner of each panel. From there, you can select a dashboard, search for a dashboard, or create a new dashboard.
<figure><img src="../../../../../.gitbook/assets/Screenshot 2023-03-12 at 6.26.59 PM.png" alt=""><figcaption><p>Add tables and charts to a dashboard from the editor. </p></figcaption></figure>
* **From the action bar:** this is the floating bar at the bottom of the dashboard builder. It is accessible via a dashboard tab that you open in the editor. Click on any component to add a block of that type, or drag any component onto the board directly to add it exactly where you want it to go:
![Action Bar from the Dashboard Editor. ](<../../../../../.gitbook/assets/Screenshot 2023-03-10 at 2.03.30 PM (1).png>)
* **From My Work 😮:** drag and drop any table and chart from My Work directly into your dashboard. Click on the little caret to the left of a query's name to see all the tables and charts associated with it:
![Expanded query item under My Work.](<../../../../../.gitbook/assets/Screenshot 2023-03-10 at 2.38.47 PM.png>)
**Move and Resizing Components**
Once, the components are added to the dashboard, they can be repositioned and resized!
* Reposition a component by dragging and dropping them into blank spaces on the dashboard.&#x20;
* Resize a component by clicking and dragging on the " **⸥** " in the bottom right corner of the container.
***
### Publishing a Dashboard
Once you complete a dashboard, publish it to make it publicly accessible! You can do that by clicking on the "Publish" button in the top right corner of the screen (don't worry this process is irreversible! More on that later). A published dashboard can be accessed by anyone through the Discover page, your analyst profile, and if they have the URL, directly.&#x20;
<figure><img src="../../../../../.gitbook/assets/share.png" alt=""><figcaption></figcaption></figure>
**Un-publishing / Editing a dashboard**
Don't worry: if you made a mistake in your dashboard, you can easily make changes, then click the the Update button >> Publish Updates to make those changes live.\
\
You can also Unpublish here, which will make your dashboard disappear — people visiting the link will see a 404 error until you publish it again.

View File

@ -0,0 +1,133 @@
---
description: Easily reference results from exiting queries!
---
# Query Referencing
Query Referencing allows you to streamline your analysis workflow by reusing the results of previously executed queries as data sources for new queries. This feature enhances query organization, promotes reusability of complex result sets, and significantly boosts query performance.
### Overview
This section will cover:
1. [How to reference a query?](query-referencing.md#syntax)
2. [How to leverage query referencing to speed up parameter runs?](query-referencing.md#leveraging-query-referencing-for-performance-optimization)
3. [How to decide which query to reference?](query-referencing.md#how-to-decide-which-query-to-reference)
4. [Limitations](query-referencing.md#limitations)
***
### How to reference a query?
1. **Identify the Query:**
1. Navigate to the desired query and click **"Copy Reference"** button to obtain the query ID.&#x20;
2. \[screenshot]
3. To reference your own query, find the query you want to reference under "My Work". Click the 3-dot menu, and select "Add to Query".
<figure><img src="../../../../../.gitbook/assets/ezgif.com-video-to-gif-converter (1).gif" alt=""><figcaption></figcaption></figure>
2. **Reference the Query:**
* In your new query, use the following syntax to reference the query:
{% code overflow="wrap" lineNumbers="true" %}
```sql
SELECT *
FROM $query('query_id')
```
{% endcode %}
3. **Join with other tables:**
* You can join the referenced query with other tables in your dataset:
{% code overflow="wrap" lineNumbers="true" %}
```sql
SELECT *
FROM bitcoin.core.fact_transactions t
JOIN $query('query_id') AS my_query
ON my_query.blockheight = t.blockheight
```
{% endcode %}
***
### Leveraging Query Referencing for Performance Optimization
A significant advantages of Query Referencing is its ability to dramatically improve the performance of parameterized queries.
{% tabs %}
{% tab title="With Query Referencing" %}
1. Pre-calculate the 100,000 most relevant addresses:
<pre class="language-sql" data-overflow="wrap" data-line-numbers><code class="lang-sql">select
<strong> from_address,
</strong><strong> count(1) as n_tx -- can safely count(1) b/c this table is 1 row per tx_hash
</strong>from ethereum.core.fact_transactions
where block_timestamp >= '2024-01-01'
group by from_address
having n_tx &#x3C; 20001 -- assume > 20k is bots
order by n_tx desc
limit 100000;
</code></pre>
2. Reference the pre-calculated result:&#x20;
{% code overflow="wrap" lineNumbers="true" %}
```sql
select * from
$query('0a0d54ca-f8de-43fe-8e5f-c270272982f9') -- query id taken from studio URL
where from_address = '{{wallet_address}}';
```
{% endcode %}
{% hint style="success" %}
By pre-calculating the relevant addresses and referencing the result, you can significantly improve query performance, especially when dealing with large datasets and frequent parameter changes.
{% endhint %}
{% endtab %}
{% tab title="Without Query Referencing " %}
This approach requires the query to be re-executed for each user, leading to potential performance bottlenecks.
```sql
select
from_address,
count(tx_hash) as n_tx
from base.core.fact_transactions
where block_timestamp >= '2024-01-01'
and from_address = '{{wallet_address}}'
```
{% endtab %}
{% endtabs %}
***
### How to decide which query to reference?
1. **Do Your Own Research (DYOR):** Always verify the logic and accuracy of the referenced query.
{% hint style="info" %}
Since all public queries can be referenced, make sure you trace query dependencies! Hover over any `$query('query_id')` and click on the query title in the popover to view all information about the underlying query.&#x20;
{% endhint %}
<figure><img src="../../../../../.gitbook/assets/Screenshot 2024-11-14 at 2.38.11PM.png" alt="" width="563"><figcaption></figcaption></figure>
2. **Consider Query Refresh Rates:** Ensure that the referenced query is refreshed at an appropriate interval to provide up-to-date results.
{% hint style="info" %}
* To ensure up-to-date results, set a "Refresh Rate" on your base query
* Any new query referencing the results will automatically use the refreshed data
* Refreshes follow standard query refresh capabilities
{% endhint %}
3. **Understand Cache Expiration:** Be aware of the cache duration and expiration rules for referenced queries.
{% hint style="warning" %}
* Results are cached and available for 24 hours by default
* Each reference within the 24-hour window extends availability by another 24 hours
* Maximum cache duration is 31 days
{% endhint %}
***
### Limitations
Base queries that utilize parameters will always execute with their default values when referenced. Currently, theres no mechanism to dynamically pass parameters into the $query() function. It is best to avoid using parameters in your base queries.

View File

@ -21,16 +21,16 @@ description: Build, iterate, and riff with your team in real-time.
1. Navigate to the "Account" dropdown in the top right corner of the page. In the dropdown menu, you'll find the option to "Create Team Account".
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 6.38.15PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 6.38.15PM.png" alt=""><figcaption></figcaption></figure>
2. Fill in the form with your Team name, Flipside profile link, team website URL, and Twitter handle. Click "Create Team" to land in the Team's Profile. This is the home base to invite teammates and find published dashboards.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 6.39.48PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 6.39.48PM.png" alt=""><figcaption></figcaption></figure>
3. Add Team Members via their Flipside username or their email. Assign them a role and hang tight!&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 6.40.32PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 6.40.32PM.png" alt=""><figcaption></figcaption></figure>
4. To accept an invite, refresh the page to find invites in the "Account" dropdown. Once accepted, it's time to collaborate!&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 7.01.28PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 7.01.28PM.png" alt=""><figcaption></figcaption></figure>
***
@ -40,10 +40,10 @@ Seamlessly collaborate with your teammates on the same query or dashboard.&#x20;
* See who is currently working on a query or dashboard and what they are doing by following their cursors.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 7.16.00PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 7.16.00PM.png" alt=""><figcaption></figcaption></figure>
* Multiple analysts can work on the same query and dashboard together. For example, two analysts on the same query can simultaneously write CTEs. Or, two analysts can work on different tabs of a dashboard.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 7.55.54PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 7.55.54PM.png" alt=""><figcaption></figcaption></figure>
***
@ -51,7 +51,7 @@ Seamlessly collaborate with your teammates on the same query or dashboard.&#x20;
Regardless of what workspace you're working in, get credit for the hard work you put in. A dashboard published by a team will list individual team members who worked on the particular dashboard.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-29 at 8.03.48PM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-29 at 8.03.48PM.png" alt=""><figcaption></figcaption></figure>
***
@ -67,7 +67,7 @@ When a dashboard is transferred, all underlying queries of that dashboard will b
To transfer a dashboard or query to another workspace, click on the overflow menu **(⋅⋅⋅)** and select "Copy to Workspace". Then in the modal, select the workspace you'd like to transfer to.&#x20;
<figure><img src="../../../.gitbook/assets/Screenshot 2023-10-31 at 9.46.49AM.png" alt=""><figcaption></figcaption></figure>
<figure><img src="../../../../.gitbook/assets/Screenshot 2023-10-31 at 9.46.49AM.png" alt=""><figcaption></figcaption></figure>
***