Add FluentEnumSchemaRepresentable protocol for consistent enum field keys#791
Open
Bilalyyy wants to merge 1 commit intovapor:mainfrom
Open
Add FluentEnumSchemaRepresentable protocol for consistent enum field keys#791Bilalyyy wants to merge 1 commit intovapor:mainfrom
Bilalyyy wants to merge 1 commit intovapor:mainfrom
Conversation
Introduces a protocol for enums to define a consistent Fluent field key and database enum name. This allows for a standardized way to represent enums in the database schema when using Fluent. It simplifies the process of defining enum fields and ensures consistency across different enum types.
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.
Summary
This PR introduces a new protocol:
FluentEnumSchemaRepresentable.It is designed to help developers using Fluent with enum-based fields in their models.
The protocol provides:
fluentEnumNameto serve as the single source of truth for the database enum type name.fieldKey, derived from that name, for use in@Enum(key:)declarations.Motivation
Currently, enum field keys and database enum type names are often hardcoded in both model declarations and migrations, which can lead to:
By using
FluentEnumSchemaRepresentable, developers can define everything in one place and rely on type-safe usage in both models and schema builders.Example usage
That said, this protocol opens the door to an easier and faster way to create and delete enums in schema migrations.
I’d be happy to propose a follow-up PR (in FluentKit) to explore that direction.