Auto decode basemodels into json fields#101
Merged
piercefreeman merged 2 commits intomainfrom Mar 26, 2026
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
While it's usually better to use foreign keys to associate database level data, there are some cases where you want to throw convention out the window and embed basemodels directly as json within your table. The email-confirmation payload in mountaineer-cloud is one of those cases.
This PR adds ergonomic handling for this situations. If you annotate a column with a regular BaseModel and indicate
is_json=True(to make explicit that it will be embedded versus potentially getting confused as a foreign key relation), we will automatically serialize and deserialize it into the proper model during the round trip to the database.