REFERENCES
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 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:
Field | Required | Description |
---|---|---|
projects | Yes | List containing one or more project configurations. |
projects[].path | Yes | Project path (relative to buster.yml location). Use . for the root directory. |
projects[].data_source_name | Yes | Name of the data source connection defined in Buster. |
projects[].schema | Yes | Database schema containing your tables. |
projects[].database | Yes | Database name to connect to. |
projects[].model_paths | Yes | List of paths to directories containing semantic model files (relative to the project path). |
projects[].semantic_model_paths | Yes | List 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:
If you only have one project setup, your buster.yml
would look like this: