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.

Sign up for GitHub

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

Jump to bottom

Add keyAndEntityFieldsDatabase function to return key with migration only fields #1519

Merged
merged 2 commits into from
Oct 3, 2023
Merged

Add keyAndEntityFieldsDatabase function to return key with migration only fields #1519

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9865a29
Add keyAndEntityFieldsDatabase function to return key with migration …
josephsumabat Sep 30, 2023
121604e
Update persistent/Database/Persist/Types/Base.hs
parsonsmatt Oct 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 22 additions & 3 deletions persistent/Database/Persist/Types/Base.hs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,28 @@ entityKeyFields =
-- columns for an 'EntityDef'.
keyAndEntityFields :: EntityDef -> NonEmpty FieldDef
keyAndEntityFields ent =
case entityId ent of
keyWithFields (entityId ent) fields
where
fields = filter isHaskellField $ entityFields ent

-- | Returns a 'NonEmpty' list of 'FieldDef' that correspond with the key
-- columns for an 'EntityDef' including those fields that are marked as
-- 'MigrationOnly' (and therefore only present in the database) or
-- 'SafeToRemove' (and a migration will drop the column if it exists in the
-- database).
--
-- For fields on the Haskell type use 'keyAndEntityFieldsDatabase'
--
-- @since 2.14.6.0
keyAndEntityFieldsDatabase :: EntityDef -> NonEmpty FieldDef
keyAndEntityFieldsDatabase ent =
keyWithFields (entityId ent) fields
where
fields = entityFields ent

keyWithFields :: EntityIdDef -> [FieldDef] -> NonEmpty FieldDef
keyWithFields entId fields =
Comment on lines +223 to +224
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This exported too, mind adding a doc comment and @since?

case entId of
EntityIdField fd ->
fd :| fields
EntityIdNaturalKey _ ->
Expand All @@ -214,8 +235,6 @@ keyAndEntityFields ent =
]
Just xs ->
xs
where
fields = filter isHaskellField $ entityFields ent

type ExtraLine = [Text]

Expand Down
Loading