buster.yml

The buster.yml file is the primary configuration file for your Buster project. It defines how Buster connects to your data sources and where to find your semantic models.

Basic Structure

Buster.yml now supports a multi-project configuration, allowing you to define multiple projects within a single file. This is useful when you need to connect to multiple data sources or schemas within the same Buster deployment.

# Single project configuration
data_source_name: demo_db
schema: analytics
database: buster
model_paths:
  - models/

# OR

# Multi-project configuration
projects:
  - path: .
    data_source_name: new_one
    schema: ont-ont
    database: postgres
    model_paths:
      - models/

Configuration Options

Single Project Configuration

For simple setups with a single data source:

FieldRequiredDescription
data_source_nameYesName of the data source connection defined in Buster
schemaYesDatabase schema containing your tables
databaseYesDatabase name to connect to
model_pathsNoList of paths to directories containing semantic model files (relative to buster.yml)

Multi-Project Configuration

For advanced setups with multiple data sources:

FieldRequiredDescription
projectsYesList of project configurations
projects[].pathYesProject path (relative to buster.yml location)
projects[].data_source_nameYesName of the data source connection defined in Buster
projects[].schemaYesDatabase schema containing your tables
projects[].databaseYesDatabase name to connect to
projects[].model_pathsNoList of paths to directories containing semantic model files (relative to project path)

Examples

Single Project

data_source_name: snowflake_prod
schema: analytics
database: business_data

Multi-Project

projects:
  - path: ./marketing
    data_source_name: snowflake_marketing
    schema: marketing_analytics
    database: marketing_data
    model_paths:
      - models/
  
  - path: ./finance
    data_source_name: postgres_finance
    schema: finance
    database: financial_data
    model_paths:
      - models/
      - legacy_models/