> For the complete documentation index, see [llms.txt](https://bitpicky.gitbook.io/dbt-sugar/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bitpicky.gitbook.io/dbt-sugar/installation-and-configuration/configuration/sugar-config.md). # Sugar Config The `sugar_config.yml` contains all the information necessary for dbt-sugar to know how to deal with your dbt models as well as setting up behavioural settings for dbt-sugar. The `sugar_config.yml` holds what we call "syrups". ## What are syrups? Syrups are dbt-sugars configurations profiles. You may only have one if you maintain only one dbt project, but you may have as many as you need if your setup interacts with different dbt projects for which you want different sets of controls. The `sugar_config.yml` looks something like this: {% tabs %} {% tab title="sugar\_config.yml" %} ```yaml defaults: syrup: syrup_1 target: dev syrups: - name: syrup_1 dbt_projects: - name: dbt_sugar_test path: "./tests/test_dbt_project/dbt_sugar_test" excluded_tables: - table_a ``` {% endtab %} {% endtabs %} {% hint style="warning" %} For now, dbt-sugar can only manage one dbt project per syrup. It is a known limitation and we plan to allow support for multiple projects (hence the use of plural) in a later feature release. Stay tuned! {% endhint %} ### defaults The defaults section allows you to declare which of the syrups you would like dbt-sugar to use as default so that you do not have to pass the `--syrup` CLI argument for the run type that you plan to execute most of the time. ### syrups Syrups are a list of entries made of a **name** which is how you will refer to the syrup you want dbt-sugar to use at runtime. Each **syrup** entry is made of a list of **dbt\_projects**. This is how you tell dbt-sugar where to find the dbt project you want it to sugar coat. It **must contain** the `name` of your dbt project and a `path` to that dbt project. It can also contain a series of other settings, which are listed below: #### excluded\_tables: You may have a use case where you do not want dbt-sugar to consider some of your dbt models (tables). You can simply list those and dbt-sugar will ignore everything about it. For example, it will not attempt to document it, nor will it look up its definitions, tests, and tags in the case where you want to homogenise column definitions across all your dbt models. #### excluded\_folders: A bit like `excluded_tables` but to exclude entire folders. #### use\_describe\_snowflake: {% hint style="info" %} Only applies to Snowflake warehouse users. **Experimental**! New in **v0.1.0** {% endhint %} If you're using Snowflake as your warehouse and have large schemas or tables, dbt-sugar might take a while to get all the information from your warehouse's `information_schema`. That is because the developers of the Snowflake SQLAlchemy plugin have opted for a slower method to get columns from a table (see and ). We therefore decided to allow users to opt in for an **experimental** alternative that uses `describe table` instead of `select` from `information_schema`. Set this argument to `true` and dbt-sugar will use this method from now on. **Needs to be set at the dbt\_projects level of your syrups (as shown below):** {% tabs %} {% tab title="sugar\_config.yml" %} ```yaml defaults: syrup: syrup_1 target: dev syrups: - name: syrup_1 dbt_projects: - name: dbt_sugar_test path: "./tests/test_dbt_project/dbt_sugar_test" excluded_tables: - table_a use_describe_snowflake: true ``` {% endtab %} {% endtabs %} #### preserve\_yaml\_order: {% hint style="info" %} New in **v0.1.0** {% endhint %} If you have comments in your `schema.yaml` files and you want to make sure that dbt-sugar does not delete them as part of its default behaviour to order models and columns alphabetically, you can choose to turn off this behaviour by setting the `preserve_yaml_order` config variable to `false`. This will make sure all your comments (inline or blocks) are preserved when we write back into your yaml file. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://bitpicky.gitbook.io/dbt-sugar/installation-and-configuration/configuration/sugar-config.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.