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

schema/edge: add annotation support for edges (#651)

Browse Source
This commit is contained in:
Ariel Mashraki
2020-08-01 15:38:47 +03:00
committed by GitHub
parent e9b406ca65
commit 05dfd6b78b
11 changed files with 136 additions and 71 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
schema/edge/edge.go
View File

@@ -8,17 +8,26 @@ import (
"reflect"
)
// Annotation is used to attach arbitrary metadata to the edge object in codegen.
// The object must be serializable to JSON raw value (e.g. struct, map or slice).
// Template extensions can retrieve this metadata and use it inside their templates.
type Annotation interface {
// Name defines the name of the annotation to be retrieved by the codegen.
Name() string
}
// A Descriptor for edge configuration.
type Descriptor struct {
Tag string // struct tag.
Type string // edge type.
Name string // edge name.
RefName string // ref name; inverse only.
Ref *Descriptor // edge reference; to/from of the same type.
Unique bool // unique edge.
Inverse bool // inverse edge.
Required bool // required on creation.
StorageKey *StorageKey // optional storage-key configuration.
Tag string // struct tag.
Type string // edge type.
Name string // edge name.
RefName string // ref name; inverse only.
Ref *Descriptor // edge reference; to/from of the same type.
Unique bool // unique edge.
Inverse bool // inverse edge.
Required bool // required on creation.
StorageKey *StorageKey // optional storage-key configuration.
Annotations []Annotation // edge annotations.
}
// To defines an association edge between two vertices.
@@ -75,7 +84,7 @@ func (b *assocBuilder) Comment(string) *assocBuilder {
// StorageKey sets the storage key of the edge.
//
// edge.To("groups").
// edge.To("groups", Group.Type).
// StorageKey(edge.Table("user_groups"), edge.Columns("user_id", "group_id"))
//
func (b *assocBuilder) StorageKey(opts ...StorageOption) *assocBuilder {
@@ -88,6 +97,19 @@ func (b *assocBuilder) StorageKey(opts ...StorageOption) *assocBuilder {
return b
}
// Annotations adds a list of annotations to the edge object to be used by
// codegen extensions.
//
// edge.To("pets", Pet.Type).
// Annotations(entgql.Config{
// FieldName: "Pets",
// })
//
func (b *assocBuilder) Annotations(annotations ...Annotation) *assocBuilder {
b.desc.Annotations = append(b.desc.Annotations, annotations...)
return b
}
// Descriptor implements the ent.Descriptor interface.
func (b *assocBuilder) Descriptor() *Descriptor {
return b.desc
@@ -129,6 +151,21 @@ func (b *inverseBuilder) Comment(string) *inverseBuilder {
return b
}
// Annotations adds a list of annotations to the edge object to be used by
// codegen extensions.
//
// edge.From("owner", User.Type).
// Ref("pets").
// Unique().
// Annotations(entgql.Config{
// FieldName: "Owner",
// })
//
func (b *inverseBuilder) Annotations(annotations ...Annotation) *inverseBuilder {
b.desc.Annotations = append(b.desc.Annotations, annotations...)
return b
}
// Descriptor implements the ent.Descriptor interface.
func (b *inverseBuilder) Descriptor() *Descriptor {
return b.desc

4
schema/field/field.go
View File

@@ -844,9 +844,9 @@ func (b *uuidBuilder) Descriptor() *Descriptor {
// Annotation is used to attach arbitrary metadata to the field object in codegen.
// The object must be serializable to JSON raw value (e.g. struct, map or slice).
// Template extensions can retrieve this metadata and use inside their templates.
// Template extensions can retrieve this metadata and use it inside their templates.
type Annotation interface {
// Name defines the name of the annotation.
// Name defines the name of the annotation to be retrieved by the codegen.
Name() string
}