This guide explains how to use dbt’s
meta configuration to customize how your dbt resources are displayed and categorized in Coalesce Quality.Prerequisites:- A working dbt Core or dbt Cloud integration with Coalesce Quality
- Familiarity with dbt’s meta configuration
Overview
Coalesce Quality reads thequality key of a dbt test’s meta configuration. Use it to set the check categories of a test:
check_categorysets the technical category, for examplenullnessore2e.governance_categorysets the governance category, for examplecompletenessortimeliness.
Check category
Use thecheck_category option to assign a dbt test to a technical check category. This is useful for singular tests and custom generic tests, which often have no category of their own.
Configuration
Add thequality configuration to your test’s meta block:
The original
synq namespace remains supported permanently, so existing
meta: {synq: {check_category: ...}} configurations do not need to change.
Use quality for new configurations.Governance category
Usegovernance_category in the same way to set the governance category of a test. You can set both keys on one test:
Example: Singular test
For a singular test file (e.g.,tests/e2e_order_flow.sql):
Example: Generic test in schema.yml
For generic tests defined in your schema files:Example: Custom generic test
For custom generic tests, add the config at the top of the test file:How it works
Coalesce Quality categorizes dbt tests automatically from the test type and package (e.g.,dbt, dbt_expectations, dbt_utils). For singular tests and custom generic tests it often cannot find a category.
A category set in meta replaces the automatic category of that test. Only a per-check override set by a workspace admin takes priority over it. See Where categories come from.
Custom categories
You can use any category name that makes sense for your organization. Common examples:Default categories
Coalesce Quality assigns technical categories to known test types fromdbt, dbt_expectations, dbt_utils and other packages. The most common ones are:
Use the same category names across your project, and write down what each custom category means so that your team uses them the same way.