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

ent: document ent.Value returned by mutations (#3556)

Browse Source 
Fixed https://github.com/ent/ent/issues/3471
This commit is contained in:
Ariel Mashraki
2023-05-23 14:54:18 +03:00
committed by GitHub
parent 0aaaad6ccc
commit d7b3a6c4f4
1 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
ent.go
View File

@@ -239,7 +239,7 @@ func (Schema) Policy() Policy { return nil }
func (Schema) Annotations() []schema.Annotation { return nil }
type (
// Value represents a value returned by ent.
// Value represents a dynamic value returned by mutations or queries.
Value any
// Mutation represents an operation that mutate the graph.
@@ -328,7 +328,14 @@ type (
// Mutator is the interface that wraps the Mutate method.
Mutator interface {
// Mutate apply the given mutation on the graph.
// Mutate apply the given mutation on the graph. The returned
// ent.Value is changing according to the mutation operation:
//
// OpCreate, the returned value is the created node (T).
// OpUpdateOne, the returned value is the updated node (T).
// OpUpdate, the returned value is the amount of updated nodes (int).
// OpDeleteOne, OpDelete, the returned value is the amount of deleted nodes (int).
//
Mutate(context.Context, Mutation) (Value, error)
}