✨ Add official UUID support, docs and tests, internally using new SQLAlchemy 2.0 types #992
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
📝 Docs preview for commit d4d482d at: https://cbae96de.sqlmodel.pages.dev |
|
📝 Docs preview for commit 184baf3 at: https://d4d7be97.sqlmodel.pages.dev |
Keep consistency with other examples, functions without parameters, and printing info that shows and explains the UUID results (and can also be tested later)
* Explain the concepts at the beggining before using them. * Explain how UUIDs can be used and trusted. * Explain why UUIDs could be generated on the code, and how they can be used for distributed systems. * Explain how UUIDs can prevent information leakage. * Warn about UUIDs storage size. * Explain that uuid is part of the standard library. * Explain how default_factory works. * Explain that creating an instance would generate a new UUID, before it is sent to the DB. This is included and shown in the example, the UUID is printed before saving to the DB. * Remove sections about other operations that would behave the same as other fields and don't need additional info from what was explained in previous chapters. * Add two examples to select using UUIDs, similar to the previous ones, mainly to be able to use them in the tests and ensure that it all works, even when SQLite stores the values as strings but the where() or the session.get() receive UUID values (ensure SQLAlchemy does the conversion correctly for SQLite). * Add an example terminal run of the code, with comments. * Simplify the ending to keep only the information that wasn't there before, just the "Learn More" with links.
…are used in the right places.
tiangolo
changed the title
|
📝 Docs preview for commit 6da6465 at: https://65189b1d.sqlmodel.pages.dev |
…0+ (I missed that change before)
|
📝 Docs preview for commit ad70ba0 at: https://a5413504.sqlmodel.pages.dev |
|
Thank you! 🚀 I updated the docs, examples, and tests a bit for consistency, to explain things a bit more, and to test that UUIDs are behaving as expected. 🤓 Now this is ready. 🎉 This will be available in SQLModel 0.0.20 in the next hours. 🚀 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.