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

Docs: Mention the possibility to use UUIDv6 and UUIDv7 bases on db models #3582

Open
tpougy opened this issue Jun 19, 2024 · 0 comments
Open
Labels
Documentation 📚 This is related to documentation

Comments

@tpougy
Copy link

tpougy commented Jun 19, 2024

Summary

I found that there is a UUIDv7 and UUIDv6 bases (Base and AuditBase) already declared in advanced_alchemy, which is the package used to implement the UUIDBase and UUIDAuditBase. Big thanks to the manteiners of Litestar that also created this awesome advanced_alchemy package.

It would be great to mention the possibility to use UUIDv7 and UUIDv6 bases in Litestar Docs page "SQLAlchemy Models & Repository" because:

  • UUIDv7 (recommended) and UUIDv6 have some important advantages when used on DB indexes, since v6 and v7 are time sortable;
  • the advanced_alchemy package does not have almost any documention on its docs page, so it is really hard to find that UUIDv7 and UUIDv6 are available;
  • to use UUIDv7 and UUIDv6 bases advanced_alchemy rely on the rust based uuid-utils (very optimized), since functions to generate v6 and v7 versions are not included in the python std lib. I think it would be beneficial to Litestar users to know this dependency right in the Litestar docs if it mentions the v7 and v6 bases.

Also it would be better to mention that the standard Litestar UUIDBase and UUIDAuditBase uses UUIDv4 since this specific information is also not available anywhere on the Litestar docs.


Note

While we are open for sponsoring on GitHub Sponsors and
OpenCollective, we also utilize Polar.sh to engage in pledge-based sponsorship.

Check out all issues funded or available for funding on our Polar.sh dashboard

  • If you would like to see an issue prioritized, make a pledge towards it!
  • We receive the pledge once the issue is completed & verified
  • This, along with engagement in the community, helps us know which features are a priority to our users.
Fund with Polar
@tpougy tpougy added the Documentation 📚 This is related to documentation label Jun 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation 📚 This is related to documentation
Projects
None yet
Development

No branches or pull requests

1 participant