Documentation
¶
Index ¶
- func Any(name string) *jsonBuilder
- func Bool(name string) *boolBuilder
- func Bytes(name string) *bytesBuilder
- func Enum(name string) *enumBuilder
- func Float(name string) *float64Builder
- func Float32(name string) *float32Builder
- func Floats(name string) *sliceBuilder[float64]
- func Int(name string) *intBuilder
- func Int16(name string) *int16Builder
- func Int32(name string) *int32Builder
- func Int64(name string) *int64Builder
- func Int8(name string) *int8Builder
- func Ints(name string) *sliceBuilder[int]
- func JSON(name string, typ any) *jsonBuilder
- func Other(name string, typ driver.Valuer) *otherBuilder
- func String(name string) *stringBuilder
- func Strings(name string) *sliceBuilder[string]
- func Text(name string) *stringBuilder
- func Time(name string) *timeBuilder
- func UUID(name string, typ driver.Valuer) *uuidBuilder
- func Uint(name string) *uintBuilder
- func Uint16(name string) *uint16Builder
- func Uint32(name string) *uint32Builder
- func Uint64(name string) *uint64Builder
- func Uint8(name string) *uint8Builder
- type Annotation
- type BinaryValueScanner
- type Descriptor
- type EnumValues
- type RType
- type TextValueScanner
- type Type
- type TypeInfo
- func (t TypeInfo) Comparable() bool
- func (t TypeInfo) ConstName() string
- func (t TypeInfo) Numeric() bool
- func (t TypeInfo) String() string
- func (t TypeInfo) Stringer() bool
- func (t TypeInfo) Valid() bool
- func (t TypeInfo) Validator() bool
- func (t TypeInfo) ValueScanner() bool
- func (t TypeInfo) Valuer() bool
- type TypeValueScanner
- type Validator
- type ValueScanner
- type ValueScannerFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Any ¶ added in v0.11.10
func Any(name string) *jsonBuilder
Any returns a new JSON Field with type any. Although this field type can be useful for fields with dynamic data layout, it is strongly recommended to use JSON with json.RawMessage instead and implement custom marshaling.
func Bytes ¶
func Bytes(name string) *bytesBuilder
Bytes returns a new Field with type bytes/buffer. In MySQL and SQLite, it is the "BLOB" type, and it does not support for Gremlin.
func Enum ¶
func Enum(name string) *enumBuilder
Enum returns a new Field with type enum. An example for defining enum is as follows:
field.Enum("state").
Values(
"on",
"off",
).
Default("on")
func Float32 ¶
func Float32(name string) *float32Builder
Float32 returns a new Field with type float32.
func JSON ¶
JSON returns a new Field with type json that is serialized to the given object. For example:
field.JSON("dirs", []http.Dir{}).
Optional()
field.JSON("info", &Info{}).
Optional()
func Other ¶
Other represents a field that is not a good fit for any of the standard field types.
The second argument defines the GoType and must implement the ValueScanner interface. The SchemaType option must be set because the field type cannot be inferred. An example for defining Other field is as follows:
field.Other("link", &Link{}).
SchemaType(map[string]string{
dialect.MySQL: "text",
dialect.Postgres: "varchar",
})
func Text ¶
func Text(name string) *stringBuilder
Text returns a new string field without limitation on the size. In MySQL, it is the "longtext" type, but in SQLite and Gremlin it has no effect.
Types ¶
type Annotation ¶
type Annotation struct {
// The StructTag option allows overriding the struct-tag
// of the fields in the generated entity. For example:
//
// field.Annotation{
// StructTag: map[string]string{
// "id": `json:"id,omitempty" yaml:"-"`,
// },
// }
//
StructTag map[string]string
// ID defines a multi-field schema identifier. Note,
// the annotation is valid only for edge schemas.
//
// func (TweetLike) Annotations() []schema.Annotation {
// return []schema.Annotation{
// field.ID("user_id", "tweet_id"),
// }
// }
//
ID []string
}
Annotation is a builtin schema annotation for configuring the schema fields in codegen.
func ID ¶ added in v0.11.0
func ID(first, second string, fields ...string) *Annotation
ID defines a multi-field schema identifier. Note, the annotation is valid only for edge schemas.
func (TweetLike) Annotations() []schema.Annotation {
return []schema.Annotation{
field.ID("user_id", "tweet_id"),
}
}
func (Annotation) Merge ¶
func (a Annotation) Merge(other schema.Annotation) schema.Annotation
Merge implements the schema.Merger interface.
type BinaryValueScanner ¶ added in v0.12.0
type BinaryValueScanner[T interface {
encoding.BinaryMarshaler
encoding.BinaryUnmarshaler
}] struct{}
BinaryValueScanner returns a new TypeValueScanner that calls MarshalBinary for storing values in the database, and calls UnmarshalBinary for scanning database values into struct fields.
func (BinaryValueScanner[T]) FromValue ¶ added in v0.12.0
func (BinaryValueScanner[T]) FromValue(v driver.Value) (tv T, err error)
FromValue implements the TypeValueScanner.FromValue method.
func (BinaryValueScanner[T]) ScanValue ¶ added in v0.12.0
func (BinaryValueScanner[T]) ScanValue() ValueScanner
ScanValue implements the TypeValueScanner.ScanValue method.
type Descriptor ¶
type Descriptor struct {
Tag string // struct tag.
Size int // varchar size.
Name string // field name.
Info *TypeInfo // field type info.
ValueScanner any // custom field codec.
Unique bool // unique index of field.
Nillable bool // nillable struct field.
Optional bool // nullable field in database.
Immutable bool // create only field.
Default any // default value on create.
UpdateDefault any // default value on update.
Validators []any // validator functions.
StorageKey string // sql column or gremlin property.
Enums []struct{ N, V string } // enum values.
Sensitive bool // sensitive info string field.
SchemaType map[string]string // override the schema type.
Annotations []schema.Annotation // field annotations.
Comment string // field comment.
Err error
}
A Descriptor for field configuration.
type EnumValues ¶
type EnumValues interface {
Values() []string
}
EnumValues defines the interface for getting the enum values.
type RType ¶
type RType struct {
Name string // reflect.Type.Name
Ident string // reflect.Type.String
Kind reflect.Kind
PkgPath string
Methods map[string]struct{ In, Out []*RType }
// contains filtered or unexported fields
}
RType holds a serializable reflect.Type information of Go object. Used by the entc package.
func (*RType) Implements ¶ added in v0.11.0
Implements reports whether the RType ~implements the given interface type.
type TextValueScanner ¶ added in v0.12.0
type TextValueScanner[T interface {
encoding.TextMarshaler
encoding.TextUnmarshaler
}] struct{}
TextValueScanner returns a new TypeValueScanner that calls MarshalText for storing values in the database, and calls UnmarshalText for scanning database values into struct fields.
func (TextValueScanner[T]) FromValue ¶ added in v0.12.0
func (TextValueScanner[T]) FromValue(v driver.Value) (tv T, err error)
FromValue implements the TypeValueScanner.FromValue method.
func (TextValueScanner[T]) ScanValue ¶ added in v0.12.0
func (TextValueScanner[T]) ScanValue() ValueScanner
ScanValue implements the TypeValueScanner.ScanValue method.
type Type ¶
type Type uint8
A Type represents a field type.
const ( TypeInvalid Type = iota TypeBool TypeTime TypeJSON TypeUUID TypeBytes TypeEnum TypeString TypeOther TypeInt8 TypeInt16 TypeInt32 TypeInt TypeInt64 TypeUint8 TypeUint16 TypeUint32 TypeUint TypeUint64 TypeFloat32 TypeFloat64 )
List of field types.
func (Type) ConstName ¶
ConstName returns the constant name of an info type. It's used by entc for printing the constant name in templates.
type TypeInfo ¶
type TypeInfo struct {
Type Type
Ident string
PkgPath string // import path.
PkgName string // local package name.
Nillable bool // slices or pointers.
RType *RType
}
TypeInfo holds the information regarding field type. Used by complex types like JSON and Bytes.
func (TypeInfo) Comparable ¶
Comparable reports whether values of this type are comparable.
func (TypeInfo) Validator ¶ added in v0.11.9
Validator indicates if this type implements the Validator interface.
func (TypeInfo) ValueScanner ¶
ValueScanner indicates if this type implements the ValueScanner interface.
type TypeValueScanner ¶ added in v0.12.0
type TypeValueScanner[T any] interface { // Value returns the driver.Valuer for the GoType. Value(T) (driver.Value, error) // ScanValue returns a new ValueScanner that functions as an // intermediate result between database value and GoType value. // For example, sql.NullString or sql.NullInt. ScanValue() ValueScanner // FromValue returns the field instance from the ScanValue // above after the database value was scanned. FromValue(driver.Value) (T, error) }
TypeValueScanner is the interface that groups all methods for attaching an external ValueScanner to a custom GoType.
type Validator ¶ added in v0.11.9
type Validator interface {
Validate() error
}
Validator interface wraps the Validate method. Custom GoTypes with this method will be validated when the entity is created or updated.
type ValueScanner ¶
ValueScanner is the interface that groups the Value and the Scan methods implemented by custom Go types.
type ValueScannerFunc ¶ added in v0.12.0
type ValueScannerFunc[T any, S ValueScanner] struct { V func(T) (driver.Value, error) S func(S) (T, error) }
ValueScannerFunc is a wrapper for a function that implements the ValueScanner.
func (ValueScannerFunc[T, S]) FromValue ¶ added in v0.12.0
func (f ValueScannerFunc[T, S]) FromValue(v driver.Value) (tv T, err error)
FromValue implements the TypeValueScanner.FromValue method.
func (ValueScannerFunc[T, S]) ScanValue ¶ added in v0.12.0
func (f ValueScannerFunc[T, S]) ScanValue() ValueScanner
ScanValue implements the TypeValueScanner.ScanValue method.
Source Files
Directories