Repository navigation
metadata.overview does not propagate to Knowledge Catalog #2345
Description
Background
According to the Dataform documentation, the metadata property can add metadata to a table in Knowledge Catalog.
For example:
config {
type: "table",
metadata: {
overview: "This table provides standardized trip data."
}
}Steps to reproduce
- Define a Dataform table with a non-empty
metadata.overviewvalue, as shown above. - Execute the workflow:
- locally using
dataform run; or - through the Dataform UI in Google Cloud Console.
- locally using
- Wait for the table and its Knowledge Catalog entry to be updated.
- Open the table in Knowledge Catalog and inspect its overview metadata.
Expected behavior
Knowledge Catalog displays the value configured in metadata.overview:
This table provides standardized trip data.
Actual behavior
The table is created or updated successfully, but the configured overview is not displayed in Knowledge Catalog.
No error or warning indicating that metadata propagation failed is shown.
Environment
- Dataform Core version: 3.0.70
- Execution method: Local CLI and Google Cloud Dataform
- Google Cloud project region: US
- Repository region: US
- BigQuery dataset region: US
- First observed: August 31, 2026
Additional information
- Does the executing service account have the required Knowledge Catalog permissions? yes
- How long did you wait before checking Knowledge Catalog? 10 mins
- Does this also occur with a newly created table rather than an existing table? no
- Does other metadata, such as column descriptions, propagate successfully? yes
Metadata
Metadata
Assignees
Labels
No labels
Activity
kolina commentedon Sep 25, 2026
I see that it works as intended unfortunately:
US, I'll add @SkyrimL to take a look here. I think we need to update public documentation to mention this limitation and take a look if it's possible to add support for multi-regions in GCP Dataformrafal-hawrylak commentedon Sep 28, 2026
I've already added this part of the issue on our backlog:
"Dataform CLI doesn't support updating metadata in Knowledge Catalog yet, I'll add @rafal-hawrylak to triage it and find an assignee"
rafal-hawrylak commentedon Oct 22, 2026
I just filed a PR with support for Knowledge Catalog metadata updates in the CLI (including US/EU multi-regions) - #2407. @SkyrimL would you please take a look?