atlas-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From David Radley <david...@apache.org>
Subject Re: Review Request 62244: ATLAS2058 Add description to attributedefs and relationship enddefs
Date Wed, 13 Sep 2017 08:48:32 GMT


> On Sept. 12, 2017, 6:15 p.m., Sarath Subramanian wrote:
> > intg/src/main/java/org/apache/atlas/model/typedef/AtlasStructDef.java
> > Lines 275 (patched)
> > <https://reviews.apache.org/r/62244/diff/1/?file=1820214#file1820214line275>
> >
> >     can we include descriptions for existing attributes and relationshipEndDefs
for out of the box models as part of this JIRA?
> 
> David Radley wrote:
>     I think it is better to separate the putting values into the models into separate
Jiras. We can then use those Jiras to review the description content rather than the mechanism
to introduce description.
> 
> Madhan Neethiraj wrote:
>     I agree. However, I would suggest adding 'Map<String, String> aliases' field
to struct-def and attribute-def - to enable alternate names for these to be stored along with
entity-def, classification-def and attribute-def. This should be a trivial update and can
be taken up along with addition of 'description' field.

I am unsure what the keys and values might be for the aliases map you are proposing. Are you
thinking that the aliases would be instance aliases or type aliases? 

We are thinking of adding external type identifications (ExternalTypeIdDefs) as a new array
associated with attributes, structures (and the otehr defs). We are thinking the elements
would be specified in the typeDefs in the form:

ExternalTypeIdDefs [
{   "scheme":"O-DEF",
    "value":"123-456",
    "description":"Relational Database",
    "ResponsibleOrg":"Open Group",
    "ReferenceDocumentationURL":"http://xxx.yyy.zzz"
},
{
...
}
]

Scheme and value would be manditory.

One way to handle type aliases would be using the above mechanism: 
{   "scheme":"alias",
    "value":"RDB",
    "description":"short hand relational database key for consumer A",
    "ResponsibleOrg":"Consumer A organisation",
    "ReferenceDocumentationURL":"http://aaa.bbb.bbb"
},

or

{   "scheme":"alias",
    "value":"RDB"
},


This would allow these external type identifier metadata values to be visible in the json
models.

I was thinking of doing this piece separately in another Jira. The addition of the code as-is
in the Jira will in enable me to add desciptions to the attributes / relationship ends in
the new models. For the existing Hadoop models - it might be worth having someone more expert
in Hadoop filling in those descriptions.


- David


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviews.apache.org/r/62244/#review185223
-----------------------------------------------------------


On Sept. 12, 2017, 5:13 p.m., David Radley wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviews.apache.org/r/62244/
> -----------------------------------------------------------
> 
> (Updated Sept. 12, 2017, 5:13 p.m.)
> 
> 
> Review request for atlas and Madhan Neethiraj.
> 
> 
> Repository: atlas
> 
> 
> Description
> -------
> 
> ATLAS2058 Add description to attributedefs and relationship enddefs
> 
> 
> Diffs
> -----
> 
>   intg/src/main/java/org/apache/atlas/model/typedef/AtlasRelationshipEndDef.java 01e5ce738e8a5310cee928560364d4a38f5c6e18

>   intg/src/main/java/org/apache/atlas/model/typedef/AtlasStructDef.java 3a5c43ac7e6d0a7f683c24d13d6c841de4d66a14

>   repository/src/main/java/org/apache/atlas/repository/store/graph/v1/AtlasStructDefStoreV1.java
c3c42be86d8c9fd282fdc1428c8fd78e338a3cfb 
> 
> 
> Diff: https://reviews.apache.org/r/62244/diff/1/
> 
> 
> Testing
> -------
> 
> Create an entity attribute, relationship attribute and a relationship end with a description
and then issue getTypeDefs to check they are there.
> 
> 
> Thanks,
> 
> David Radley
> 
>


Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message