Files
ent/entc/gen/template/dialect/sql/create.tmpl
2026-05-21 14:10:53 +00:00

467 lines
15 KiB
Cheetah

{{/*
Copyright 2019-present Facebook Inc. All rights reserved.
This source code is licensed under the Apache 2.0 license found
in the LICENSE file in the root directory of this source tree.
*/}}
{{/* gotype: entgo.io/ent/entc/gen.Type */}}
{{ define "dialect/sql/create" }}
{{ $builder := pascal $.Scope.Builder }}
{{ $receiver := $.Scope.Receiver }}
{{ $mutation := print $receiver ".mutation" }}
{{ $pkg := base $.Config.Package }}
func ({{ $receiver }} *{{ $builder }}) sqlSave(ctx context.Context) (*{{ $.Name }}, error) {
if err := {{ $receiver }}.check(); err != nil {
return nil, err
}
_node, _spec {{ if $.HasValueScanner }}, err {{ end }} := {{ $receiver }}.createSpec()
{{- if $.HasValueScanner }}
if err != nil {
return nil, err
}
{{- end }}
{{- if $.HasBlobFields }}
_blobs := ent.NewBlobs({{ $mutation }}.blobOpeners.{{ $.Name }})
{{- range $f := $.BlobFields }}
{{- if not $f.IsBlobLazy }}
if value, ok := {{ $mutation }}.{{ $f.MutationGet }}(); ok {
{{- if $f.HasValueScanner }}
_blobDV, err := {{ $f.ValueFunc }}(value)
if err != nil {
return nil, fmt.Errorf("{{ $pkg }}: encoding {{ $f.Name }}: %w", err)
}
var _blobData []byte
switch v := _blobDV.(type) {
case []byte:
_blobData = v
case string:
_blobData = []byte(v)
default:
return nil, fmt.Errorf("{{ $pkg }}: encoding {{ $f.Name }}: expected []byte or string, got %T", _blobDV)
}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, _blobData,
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
_node.{{ $f.BlobKeyColumn }} = &k
_spec.SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
{{- else if $f.IsBlobGoString }}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, []byte(value),
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
_node.{{ $f.BlobKeyColumn }} = &k
_spec.SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
{{- else }}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, value,
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
_node.{{ $f.BlobKeyColumn }} = &k
_spec.SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
{{- end }}
_node.{{ $f.StructField }} = value
}
{{- else }}
if r, ok := {{ $mutation }}.{{ $f.StructField }}(); ok {
_blobData, err := io.ReadAll(r)
if err != nil {
return nil, fmt.Errorf("{{ $pkg }}: reading {{ $f.Name }}: %w", err)
}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, _blobData,
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
_node.{{ $f.BlobKeyColumn }} = &k
_spec.SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
}
{{- end }}
{{- end }}
_blobCleanup, err := _blobs.Create(ctx)
if err != nil {
return nil, err
}
{{- end }}
if err := sqlgraph.CreateNode(ctx, {{ $receiver }}.driver, _spec); err != nil {
if sqlgraph.IsConstraintError(err) {
err = &ConstraintError{msg: err.Error(), wrap: err}
}
{{- if $.HasBlobFields }}
return nil, errors.Join(err, _blobCleanup(ctx))
{{- else }}
return nil, err
{{- end }}
}
{{- if $.HasBlobFields }}
if txd, ok := {{ $receiver }}.driver.(*txDriver); ok {
txd.mu.Lock()
txd.onRollback = append(txd.onRollback, func(next Rollbacker) Rollbacker {
return RollbackFunc(func(ctx context.Context, tx *Tx) error {
err := next.Rollback(ctx, tx)
return errors.Join(err, _blobCleanup(ctx))
})
})
txd.mu.Unlock()
}
{{- end }}
{{- if $.HasCompositeID }}
{{- else if or $.ID.HasValueScanner $.ID.Type.ValueScanner (not $.ID.Type.Numeric) }}
if _spec.ID.Value != nil {
{{- if $.ID.HasValueScanner }}
sv, ok := _spec.ID.Value.(field.ValueScanner)
if !ok {
sv = {{ $.ID.ScanValueFunc }}()
if err := sv.Scan(_spec.ID.Value); err != nil {
return nil, err
}
}
if value, err := {{ $.ID.FromValueFunc }}(sv); err != nil {
return nil, err
} else {
_node.ID = value
}
{{- else }}
{{- /* If the ID type is not a pointer, but implements the ValueScanner interface (e.g. UUID fields). */}}
{{- if and $.ID.Type.ValueScanner (not $.ID.Type.RType.IsPtr) }}
if id, ok := _spec.ID.Value.(*{{ $.ID.Type }}); ok {
_node.ID = *id
{{- else }}
if id, ok := _spec.ID.Value.({{ $.ID.Type }}); ok {
_node.ID = id
{{- end }}
{{- if $.ID.Type.ValueScanner }}
} else if err := _node.ID.Scan(_spec.ID.Value); err != nil {
return nil, err
{{- else }}
} else {
return nil, fmt.Errorf("unexpected {{ $.Name }}.ID type: %T", _spec.ID.Value)
{{- end }}
}
{{- end }}
}
{{- else }}
{{- if $.ID.UserDefined }}
if _spec.ID.Value != _node.ID {
{{- end }}
id := _spec.ID.Value.(int64)
_node.ID = {{ $.ID.Type }}(id)
{{- if $.ID.UserDefined }}
}
{{- end }}
{{- end }}
{{- if $.HasOneFieldID }}
{{ $mutation }}.{{ $.ID.BuilderField }} = &_node.{{ $.ID.StructField }}
{{ $mutation }}.done = true
{{- end }}
return _node, nil
}
func ({{ $receiver }} *{{ $builder }}) createSpec() (*{{ $.Name }}, *sqlgraph.CreateSpec{{ if $.HasValueScanner }}, error{{ end }}) {
var (
_node = &{{ $.Name }}{config: {{ $receiver }}.config}
_spec = sqlgraph.NewCreateSpec({{ $.Package }}.Table, {{ if $.HasOneFieldID }}sqlgraph.NewFieldSpec({{ $.Package }}.{{ $.ID.Constant }}, field.{{ $.ID.Type.ConstName }}){{ else }}nil{{ end }})
)
{{- /* Allow mutating the sqlgraph.CreateSpec by ent extensions or user templates.*/}}
{{- with $tmpls := matchTemplate "dialect/sql/create/spec/*" }}
{{- range $tmpl := $tmpls }}
{{- xtemplate $tmpl $ }}
{{- end }}
{{- end }}
{{- if and (not $.HasCompositeID) $.ID.UserDefined }}
if id, ok := {{ $mutation }}.{{ $.ID.MutationGet }}(); ok {
_node.ID = id
{{- if $.ID.HasValueScanner }}
vv, err := {{ $.ID.ValueFunc }}(id)
if err != nil {
return nil, nil, err
}
_spec.ID.Value = vv
{{- else }}
_spec.ID.Value = {{ if and $.ID.Type.ValueScanner (not $.ID.Type.RType.IsPtr) }}&{{ end }}id
{{- end }}
}
{{- end }}
{{- range $f := $.MutationFields }}
{{- if $f.IsBlobNoColumn }}{{ continue }}{{ end }}
if value, ok := {{ $mutation }}.{{ $f.MutationGet }}(); ok {
{{- if $f.HasValueScanner }}
vv, err := {{ $f.ValueFunc }}(value)
if err != nil {
return nil, nil, err
}
_spec.SetField({{ $.Package }}.{{ $f.Constant }}, field.{{ $f.Type.ConstName }}, vv)
{{- else }}
_spec.SetField({{ $.Package }}.{{ $f.Constant }}, field.{{ $f.Type.ConstName }}, value)
{{- end }}
_node.{{ $f.StructField }} = {{ if $f.NillableValue }}&{{ end }}value
}
{{- end }}
{{- range $e := $.EdgesWithID }}
if nodes := {{ $mutation }}.{{ $e.StructField }}IDs(); len(nodes) > 0 {
{{- with extend $ "Edge" $e "Nodes" true "Zero" "nil" }}
{{ template "dialect/sql/defedge" . }}{{/* defined in sql/update.tmpl */}}
{{- end }}
{{- if $e.OwnFK }}
{{- $fk := $e.ForeignKey }}
_node.{{ $fk.StructField }} = {{ if $fk.Field.NillableValue }}&{{ end }}nodes[0]
{{- end }}
_spec.Edges = append(_spec.Edges, edge)
}
{{- end }}
return _node, _spec{{ if $.HasValueScanner }}, nil{{ end }}
}
{{- /* Allow adding methods to the create-builder by ent extensions or user templates.*/}}
{{- with $tmpls := matchTemplate "dialect/sql/create/additional/*" }}
{{- range $tmpl := $tmpls }}
{{- xtemplate $tmpl $ }}
{{- end }}
{{- end }}
{{ end }}
{{/* Additional fields for the create builder. */}}
{{ define "dialect/sql/create/fields" }}
{{- with $tmpls := matchTemplate "dialect/sql/create/fields/additional/*" }}
{{- range $tmpl := $tmpls }}
{{- xtemplate $tmpl $ }}
{{- end }}
{{- end }}
{{- end }}
{{/* Additional fields for the create_bulk builder. */}}
{{ define "dialect/sql/create_bulk/fields" }}
{{- with $tmpls := matchTemplate "dialect/sql/create_bulk/fields/additional/*" }}
{{- range $tmpl := $tmpls }}
{{- xtemplate $tmpl $ }}
{{- end }}
{{- end }}
{{- end }}
{{ define "dialect/sql/create_bulk" }}
{{ $builder := pascal $.Scope.Builder }}
{{ $receiver := $.Scope.Receiver }}
{{ $pkg := base $.Config.Package }}
// Save creates the {{ $.Name }} entities in the database.
func ({{ $receiver }} *{{ $builder }}) Save(ctx context.Context) ([]*{{ $.Name }}, error) {
{{- /* Initialization error was set by MapCreateBulk. */}}
if {{ $receiver }}.err != nil {
return nil, {{ $receiver }}.err
}
specs := make([]*sqlgraph.CreateSpec, len({{ $receiver }}.builders))
nodes := make([]*{{ $.Name }}, len({{ $receiver }}.builders))
mutators := make([]Mutator, len({{ $receiver }}.builders))
{{- if $.HasBlobFields }}
_blobs := ent.NewBlobs({{ $receiver }}.blobOpeners.{{ $.Name }})
{{- end }}
for i := range {{ $receiver }}.builders {
func(i int, root context.Context) {
builder := {{ $receiver }}.builders[i]
{{- if $.HasDefault }}
builder.defaults()
{{- end }}
var mut Mutator = MutateFunc(func(ctx context.Context, m Mutation) (Value, error) {
mutation, ok := m.(*{{ $.MutationName }})
if !ok {
return nil, fmt.Errorf("unexpected mutation type %T", m)
}
if err := builder.check(); err != nil {
return nil, err
}
builder.mutation = mutation
var err error
nodes[i], specs[i] {{ if $.HasValueScanner }}, err {{ end }}= builder.createSpec()
{{- if $.HasValueScanner }}
if err != nil {
return nil, err
}
{{- end }}
{{- if $.HasBlobFields }}
{{- range $f := $.BlobFields }}
{{- if not $f.IsBlobLazy }}
if value, ok := mutation.{{ $f.MutationGet }}(); ok {
{{- if $f.HasValueScanner }}
_blobDV, err := {{ $f.ValueFunc }}(value)
if err != nil {
return nil, fmt.Errorf("{{ $pkg }}: encoding {{ $f.Name }}: %w", err)
}
var _blobData []byte
switch v := _blobDV.(type) {
case []byte:
_blobData = v
case string:
_blobData = []byte(v)
default:
return nil, fmt.Errorf("{{ $pkg }}: encoding {{ $f.Name }}: expected []byte or string, got %T", _blobDV)
}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, _blobData,
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
nodes[i].{{ $f.BlobKeyColumn }} = &k
specs[i].SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
{{- else if $f.IsBlobGoString }}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, []byte(value),
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
nodes[i].{{ $f.BlobKeyColumn }} = &k
specs[i].SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
{{- else }}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, value,
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
nodes[i].{{ $f.BlobKeyColumn }} = &k
specs[i].SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
{{- end }}
nodes[i].{{ $f.StructField }} = value
}
{{- else }}
if r, ok := mutation.{{ $f.StructField }}(); ok {
_blobData, err := io.ReadAll(r)
if err != nil {
return nil, fmt.Errorf("{{ $pkg }}: reading {{ $f.Name }}: %w", err)
}
_blobs.Set({{ $.Package }}.{{ $f.Constant }}, _blobData,
{{ if $f.HasBlobKey }}{{ $.Package }}.{{ $f.BlobKeyName }}{{ else }}defaultBlobKey{{ end }},
func(k string) {
nodes[i].{{ $f.BlobKeyColumn }} = &k
specs[i].SetField("{{ $f.BlobKeyColumn }}", field.TypeString, k)
},
)
}
{{- end }}
{{- end }}
{{- end }}
if i < len(mutators)-1 {
_, err = mutators[i+1].Mutate(root, {{ $receiver }}.builders[i+1].mutation)
} else {
{{- if $.HasBlobFields }}
// Write blobs before creating SQL rows so insert failures can clean up written objects.
_blobCleanup, err := _blobs.Create(ctx)
if err != nil {
return nil, err
}
{{- end }}
spec := &sqlgraph.BatchCreateSpec{Nodes: specs}
{{- /* Allow mutating the sqlgraph.BatchCreateSpec by ent extensions or user templates.*/}}
{{- with $tmpls := matchTemplate "dialect/sql/create_bulk/spec/*" }}
{{- range $tmpl := $tmpls }}
{{- xtemplate $tmpl $ }}
{{- end }}
{{- end }}
// Invoke the actual operation on the latest mutation in the chain.
if err = sqlgraph.BatchCreate(ctx, {{ $receiver }}.driver, spec); err != nil {
if sqlgraph.IsConstraintError(err) {
err = &ConstraintError{msg: err.Error(), wrap: err}
}
{{- if $.HasBlobFields }}
return nil, errors.Join(err, _blobCleanup(ctx))
{{- end }}
}
{{- if $.HasBlobFields }}
if txd, ok := {{ $receiver }}.driver.(*txDriver); ok {
txd.mu.Lock()
txd.onRollback = append(txd.onRollback, func(next Rollbacker) Rollbacker {
return RollbackFunc(func(ctx context.Context, tx *Tx) error {
err := next.Rollback(ctx, tx)
return errors.Join(err, _blobCleanup(ctx))
})
})
txd.mu.Unlock()
}
{{- end }}
}
if err != nil {
return nil, err
}
{{- if $.HasOneFieldID }}
mutation.{{ $.ID.BuilderField }} = &nodes[i].{{ $.ID.StructField }}
{{- if and (or $.ID.IsString $.ID.IsUUID $.ID.IsBytes $.ID.IsOther) (not $.ID.HasValueScanner) }}
{{- /* Do nothing, because these 4 types must be supplied by the user. */ -}}
{{- else if $.ID.HasValueScanner }}
if specs[i].ID.Value != nil {
sv, ok := specs[i].ID.Value.(field.ValueScanner)
if !ok {
sv = {{ $.ID.ScanValueFunc }}()
if err := sv.Scan(specs[i].ID.Value); err != nil {
return nil, err
}
}
if id, err := {{ $.ID.FromValueFunc }}(sv); err != nil {
return nil, err
} else {
nodes[i].ID = id
}
}
{{- else if or $.ID.Type.ValueScanner }}
if specs[i].ID.Value != nil {
if err := nodes[i].ID.Scan(specs[i].ID.Value); err != nil {
return nil, err
}
}
{{- else }}
if specs[i].ID.Value != nil {{ if $.ID.UserDefined }}&& nodes[i].ID == 0{{ end }} {
id := specs[i].ID.Value.(int64)
nodes[i].ID = {{ $.ID.Type }}(id)
}
{{- end }}
{{- end }}
mutation.done = true
return nodes[i], nil
})
for i := len(builder.hooks) - 1; i >= 0; i-- {
mut = builder.hooks[i](mut)
}
mutators[i] = mut
}(i, ctx)
}
if len(mutators) > 0 {
if _, err := mutators[0].Mutate(ctx, {{ $receiver }}.builders[0].mutation); err != nil {
return nil, err
}
}
return nodes, nil
}
// SaveX is like Save, but panics if an error occurs.
func ({{ $receiver }} *{{ $builder }}) SaveX(ctx context.Context) []*{{ $.Name }} {
v, err := {{ $receiver }}.Save(ctx)
if err != nil {
panic(err)
}
return v
}
// Exec executes the query.
func ({{ $receiver }} *{{ $builder }}) Exec(ctx context.Context) error {
_, err := {{ $receiver }}.Save(ctx)
return err
}
// ExecX is like Exec, but panics if an error occurs.
func ({{ $receiver }} *{{ $builder }}) ExecX(ctx context.Context) {
if err := {{ $receiver }}.Exec(ctx); err != nil {
panic(err)
}
}
{{- /* Allow adding methods to the create_bulk builder by ent extensions or user templates.*/}}
{{- with $tmpls := matchTemplate "dialect/sql/create_bulk/additional/*" }}
{{- range $tmpl := $tmpls }}
{{- xtemplate $tmpl $ }}
{{- end }}
{{- end }}
{{ end }}