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

Core protocol v3.0 - node names #25

Conversation

alimanfoo
Copy link
Member

This PR adds a draft for the section on node names.

* must not be the empty string ("")

* must consist only of characters in the sets `a-z`, `A-Z`, `0-9`,
`-_.`
Copy link
Member Author

Choose a reason for hiding this comment

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

Is this too restrictive? I was thinking that node names are used in file paths when using file system storage, and so we should ensure no characters are used that could be problematic within a file system path. But are there other characters that people use in dataset naming that would be safe to include?

keys during retrieval. Therefore, within a hierarchy, all nodes within
a set of sibling nodes must have a name that is unique under
case-insensitive comparison. E.g., the names "foo" and "FOO" are not
allowed for sibling nodes.
Copy link
Member Author

Choose a reason for hiding this comment

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

This restriction is to deal with the situation where file system storage is used on a platform with a case insensitive file system, e.g., current default on mac I believe.

`-_.`

* must not be a string composed only of period characters, e.g. "." or
".."
Copy link
Member Author

Choose a reason for hiding this comment

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

Again this is to avoid node names that would be problematic in a file path.

* must not be a string composed only of period characters, e.g. "." or
".."

* must be at most 255 characters long
Copy link
Member Author

Choose a reason for hiding this comment

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

Again this is to avoid node names that would be problematic in a file path.

@alimanfoo alimanfoo requested a review from a team May 9, 2019 16:24
@alimanfoo alimanfoo force-pushed the core-protocol-v3.0-node-names branch from 794daa6 to d1cc3e7 Compare May 9, 2019 16:44
@alimanfoo alimanfoo changed the title WIP: Core protocol v3.0 - node names Core protocol v3.0 - node names May 14, 2019
@alimanfoo
Copy link
Member Author

In the interests of having content together in one place, I'd like to merge this PR into the core-protocol-v3.0-dev branch. We can still discuss, revise and revisit anything after merge. I'll merge tomorrow if no objections.

Copy link
Member

@joshmoore joshmoore left a comment

Choose a reason for hiding this comment

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

👍 for getting this merged together with the other PRs. Certainly nothing is so horrifying it can't be on a dev branch. 😉

@alimanfoo alimanfoo merged commit d258786 into zarr-developers:core-protocol-v3.0-dev May 21, 2019
@alimanfoo alimanfoo deleted the core-protocol-v3.0-node-names branch May 21, 2019 11:44
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.

2 participants