-
Notifications
You must be signed in to change notification settings - Fork 73
[SYNPY-1746] Add IsTemplate column to Curator CSV data model #1311
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🔥 LGTM! One feedback: from a product perspective, how might one know how to use this column?
I'll defer to @SageGJ for final review - during review please consider how this may impact your generate jsonschema action work and how we advise dcc's to update their data models.
| Defining data types: | ||
|
|
||
| - Put a unique data type name in the `Attribute` column. | ||
| - Put the value `DataType` in the `Parent` column. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From a Product perspective, I just wanted to confirm that having the "Parent" column will not cause this code to fail. Is this correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@thomasyu888 I realized I hadn't updated the documentation, this is fixed now :)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @andrewelamb, the question remains, will having the Parent column be an issue at all?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Parent is now an optional column. In fact, technically, anything is an optional column. We have it that way so that data modelers can add whatever optional columns they wish, and the Curator Extension will just ignore them.
| ### IsTemplate | ||
|
|
||
| Put the value `DataType` in this column if this row is a data type. Other values are currently ignored. It is currently used to find all the data types in the data model. | ||
| Put the value `True` in this column if this row is a data type(template). It is currently used to find all the data types in the data model. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@andrewelamb what's the behavior if both Parent and IsTemplate columns are present?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For creating JSON Schema, the Parent column will now be ignored. (It can still be used for other purposes, like the visualization tool, which was its original intended purpose from what I understand).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got, thanks!
SYNPY-1746
Problem:
The method of using the
Parentcolumn in CSV data models was problematic for several reasons.Solution:
The consensus solution was to add a new column,
IsTemplate, that is a boolean like therequiredcolumn. If the value isTruein theIsTemplatecolumn, that row is considered a datatype.