Is it possible to create a "description" in Table/View schemas along with the usual (Column Type, Size, Restrict Values, etc.) so columns can be described and understood?


Having a "Description" of each column in the entity schemas would help columns be better understood by Curators or anyone working with the metadata of various resources in Synapse. Would it be possible to create this? is interested as well.




Brynn Zalmanek
April 23, 2021, 5:34 PM

That is a good question. I am not entirely sure if the column definition would be the same in every place used. what is your experience with that?

Bruce Hoff
April 23, 2021, 3:42 PM

Yes, a new field could be added to ColumnModel to describe it. The idea brings up some questions for us to consider: Since a Column definition can be used in multiple tables/views will the description be the same in every place or, instead, is the meaning of a column dependent on where it is used? If the latter then it would be better to add the description to the table/view rather than to the column. Also, in the future we hope to derive views from the JSON Schemas I mentioned earlier. So we have to think about how column descriptions would be derived from JSON Schema descriptions.

Brynn Zalmanek
April 23, 2021, 3:21 PM

Yes, I am referring to Tables and Views. Is that possible?

Bruce Hoff
April 23, 2021, 1:49 PM

I am confused because “Columns” relate to Tables and Views, but we also have JSON Schemas. Can you clarify which you are referring to? E.g. where in the Synapse UI do you want to see this description?

Kevin Boske
April 22, 2021, 8:23 PM

Emailed with Brynn, they want a description property for each column.

Your pinned fields
Click on the next to a field label to start pinning.


Kevin Boske


Brynn Zalmanek


Bruce Hoff




Development Area

Data Curation / Metadata