Skip to main content
Community Hub

Description reverse sync

TL;DR

Frequently asked questions about pushing description updates from Atlan to Snowflake, including what doesn't propagate and why a description doesn't reach Snowflake.

Your AI can read this via Docs MCPcurl -fsSL "https://docs.atlan.com/install-docs-mcp" | bashConnect

This FAQ answers common questions about description reverse sync for Snowflake. For the setup steps, see Push description updates to Snowflake.

Why didn't my description reach Snowflake?​

Check the following items in order:

  1. Reverse Sync Descriptions is on for that connection, and you saved the configuration at least 5 minutes before the edit.
  2. The connection connects to Snowflake directly, not through the self-deployed agent.
  3. The role that owns the object is available to the Atlan user. For details, see Grant Snowflake privileges.
  4. The asset type is in Description reverse sync statements.
  5. Someone wrote the description in Atlan, and the description isn't empty.

To find the statement that Atlan ran for an edit and its error, query the Snowflake query history as described in Verify description updates.

Why did my first description edit not reach Snowflake?​

The Reverse Sync Descriptions toggle takes a few minutes to take effect after you save it. Atlan discards any description edit that you make during that window, in the same way as an edit that you make while the toggle is off. Atlan doesn't notify you when the setting takes effect, so wait 5 minutes after you save, then edit the description again.

What happens to description edits I make while reverse sync is off?​

Atlan discards them. It doesn't queue those edits, and turning on the toggle later doesn't push them. To push an earlier edit to Snowflake, edit the description again after you turn on the toggle. To push every existing description of a connection at once, raise a support request.

What doesn't Atlan push to Snowflake?​

Atlan pushes only the descriptions that someone writes in Atlan. Atlan doesn't push the following:

  • Descriptions for asset types that aren't in Description reverse sync statements, for example procedures, stages, streams, and pipes.
  • Descriptions that Atlan imported from Snowflake.
  • Empty descriptions. If you clear a description in Atlan, the comment in Snowflake stays as it is.
  • Edits that you make while Reverse Sync Descriptions is off.
  • Certificates, owners, README content, terms, and tags. Tags have their own reverse sync.

How long does one description edit take to reach Snowflake?​

A few minutes. Atlan collects edits for a short time before it applies them, so a single edit isn't instant. You don't need to run a crawl.

What happens when Atlan lacks privileges to set comments?​

Atlan skips the edit and doesn't retry it. This happens when no role that Atlan can use owns the object, because Snowflake lets only the owner role set a comment. After your Snowflake administrator grants the privileges, edit the description again.

Can I use description reverse sync with self-deployed agent connections?​

No. Description reverse sync is available only for connections that connect to Snowflake directly. For the connection options, see Choose how Atlan connects to Snowflake.

See also​

Need help​

If you can't find the answer you're looking for, contact Atlan support by submitting a request.