Skip to content

docs: fix what merge() does in the entity versioning guide #2628

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Su (sushmangupta) merged 3 commits into from
Oct 23, 2026
Merged

docs: fix what merge() does in the entity versioning guide #2628

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3a89134
docs: fix what merge() does in the entity versioning guide
d-kirkland Oct 16, 2026
0c445db
docs: say that merge() also deletes the merged version itself
d-kirkland Oct 16, 2026
983cd79
Merge branch 'main' into fix/docs-versioning-entities-merge-behavior
sushmangupta Oct 23, 2026
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
6 changes: 3 additions & 3 deletions guides/plugins/plugins/framework/data-handling/versioning-entities.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ protected function defineFields(): FieldCollection
## Create and merge version

In this section we will create a new version of our entity which will create a new entry in the database with our updated values.
When we merge a particular version, all versions before the merged version are deleted.
When we merge a particular version, its changes are written into the version of the context we pass in, and the merged version is deleted together with its records.
In the example below, we are using a service where we injected a `swag_example.repository`.

```php
Expand Down Expand Up @@ -109,8 +109,8 @@ Subsequently, we searched the repository with the original context and our new v
In the first search result, using the original context, we get the first version of our entity, which we created at the beginning.
With the second search result we get the updated entity, using our new versioned context.

Lastly, we used the repository method `merge` with our versionId, which deletes all versions before this one.
The merged version is now our new live version. From now on we can find it without using a versioned context.
Lastly, we used the repository method `merge` with our versionId, which writes the changes of this version into the version of the context we pass in (here the original context, whose version is the live one), and then deletes the merged version together with its records.
From now on we can find the updated data without using a versioned context.

## Versioning with foreign keys

Expand Down
Loading