-
Notifications
You must be signed in to change notification settings - Fork 125
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Update olap-engines.md Missing Pinot in available OLAP engines, * Update multiple-olap.md fixing page numbers on OLAP engines dropdown * Create connectors.md Create OLAP engine reference guide that sits at the bottom of the /reference/project-files
- Loading branch information
Showing
3 changed files
with
65 additions
and
1 deletion.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
title: Connector YAML | ||
sidebar_label: Connector YAML | ||
sidebar_position: 70 | ||
hide_table_of_contents: true | ||
--- | ||
|
||
|
||
When you add olap_connector to your rill.yaml file, you will need to set up a `<connector_name>.yaml` file in the 'connectors' directory. This file requires the following parameters,`type` and `driver` (see below for more parameter options). Rill will automatically test the connectivity to the OLAP engine upon saving the file. This can be viewed in the connectors tab in the UI. | ||
|
||
:::tip Did you know? | ||
|
||
You can have multiple OLAP engines in a single project and have each dashboard run on a different engine using the olap_connector parameter directly on a dashboard. | ||
|
||
::: | ||
|
||
|
||
## Properties | ||
|
||
**`type`** - refers to the resource type and must be connector | ||
|
||
**`driver`** - refers to the OLAP engine | ||
|
||
- _`duckdb`_ link to [ DuckDB Documentation](https://duckdb.org/docs/guides/overview.html) | ||
- _`clickhouse`_ link to[ Clickhouse documentation](https://clickhouse.com/docs/en/intro) | ||
- _`druid`_ link to[ Druid documentation](https://druid.apache.org/docs/latest/design/) | ||
- _`pinot`_ link to[ Pinot documentation](https://docs.pinot.apache.org/) | ||
|
||
**`host`** - refers the hostname for your OLAP engine | ||
|
||
**`port`** - refers the port for your OLAP engine | ||
|
||
**`username`** - the username, in plaintext | ||
|
||
**`password`** - the password, in plaintext | ||
|
||
**`ssl`** - depending on the engine, this parameter may be required (_pinot_) | ||
|
||
|
||
You can also connect using a dsn parameter. You cannot use the above parameters along with the **`dsn`** parameter. | ||
|
||
**`dsn`** - connection string containing all the details above, in a single string. Note that each engine's syntax is slightly different. Please refer to [our documentation](https://docs.rilldata.com/reference/olap-engines/) for further details. | ||
|
||
--- | ||
|
||
_Example #1: Connecting to a local running Clickhouse server (no security enabled)_ | ||
```yaml | ||
type: connector | ||
driver: clickhouse | ||
|
||
host: "localhost" | ||
port: "9000" | ||
``` | ||
_Example #2: Connecting to a ClickHouse Cloud _ | ||
```yaml | ||
type: connector | ||
driver: clickhouse | ||
|
||
|
||
dsn: "https://<hostname>:<port>?username=<username>&password=<password>&secure=true&skip_verify=true" | ||
|
||
``` |