-
Notifications
You must be signed in to change notification settings - Fork 126
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updated images for v51, added data warehouse tutorial, nit changes
- Loading branch information
Showing
23 changed files
with
231 additions
and
141 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
position: 90 | ||
label: Account Management | ||
collapsible: true | ||
collapsed: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: "Billing" | ||
description: How Billing works for non-enterprise accounts | ||
sidebar_label: "Billing Information" | ||
sidebar_position: 00 | ||
--- | ||
|
||
## Overview | ||
|
||
Billing cycles begin on the first of the every month (12:00am UTC). If you start your plan mid-monthm, your first month will be pro-rated accordingly. | ||
|
||
|
||
### How does it work? | ||
Rill Data does not use a user-based license system. Instead, we calculate your data usage, after ingestion, and calculate the pricing based on this. For more information on pricing, see our [pricing page](https://www.rilldata.com/pricing). | ||
|
||
## *Plan Details* | ||
|
||
### Team Plan | ||
|
||
|
||
|
||
### Trial Plan | ||
|
||
Get started with Rill Cloud with our 30 day free trial! Upon deployment of your first project, your trial will automatically start. See your Usage and Billing information in the Settings page. | ||
|
||
![deploy](/img/manage/billing/deploy-project.png) | ||
## Managing Payment Information | ||
|
||
|
||
### Accepted Payment methods |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,6 +3,90 @@ title: Alert YAML | |
sidebar_label: Alert YAML | ||
sidebar_position: 60 | ||
--- | ||
https://github.com/rilldata/rill/blob/d39df9f11a8300095e6ea247b1b5c2d2fd6b4ecb/runtime/compilers/rillv1/parse_alert.go#L18 | ||
|
||
Wait for confirmation on Product to add this YAML | ||
Along with alertings at the dashboard level and can be created via the UI, there might be more extensive alerting that you might want to develop and can be done so the an alert.yaml. When creating an alert via a YAML file, you'll see this denoted in the UI as `Created through code`. | ||
|
||
**`type`** — Refers to the resource type and must be `alert` _(required)_. | ||
|
||
**`title`** — Refers to the display name for the metrics view [deprecated, use `display_name`] _(required)_. | ||
|
||
**`display_name`** - Refers to the display name for the metrics view _(required)_. | ||
|
||
**`refresh`** - Specifies the refresh schedule that Rill should follow to re-ingest and update the underlying source data _(optional)_. | ||
- **`cron`** - a cron schedule expression, which should be encapsulated in single quotes, e.g. `'* * * * *'` _(optional)_. | ||
- **`every`** - a Go duration string, such as `24h` ([docs](https://pkg.go.dev/time#ParseDuration)) _(optional)_. | ||
- **`disable`** - boolean, completely disable the resource, without deleting it _(optional)_. | ||
- **`ref_update`** -: boolean, don't refresh when a dependency is refreshed _(optional)_. | ||
``` | ||
refresh: | ||
cron: "0 8 * * *" | ||
``` | ||
|
||
**`intervals`** - define the interval of the alert to check _(required)_. | ||
- **`duration`** - a valid ISO8601 duration to define the interval duration. _(required)_. | ||
- **`limit`** - maximum number of intervals to check for on invocation _(optional)_. | ||
- **`check_unclosed`** - boolean, whether unclosed intervals should be checked _(optional)_. | ||
|
||
```yaml | ||
intervals: | ||
duration: 'P3D' | ||
# limit: 5 | ||
# check_unclosed: true | ||
``` | ||
|
||
**`timeout`** - define the timeout of the alert in seconds _(optional)_. | ||
|
||
**`data`** - define the alert constraints using various parameters _(required)_. | ||
- **`connector`** - if running a SQL query or using `glob`, will need to define what connector to use _(optional)_. | ||
- **`sql`** - raw SQL query to run against existing tables and views in your project _(optional)_. | ||
- **`metrics_sql`** - a SQL query against a metrics view in your project _(optional)_. | ||
- **`api`** - name of existing custom API in your project _(optional)_. | ||
- **`args`** - used with `api` to define args to be passed to the API _(optional)_. | ||
- **`glob`** - define the path in your connector _(optional)_. | ||
- **`resource_status`** - | ||
- **`where_error`** - boolean, if the returning data alert constraints returns true or false _(required)_. | ||
|
||
```yaml | ||
#Alert will trigger if any of the project's resources return with a reconile error. | ||
data: | ||
resource_status: | ||
where_error: true | ||
``` | ||
**`on_recover`** - boolean, send alert on recovery, defaults to false _(optional)_. | ||
|
||
**`on_fail`** - boolean, send alert of failure, defaults to true _(optional)_. | ||
|
||
**`on_error`** - boolean, send the alert on error, defaults to false _(optional)_. | ||
|
||
**`renotify`** - boolean, enable to disable renotifcation of alert, defaults to false _(optional)_. | ||
|
||
**`renotify_after`** - define the renotification of the alert in seconds, equiavalent to snooze duration in UI, defaults to 'Off' _(optional)_. | ||
|
||
```yaml | ||
on_recover: true | ||
on_fail: true | ||
on_error: true | ||
renotify: true | ||
# renotify_after: 360m | ||
``` | ||
|
||
**`notify`** - define where to notify the user of the defined alert _(required)_. | ||
- **`email`** - | ||
- **`recipients`** - an array of emails to send the alert to _(optional)_. | ||
- **`slack`** - | ||
- **`users`** - an array of Slack users to send the alert notification to _(optional)_. | ||
- **`channels`** - an array of Slack channels to send the alert notification to _(optional)_. | ||
- **`webhooks`** - an array of webhooks to send the alert notification to _(optional)_. | ||
|
||
```yaml | ||
# Send notifications by email or slack | ||
notify: | ||
email: | ||
recipients: [[email protected]] | ||
slack: | ||
users: [] | ||
channels: [] | ||
webhooks: [] | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
76 changes: 76 additions & 0 deletions
76
...orials/rill_advanced_features/incremental_models/3-data-warehouse-partitions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,76 @@ | ||
--- | ||
title: "Increment Model based on a state from Data Warehouses" | ||
description: "Getting Started with Partitions" | ||
sidebar_label: "Data Warehouse: Increment Models" | ||
sidebar_position: 12 | ||
--- | ||
|
||
Another advanced concept within Rill is using [Incremental Models](/build/incremental-models/#what-is-an-incremental-model) with a state defined. | ||
|
||
:::tip requirements | ||
You will need to setup the connection to your data warehouse, depending on the connection please refer to [our documentation](https://docs.rilldata.com/reference/connectors/). | ||
|
||
In this example we use a DATE column as our defining state but depending on your data, you can use any defining column. | ||
|
||
::: | ||
|
||
## Understanding States in Models | ||
|
||
Here’s how it works at a high level: | ||
|
||
- **State Definition**: Based on a SQL query, defines a key that allows you to increment your model by | ||
- **Execution Strategy**: | ||
- **Full Refresh**: Runs without incremental processing. | ||
- **Incremental Refresh**: Run incrementally based on the state defined, following the output connector's `incremental_strategy` (either append or merge for SQL connectors). | ||
|
||
### Let's create a basic partitions model. | ||
|
||
:::note Example | ||
In this example, we are using a sample dataset that exists in Big Query: rilldata.ssb_100.date. | ||
In this case our table is not getting updated, so instead we'll modify the SQL to show you how incremental works. | ||
::: | ||
|
||
|
||
1. Create a YAML file: `SQL_incremental_tutorial.yaml` | ||
|
||
2. Use the following contents to create your own model. | ||
```yaml | ||
type: model | ||
materialize: true | ||
|
||
connector: "bigquery" #or "snowflake" | ||
|
||
incremental: true | ||
state: | ||
sql: SELECT MAX(DATE) as max_date FROM SQL_incremental_tutorial #should be the name of the current model | ||
|
||
sql: | | ||
SELECT *, | ||
PARSE_DATE('%Y%m%d', CAST(D_DATEKEY AS STRING)) AS DATE | ||
FROM rilldata.ssb_100.date | ||
{{if incremental}} # when incremental refreshing this part of the SQL is used. | ||
WHERE PARSE_DATE('%Y%m%d', CAST(D_DATEKEY AS STRING)) = '{{.state.max_date}}' #normally would want to set this to where DATE > '{{.state.max_date}}' to only append new rows. | ||
{{else}} | ||
LIMIT 10 #restricts the full refresh to only 10 rows, so when we run incremental, its easy to tell the difference. | ||
{{end}} | ||
output: | ||
connector: duckdb | ||
incremental_strategy: append #merge, requires unique_key | ||
#unique_key: [column_name] #if strategy is merge | ||
``` | ||
|
||
3. In the UI, try refreshing both incrementally and fully to see the difference in the model that loads. | ||
- when selecting a full refresh, only 10 rows should be returned. | ||
- when selecting incremental refresh, it will **append** values to the inital 10 values in the full refresh. | ||
|
||
![img](/img/tutorials/302/data-warehouse-refresh.png) | ||
|
||
:::note Partition vs. State | ||
Unlike partitions, states do not paritition the dataset per refresh so you will not be able to via the UI or CLI, see if there is a specific partition that errored and manually refresh this. In the cases of data disrecpancies in a state incremented model, please run a full refresh. | ||
::: | ||
|
||
import DocsRating from '@site/src/components/DocsRating'; | ||
|
||
--- | ||
<DocsRating /> |
Oops, something went wrong.