datajoint / datajoint-docs-original

https://docs.datajoint.org
Other
2 stars 13 forks source link

document UUID #247

Open ixcat opened 3 years ago

Synicix commented 3 years ago

Copy issue filed from datajoint-python:

Feature Request

Problem

UUID seems to be a recent feature that was implmented but it not found under the datatype docs: https://docs.datajoint.io/python/definition/06-Datatypes.html

Requirements

This should be documented so users know that this option even exist

Justification

No docs, not many will know about, no one will use it.

Alternative Considerations

Add to the docs and keep it up to date with new features.

Related Errors

None

CBroz1 commented 2 years ago

The Code Clinic from 09/01/21 describes these features in a way that would be easily translate to documentation. See video on shared drive. With permission, I would crop and extract first ~8m to share on youtube as user resource pending full documentation.

uuid.uuid1() # incrimental, ordered, refs generator machine uuid.uuid3() # 3&5 use hashing and provided text strings, 3 - MD5 ; 5 - SHA-1 uuid.uuid4() # pseudo-random number generators to generate IDs