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 using a list of project configurations.

Structure

The buster.yml file uses a list under the projects key to define your project configurations. This allows you to connect to multiple data sources or schemas within the same Buster deployment if needed, or simply define your single project setup.

Configuration Options

The configuration is defined within the projects list. Each item in the list represents a project configuration:

FieldRequiredDescription
projectsYesList containing one or more project configurations.
projects[].pathYesProject path (relative to buster.yml location). Use . for the root directory.
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_pathsYesList of paths to directories containing semantic model files (relative to the project path).
projects[].semantic_model_pathsYesList of paths to directories containing semantic model definition files (relative to the project path).

Examples

Defining Projects

Here’s an example showing configurations for marketing and finance projects:

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

If you only have one project setup, your buster.yml would look like this:

projects:
  - path: .  # Use '.' for the main project directory
    data_source_name: snowflake_prod
    schema: analytics
    database: business_data
    model_paths:
      - models/
    semantic_model_paths:
      - semantic_models/