Skip to content
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

feat(model) Add ContainerPath aspect model #7774

Conversation

chriscollins3456
Copy link
Collaborator

This adds the new containerPath aspect model. This will be used for our updated browse experience to show a different type of path.

Feel free to think more about the model and how it will be used and have a discussion here on this PR!

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - Thank you!

"delimiter": "/"
}
}
path: array[ContainerPathEntry]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I know we discussed this previously, but are we SURE that this modeling restriction won't get us into trouble?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any world in which it might?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm @jjoyce0510 do you have anything in mind? i'm definitely going to keep thinking about it before merging... and get approvals from at least one of the ingestion folks

@xiphl
Copy link
Contributor

xiphl commented Apr 7, 2023

Is the eventual plan to show containers and datasets together in browse?

* The ID of the container path entry - what gets stored in the index, URL encoded
* If there's an urn associated with this entry, id and urn will be the same
*/
id: string
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we ever want to use container paths to support a more custom "folder" type experience, where users can choose what path they want entities in, especially those that don't fit in containers? I think the lines are a little blurred because ContainerPaths aren't just for storing the path of containers for an entity, it's the path of containers for an entity + another path for entities that aren't stored in containers.

I know this is a significant change, but what do you think about making container paths be composed of only containers (thus can be a list of urns), then having a second aspect like CustomBrowsePath that we use for the non-container paths?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm yeah i definitely get what you're saying. Thinking about implementation, I personally would rather not have to know whether a given entity has containerPaths or some other aspect in order for us to operate browse.

The other thing is that we're going to need to filter on this aspect across all entity types (when they click a group on the sidebar of browse) so having that custom logic to filter for one field on elastic or another may be frustrating.

Maybe we can come up with a better name other than containerPaths? however the word "container" is already generic enough - it's just a little overloaded since we have actual "container" entities.

what do you think?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the name is ok, maybe there's a better one but I don't feel too strongly about it. Thinking over it more, this seems reasonable enough to me!

Co-authored-by: Harshal Sheth <hsheth2@gmail.com>
@chriscollins3456
Copy link
Collaborator Author

Is the eventual plan to show containers and datasets together in browse?

@xiphl yes! we're working towards a new browse experience that's based on containers for datasets

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants