> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Rill Connector | OpenMetadata Dashboard Integration

> Connect Rill to OpenMetadata with our dashboard connector guide. Ingest Explore and Canvas dashboards, charts, data models, and lineage.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/rill.svg" name="Rill" stage="BETA" availableFeatures={["Dashboards", "Charts", "Datamodels", "Projects", "Lineage"]} unavailableFeatures={["Owners", "Tags"]} />

This section provides guides and references for the Rill connector.
Configure and schedule Rill metadata workflows from the OpenMetadata UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](/v2.1.x-SNAPSHOT/connectors/dashboard/rill/troubleshooting)

## Requirements

The Rill connector reads metadata from a Rill runtime over its representational state transfer (REST) application programming interface (API). It works with both deployment styles:

* **Rill Developer**: a local or self-hosted Rill runtime. Point **Host and Port** at the runtime URL (for example, `http://localhost:9009`). An API token is optional.
* **Rill Cloud**: a hosted project. Point **Host and Port** at the project endpoint (for example, `https://api.rilldata.com/v1/orgs/<org>/projects/<project>`). An **API Token** is required.

The connector doesn't support Rill Cloud branch-level routing yet. If your project URL includes a `/branch/<name>` segment, remove it before configuring the connection.

The token must have read access to the project's resources. OpenMetadata uses that access to list the following:

* Dashboards, including Explore and Canvas dashboards
* Charts, including Canvas components
* Data models, including SQL models and metrics views
* Relationships between these assets

Project metadata is available for Rill Cloud only. A Rill Developer runtime doesn't expose a project.

## Metadata Ingestion

To ingest metadata from Rill, you need to create a service connection. The service connects Rill with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata.

### Step 1: Add New Service

1. Navigate to **Settings** > **Services**.

   <img src="https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max&auto=format&n=pD1dbe0lKPSqnODv&q=85&s=c95e6e79c73eea68039c10115c7f80d6" alt="Navigate to Settings and Services" width="3004" height="1578" data-path="public/images/connector2.0/metadata-ingestion/access-services.png" />

2. Click **Add New Service**.

   <img src="https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=pD1dbe0lKPSqnODv&q=85&s=13457ef6e565aa39d339db30ce1f354d" alt="Add New Service" width="3002" height="1514" data-path="public/images/connector2.0/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **Dashboard Services**, then click the **Rill** connector tile.

<img src="https://mintcdn.com/openmetadata/mJT4D4_Bk_rGpVE4/public/images/connector2.0/metadata-ingestion/Dashboard/select-service/rill.png?fit=max&auto=format&n=mJT4D4_Bk_rGpVE4&q=85&s=8e9ea82814634b4087f413159893dbab" alt="Select Service" width="2772" height="1484" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/select-service/rill.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other Rill services you're ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/openmetadata/mJT4D4_Bk_rGpVE4/public/images/connector2.0/metadata-ingestion/Dashboard/service-name/rill.png?fit=max&auto=format&n=mJT4D4_Bk_rGpVE4&q=85&s=04b965e8db996b920b0304771b02d486" alt="Add New Service Name" width="2034" height="820" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/service-name/rill.png" />

<Note>
  The service name can't be changed after it's set.
</Note>

### Step 4: Configure Connection Options

Specify your source credentials and verify the connection.

#### Enter Connection Details

Enter the connection details for Rill. The inline help panel in the UI describes each field.

<img src="https://mintcdn.com/openmetadata/mJT4D4_Bk_rGpVE4/public/images/connector2.0/metadata-ingestion/Dashboard/connection-details/rill.png?fit=max&auto=format&n=mJT4D4_Bk_rGpVE4&q=85&s=fc1cf4ba772a6b0487602b58849e3799" alt="Configure Service Connection" width="2022" height="1520" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/connection-details/rill.png" />

* **Host and Port**: URL of a Rill Developer runtime or a Rill Cloud project endpoint. For a local Rill Developer runtime, use something like `http://localhost:9009`. For Rill Cloud, use the project endpoint, for example `https://api.rilldata.com/v1/orgs/<org>/projects/<project>`.
* **API Token**: API token used to authenticate with Rill. Required for Rill Cloud. Optional for a Rill Developer runtime that doesn't require authentication.
* **Verify SSL**: Whether to verify SSL certificates when connecting to Rill. Defaults to `true`.

#### Test Connection

After you add the credentials, click **Test Connection**, then click **Save**.

<img src="https://mintcdn.com/openmetadata/9G75p72jJKYgvFUQ/public/images/connectors/test-connection.png?fit=max&auto=format&n=9G75p72jJKYgvFUQ&q=85&s=4ac71a56e30fa3dd1be86f82c1f07068" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, configure filter rules for dashboards, charts, and data models.

#### How Filter Rules Work

Each rule matches asset names using one of five match types:

* **Contains**: Matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **Starts with**: Matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **Ends with**: Matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **Is exactly**: Matches the exact name only. For example, `analytics` matches only `analytics`.
* **Matches regex**: Matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When include and exclusion rules both match an asset, the exclusion rule takes priority.

<Tip>
  Leave all filter rules empty to ingest all dashboards, charts, and data models available in the source.
</Tip>

#### Filter Options

The **Dashboard**, **Chart**, and **Data Model** sections control ingestion for the corresponding asset type. Each section provides the following controls:

* **Scan Mode**: Choose one of the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules**: In **Only specific** mode, click **+ Add** to define a rule. Added rules appear as chips. OpenMetadata includes an asset if it matches any rule.

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts dashboards, charts, data models, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the service type.

   <img src="https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max&auto=format&n=pD1dbe0lKPSqnODv&q=85&s=4471655da6e39d91776597e4a7eea513" alt="Navigate to Settings and Services" width="2992" height="1612" data-path="public/images/connector2.0/metadata-ingestion/access-service-type.png" />

2. Click the service you have added.

3. Select the **Agents** tab and click **Add Agent** > **Metadata**.

   <img src="https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=pD1dbe0lKPSqnODv&q=85&s=a654d9700126ce64cb6c9a99b8d69b1a" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/connector2.0/metadata-ingestion/add-metadata-agent.png" />

   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/openmetadata/pD1dbe0lKPSqnODv/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=pD1dbe0lKPSqnODv&q=85&s=92954c166518e3ac07589ab20865e3e7" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/connector2.0/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure ingestion parameters. The following fields are available:

     | Field | Default | Description |
     | - | - | - |
     | Db Service Prefixes | — | List of database service name prefixes used to resolve lineage between dashboards and database assets. Accepted formats: `DBService`, `DBService.Database`, `DBService.Database.Schema`, `DBService.Database.Schema.Table`. |
     | Query Parser Type | Auto | Select the SQL parser used for lineage extraction from dashboard queries. **Auto** selects the best available parser automatically. **SqlGlot** is a high-performance parser with excellent dialect support; falls back to SqlParse on failure. **SqlFluff** is a comprehensive parser with strong dialect support; falls back to SqlParse on failure. |
     | Mark Deleted Dashboards | On | Soft-delete dashboards in OpenMetadata when they are removed from the source. Associated lineage is also deleted. |
     | Mark Deleted Data Models | On | Soft-delete data models in OpenMetadata when they are removed from the source. Associated lineage is also deleted. |
     | Mark Deleted Charts | On | Soft-delete charts in OpenMetadata when they are removed from the source. |
     | Include Data Models | On | Ingest data model metadata. |
     | Include Draft Dashboards | On | Ingest dashboards that are in draft state. |
     | Include Usage | On | Collect and ingest usage statistics for dashboards. |

     <img src="https://mintcdn.com/openmetadata/yF8COhiuvOumxlqe/public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-agent-setup.png?fit=max&auto=format&n=yF8COhiuvOumxlqe&q=85&s=8a54b313e0d986dd7b4a4d515ba483d2" alt="Agent Setup" width="1570" height="1434" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which dashboards, charts, data models, and projects this agent ingests. These follow the same filter options described in **Step 5: Configure Ingestion Options**.

     <img src="https://mintcdn.com/openmetadata/yF8COhiuvOumxlqe/public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-filter-pattern.png?fit=max&auto=format&n=yF8COhiuvOumxlqe&q=85&s=795273f2feb45fa7ead3b726976b24ef" alt="Filter Patterns" width="1546" height="844" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-filter-pattern.png" />

   * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     | Toggle | Default | Description |
     | - | - | - |
     | Enable Debug Log | Off | Sets the ingestion log level to DEBUG. Useful for troubleshooting. |
     | Include Current Owners | Off | When enabled, replaces the current owner with a new owner from the source if the current owner is null. Recommended to keep enabled during the first metadata ingestion to capture owner information. |
     | Include Tags | On | Ingest tags from the source. |
     | Override Metadata | Off | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value. |
     | Override Lineage | Off | When on, existing lineage is replaced with newly extracted lineage on each run. |

     <img src="https://mintcdn.com/openmetadata/yF8COhiuvOumxlqe/public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-scope-bahaviour.png?fit=max&auto=format&n=yF8COhiuvOumxlqe&q=85&s=578e5010409e392de2df672350ec5a5e" alt="Scope & Behaviour" width="1552" height="1014" data-path="public/images/connector2.0/metadata-ingestion/Dashboard/dashboard-scope-bahaviour.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/openmetadata/j50Bw6ZBiFbbFFnF/public/images/connectors/schedule.png?fit=max&auto=format&n=j50Bw6ZBiFbbFFnF&q=85&s=24b0c2f55f803efde5fb3b3bc24ed3ae" alt="Schedule Interval" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />

6. Click **Add** to deploy the agent.

## Lineage

Lineage in OpenMetadata shows you which database tables power each dashboard. When lineage is set up, you can trace any dashboard back to the exact source tables in your database.

There is no separate lineage agent or lineage pipeline—lineage is collected as part of the same metadata ingestion workflow. Configuring the **Db Service Prefixes** field (covered below) is optional but recommended — it restricts table matching to specific database services. If left blank, OpenMetadata attempts to match source tables across all ingested database services.

<img src="https://mintcdn.com/openmetadata/Uz9EHuUsFWt0w2EL/public/images/connectors/lineage-information.png?fit=max&auto=format&n=Uz9EHuUsFWt0w2EL&q=85&s=35ed3a7572be399f22f05a326dcbf7f3" alt="lineage Information" width="2234" height="878" data-path="public/images/connectors/lineage-information.png" />

### How to Set Up Lineage

1. Go to **Settings** > **Services** > **Dashboards**.
2. Click the dashboard service you've added.
3. Go to the **Agents** tab, then select **Add Agent** > **Add Metadata Agent**.

   If a metadata agent already exists, select the three-dot context menu (⋮) next to it and select **Edit**.
4. In the **Configure Ingestion** step, scroll down to the **Lineage Information** section.
5. Optionally enter one or more database service names in the **Db Service Prefixes** field to restrict table matching to specific services. If left blank, OpenMetadata searches across all ingested database services.

The **Db Service Prefixes** field helps OpenMetadata locate the source tables and draw the lineage path from table to dashboard.

**Examples of valid entries:**

| What you enter | What it matches |
| - | - |
| `SnowflakeProd` | All tables in the Snowflake service named `SnowflakeProd` |
| `SnowflakeProd.sales_db` | Tables in the `sales_db` database within `SnowflakeProd` |
| `SnowflakeProd.sales_db.public` | Tables in the `public` schema within `sales_db` |

<Tip>
  If your dashboards pull data from multiple database services, add each service as a separate entry in the **Db Service Prefixes** field.
</Tip>

## Related

<Columns cols={2}>
  <Card title="Usage Workflow" href="/v2.1.x-SNAPSHOT/connectors/ingestion/workflows/usage">
    Learn more about how to configure the Usage Workflow to ingest Query information from the UI.
  </Card>

  <Card title="Lineage Workflow" href="/v2.1.x-SNAPSHOT/connectors/ingestion/workflows/lineage">
    Learn more about how to configure the Lineage from the UI.
  </Card>

  <Card title="Profiler Workflow" href="/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow">
    Learn more about how to configure the Data Profiler from the UI.
  </Card>

  <Card title="Data Quality Workflow" href="/v2.1.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure">
    Learn more about how to configure the Data Quality tests from the UI.
  </Card>

  <Card title="dbt Integration" href="/v2.1.x-SNAPSHOT/connectors/database/dbt">
    Learn more about how to ingest dbt models' definitions and their lineage.
  </Card>
</Columns>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.