schema

Documentation

Index

• type Annotation
• type CommentAnnotation
  • func Comment(text string) *CommentAnnotation
  • func (*CommentAnnotation) Name() string
• type Merger

Types

type Annotation

type Annotation interface {
	// Name defines the name of the annotation to be retrieved by the codegen.
	Name() string
}

Annotation is used to attach arbitrary metadata to the schema objects 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. Read more about it in ent website: https://entgo.io/docs/templates/#annotations.

type CommentAnnotation

type CommentAnnotation struct {
	Text string // Comment text.
}

CommentAnnotation is a builtin schema annotation for configuring the schema's Godoc comment.

func Comment

func Comment(text string) *CommentAnnotation

Comment is a builtin schema annotation for configuring the schema's Godoc comment.

func (*CommentAnnotation) Name

func (*CommentAnnotation) Name() string

Name implements the Annotation interface.

type Merger

type Merger interface {
	Merge(Annotation) Annotation
}

Merger wraps the single Merge function allows custom annotation to provide an implementation for merging 2 or more annotations from the same type.

A common use case is where the same Annotation type is defined both in mixin.Schema and ent.Schema.