Skip to main content

synced_description

Definition​

The synced_description property contains the description of a concept as synchronized from the database schema.

If supported by the database associated with the knowledge graph, descriptions (depending on the database system, these may also be called "comments" or "documentation") of tables and columns are periodically fetched and copied into this property.

The synced_description is used as a default concept description in case no custom description is set on the concept. This description is not localized and does not support translations in different languages.

info

Any manual changes to this property will be overwritten during the next schema synchronization Use description if you want to customize the description or translate it to different languages.

How it Works​

The synced_description is updated automatically as part of the daily schema synchronization.

Usage​

The synced_description property is available on class, relationship, and all attributes.

Since this property is automatically managed, you typically don't need to set it manually. However, you can view its value in the Knowledge Graph to see what description was synchronized from the database.

Precedence​

Descriptions will be shown to users according to this priority:

  1. If a description is set on the concept, it will be used
  2. If no description is set, the synced_description will be used as a fallback
  3. If neither is set, no description will be shown