feat(core): add em.upsert() method
#3525
Merged
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
We can use `em.upsert()` create or update the entity, based on whether it is already present in the database.
This method performs an `insert on conflict merge` query ensuring the database is in sync, returning a managed
entity instance. The method accepts either `entityName` together with the entity `data`, or just entity instance.
```ts
// insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
const author = await em.upsert(Author, { email: 'foo@bar.com', age: 33 });
```
The entity data needs to contain either the primary key, or any other unique property. Let's consider the following
example, where `Author.email` is a unique property:
```ts
// insert into "author" ("age", "email") values (33, 'foo@bar.com') on conflict ("email") do update set "age" = 41
// select "id" from "author" where "email" = 'foo@bar.com'
const author = await em.upsert(Author, { email: 'foo@bar.com', age: 33 });
```
Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the
primary key if it's missing from the `data`.
If the entity is already present in current context, there won't be any queries - instead, the entity data will be
assigned and an explicit `flush` will be required for those changes to be persisted.
Codecov ReportBase: 99.85% // Head: 99.81% // Decreases project coverage by
Additional details and impacted files@@ Coverage Diff @@
## master #3525 +/- ##
==========================================
- Coverage 99.85% 99.81% -0.04%
==========================================
Files 210 211 +1
Lines 12938 13013 +75
Branches 2998 3022 +24
==========================================
+ Hits 12919 12989 +70
- Misses 19 24 +5
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
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.
We can use
em.upsert()create or update the entity, based on whether it is already present in the database. This method performs aninsert on conflict mergequery ensuring the database is in sync, returning a managed entity instance. The method accepts eitherentityNametogether with the entitydata, or just entity instance.The entity data needs to contain either the primary key, or any other unique property. Let's consider the following example, where
Author.emailis a unique property:Depending on the driver support, this will either use a returning query, or a separate select query, to fetch the primary key if it's missing from the
data.If the entity is already present in current context, there won't be any queries - instead, the entity data will be assigned and an explicit
flushwill be required for those changes to be persisted.Closes #3515