Skip to main content

Connector YAML

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.

Did you know?

Starting from Rill 0.46, you can directly create OLAP engines from the UI! Select + Add -> Data -> Connect an OLAP engine


type - refers to the resource type and must be 'connector'

driver - refers to the OLAP engine

A note on OLAP engines

By defining the connector parameter in a dashboard's YAML file, you can have multiple OLAP engines in a single project.

host - refers to the hostname

port - refers to the port

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 for further details.

Example #1: Connecting to a local running Clickhouse server (no security enabled)

type: connector
driver: clickhouse

host: "localhost"
port: "9000"

Example #2: Connecting to a ClickHouse Cloud

type: connector
driver: clickhouse

dsn: "https://<hostname>:<port>?username=<username>&password=<password>&secure=true&skip_verify=true"