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

The role of the dataset UUID #54

Open
mortenpi opened this issue Nov 8, 2022 · 0 comments
Open

The role of the dataset UUID #54

mortenpi opened this issue Nov 8, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@mortenpi
Copy link
Member

mortenpi commented Nov 8, 2022

Right now, a dataset has two unique identifiers (unique within a data repository anyhow): name :: String and uuid :: UUID. The UUID is mandatory, but not really used as far as I can tell. I think we should explicitly document its role. A few thoughts:

  • UUID could be a more permanent way of referencing a dataset. It would also allow you to disambiguate if there are multiple data repositories with different datasets that have the same name.
  • A data repo should be thought of as UUID => DataSet dictionary. The name is there as additional metadata, for user-convenience.
  • It should be noted that there is nothing stopping you from having duplicate UUIDs (or names) referring to potentially very different data. However, for UUIDs, we would expect this to be rare.

There are a few tangential API changes we could do:

  • We should also probably introduce APIs for accessing datasets via a UUID (I don't think that exists right now).
  • We should probably allow users to rename datasets. It's not recommended to do it often, but it can be handy. The UUID would stay constant through renames, for cases where stability is important. This is really the case where UUID becomes important.
@mortenpi mortenpi added the documentation Improvements or additions to documentation label Nov 8, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant