Skip to main content

Source Models

After creating a connector to your data source, you'll need to create a model to bring that data into Rill. This can be implemented as either a SQL model with defined connector parameters or as a YAML configuration file. This guide focuses on YAML-based source models, which are auto-generated when using the UI.

# Model YAML
# Reference documentation: https://docs.rilldata.com/reference/project-files/models

type: model
materialize: true

connector: snowflake

sql: |
  select * from database_name.schema_name.table_name

YAML Structure​

The YAML configuration file contains several key parameters:

  • type: model: Explicitly defines the file type. While Rill automatically detects the file type based on the parent folder, this parameter provides explicit definition.
  • connector: Defines the connector type used to create the model (e.g., bigquery, athena, snowflake, etc.).
  • sql: The actual SQL query to be executed. When nested under dev:, the query runs in the Rill Developer environment.
  • dev: Configuration for development mode. Rill Developer runs in dev mode by default, but when deployed to Rill Cloud, the root-level SQL configuration executes. See Environment Templating for more information.

Examples​

BigQuery Model​

# Model YAML
# Reference documentation: https://docs.rilldata.com/reference/project-files/models

type: model
materialize: true

connector: bigquery

dev:
  sql: select * from project_id.dataset_name.table_name limit 10000

sql: select * from project_id.dataset_name.table_name

Snowflake Model​

# Model YAML
# Reference documentation: https://docs.rilldata.com/reference/project-files/models

type: model
materialize: true

connector: "snowflake"

dev:
  sql: select * from database_name.schema_name.table_name limit 10000

sql: select * from database_name.schema_name.table_name

S3 Model​

# Model YAML
# Reference documentation: https://docs.rilldata.com/reference/project-files/models

type: model
materialize: true

connector: "duckdb"

dev:
  sql: |
    select * from read_csv('s3://my-bucket/path/to/file.csv', auto_detect=true, ignore_errors=1, header=true) limit 10000

sql: |
  select * from read_csv('s3://my-bucket/path/to/file.csv', auto_detect=true, ignore_errors=1, header=true)

For more information, see our model reference documentation!

Next Steps​

Rill provides automatic refresh capabilities for your source models at specified intervals to maintain data currency. This functionality enables you to establish scheduled data ingestion without manual intervention, ensuring your analytics dashboards remain current with the latest information from your data sources. For additional details, see Scheduled Refreshes.

After validating your source model configuration and confirming the data preview appears correct, you can move forward to create your first metrics view. If no additional data transformations are needed, you can choose Generate Metrics View with AI from the top-right corner of the interface to initiate Rill's AI-powered dashboard generation.