docs: native enum rs_type = "Enum" breaking change in 2.0#180
Open
lethib wants to merge 1 commit into
Open
Conversation
rs_type = "Enum" breaking change in 2.0
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
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.
PR Info
New Features
Bug Fixes
Breaking Changes
rs_type = "Enum"instead ofrs_type = "String". TheActiveEnum::Valueassociated type is nowsea_query::Enum(carrying the enum type name as metadata) rather thanString, which changes the signatures ofto_value(now returnssea_query::Enum) andtry_from_value(now expects&sea_query::Enum). String-backed (rs_type = "String") and integer-backed (rs_type = "i32") enums are unaffected. This is a docs-only PR describing that change.Changes
04-generate-entity/04-enumeration.md(the ActiveEnum page): update the Native Database Enum examples tors_type = "Enum", and add aSince 2.0.0note explaining the newsea_query::Enumvalue type, its struct shape, and how to convert to/fromString.09-schema-statement/02-create-enum.md: update the Native Database Enum example tors_type = "Enum"and cross-link to the ActiveEnum page.