Description reverse sync statements
TL;DR
Snowflake asset types that description reverse sync supports, and the statement Atlan runs in Snowflake for each one.
Your AI can read this via Docs MCPcurl -fsSL "https://docs.atlan.com/install-docs-mcp" | bashConnect
This reference lists the asset types that description reverse sync supports, and the statement Atlan runs in Snowflake for each one.
Supported asset types
| Atlan asset | Statement Atlan runs in Snowflake |
|---|---|
| Database | COMMENT ON DATABASE "<db>" IS '...' |
| Schema | COMMENT ON SCHEMA "<db>"."<schema>" IS '...' |
| Table, external table | COMMENT ON TABLE "<db>"."<schema>"."<table>" IS '...' |
| Dynamic table | COMMENT ON DYNAMIC TABLE "<db>"."<schema>"."<table>" IS '...' |
| Iceberg table | ALTER ICEBERG TABLE "<db>"."<schema>"."<table>" SET COMMENT = '...' |
| View | COMMENT ON VIEW "<db>"."<schema>"."<view>" IS '...' |
| Materialized view | COMMENT ON MATERIALIZED VIEW "<db>"."<schema>"."<view>" IS '...' |
| Function | COMMENT ON FUNCTION "<db>"."<schema>"."<function>"(<argument types>) IS '...' |
| Column of a table, external table, or dynamic table | COMMENT ON COLUMN "<db>"."<schema>"."<table>"."<column>" IS '...' |
| Column of an Iceberg table | ALTER ICEBERG TABLE "<db>"."<schema>"."<table>" ALTER COLUMN "<column>" COMMENT '...' |
| Column of a view or materialized view | ALTER VIEW "<db>"."<schema>"."<view>" ALTER COLUMN "<column>" COMMENT '...' |
Atlan doesn't push descriptions for any other asset type, for example procedures, stages, streams, and pipes.
Statement behavior
- Each statement sets the comment to the description of the asset at the time Atlan applies the edit. If you edit a description several times in a short time, Snowflake gets the latest text.
- A comment on a view column or a materialized view column doesn't change the view definition or its grants. Atlan doesn't recreate the view.
- Each statement needs the
OWNERSHIPprivilege on the object. For details, see Grant Snowflake privileges. - Atlan runs each statement with the query tag
atlan-snowflake-description-reverse-sync.
See also
- Push description updates to Snowflake: Enable description reverse sync for a connection
- Description reverse sync FAQ: What doesn't propagate, timing, and why a description doesn't reach Snowflake