golang/ent
1
0
Fork 0
mirror of https://github.com/ent/ent.git synced 2026-04-28 05:30:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

doc: add warning for Unwrap (#4217)

Browse Source 
* entc: document Unwrap with panic, doc: add warning for Unwrap

* resolve feedback
This commit is contained in:
Chandler Davis
2024-09-19 17:43:13 -04:00
committed by GitHub
parent 009b396d7e
commit 0c74e8ee0d
1 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
doc/md/transactions.md
View File

@@ -60,6 +60,11 @@ func rollback(tx *ent.Tx, err error) error {
You must call `Unwrap()` if you are querying edges off of a created entity after a successful transaction (example: `a8m.QueryGroups()`). Unwrap restores the state of the underlying client embedded within the entity to a non-transactable version.
:::warning Note
Calling `Unwrap()` on a non-transactional entity (i.e., after a transaction has been committed or rolled back) will
cause a panic.
:::
The full example exists in [GitHub](https://github.com/ent/ent/tree/master/examples/traversal).
## Transactional Client