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

entc/gen: add eager-loading support (#263)

Browse Source 
* entc/gen: add OwnFK indicator for type edges

* entc/gen: add Edges field for generated types

* entc/gen: add With<T> method to query-builder template

* entc/gen: scan and assign foreign-keys on eager-loading

* entc/gen: load fk-relations (wip)

* entc/integration: add o2m/m2o tests for eager-loading

* entc/gen: add m2m support for eager-loading

* entc/gen: add integration tests for m2m and subgraphs

* entc/gen/integration: add tests for o2o eager-loading

* all: generate all assets
This commit is contained in:
Ariel Mashraki
2020-01-13 17:21:26 +02:00
committed by GitHub
parent cd366c07e2
commit caf721df47
171 changed files with 6400 additions and 398 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
examples/o2m2types/ent/pet.go
View File

@@ -21,20 +21,34 @@ type Pet struct {
ID int `json:"id,omitempty"`
// Name holds the value of the "name" field.
Name string `json:"name,omitempty"`
// Edges holds the relations/edges for other nodes in the graph.
// The values are being populated by the PetQuery when eager-loading is set.
Edges struct {
// Owner holds the value of the owner edge.
Owner *User
}
owner_id *int
}
// scanValues returns the types for scanning values from sql.Rows.
func (*Pet) scanValues() []interface{} {
return []interface{}{
&sql.NullInt64{},
&sql.NullString{},
&sql.NullInt64{}, // id
&sql.NullString{}, // name
}
}
// fkValues returns the types for scanning foreign-keys values from sql.Rows.
func (*Pet) fkValues() []interface{} {
return []interface{}{
&sql.NullInt64{}, // owner_id
}
}
// assignValues assigns the values that were returned from sql.Rows (after scanning)
// to the Pet fields.
func (pe *Pet) assignValues(values ...interface{}) error {
if m, n := len(values), len(pet.Columns); m != n {
if m, n := len(values), len(pet.Columns); m < n {
return fmt.Errorf("mismatch number of scan values: %d != %d", m, n)
}
value, ok := values[0].(*sql.NullInt64)
@@ -48,6 +62,15 @@ func (pe *Pet) assignValues(values ...interface{}) error {
} else if value.Valid {
pe.Name = value.String
}
values = values[1:]
if len(values) == len(pet.ForeignKeys) {
if value, ok := values[0].(*sql.NullInt64); !ok {
return fmt.Errorf("unexpected type %T for edge-field owner_id", value)
} else if value.Valid {
pe.owner_id = new(int)
*pe.owner_id = int(value.Int64)
}
}
return nil
}

7
examples/o2m2types/ent/pet/pet.go
View File

@@ -25,8 +25,13 @@ const (
OwnerColumn = "owner_id"
)
// Columns holds all SQL columns are pet fields.
// Columns holds all SQL columns for pet fields.
var Columns = []string{
FieldID,
FieldName,
}
// ForeignKeys holds the SQL foreign-keys that are owned by the Pet type.
var ForeignKeys = []string{
"owner_id",
}

57
examples/o2m2types/ent/pet_query.go
View File

@@ -28,6 +28,9 @@ type PetQuery struct {
order []Order
unique []string
predicates []predicate.Pet
// eager-loading edges.
withOwner *UserQuery
withFKs bool
// intermediate query.
sql *sql.Selector
}
@@ -237,6 +240,17 @@ func (pq *PetQuery) Clone() *PetQuery {
}
}
// WithOwner tells the query-builder to eager-loads the nodes that are connected to
// the "owner" edge. The optional arguments used to configure the query builder of the edge.
func (pq *PetQuery) WithOwner(opts ...func(*UserQuery)) *PetQuery {
query := &UserQuery{config: pq.config}
for _, opt := range opts {
opt(query)
}
pq.withOwner = query
return pq
}
// GroupBy used to group vertices by one or more fields/columns.
// It is often used with aggregate functions, like: count, max, mean, min, sum.
//
@@ -280,13 +294,24 @@ func (pq *PetQuery) Select(field string, fields ...string) *PetSelect {
func (pq *PetQuery) sqlAll(ctx context.Context) ([]*Pet, error) {
var (
nodes []*Pet
spec = pq.querySpec()
nodes []*Pet
withFKs = pq.withFKs
spec = pq.querySpec()
)
if pq.withOwner != nil {
withFKs = true
}
if withFKs {
spec.Node.Columns = append(spec.Node.Columns, pet.ForeignKeys...)
}
spec.ScanValues = func() []interface{} {
node := &Pet{config: pq.config}
nodes = append(nodes, node)
return node.scanValues()
values := node.scanValues()
if withFKs {
values = append(values, node.fkValues()...)
}
return values
}
spec.Assign = func(values ...interface{}) error {
if len(nodes) == 0 {
@@ -298,6 +323,32 @@ func (pq *PetQuery) sqlAll(ctx context.Context) ([]*Pet, error) {
if err := sqlgraph.QueryNodes(ctx, pq.driver, spec); err != nil {
return nil, err
}
if query := pq.withOwner; query != nil {
ids := make([]int, 0, len(nodes))
nodeids := make(map[int][]*Pet)
for i := range nodes {
if fk := nodes[i].owner_id; fk != nil {
ids = append(ids, *fk)
nodeids[*fk] = append(nodeids[*fk], nodes[i])
}
}
query.Where(user.IDIn(ids...))
neighbors, err := query.All(ctx)
if err != nil {
return nil, err
}
for _, n := range neighbors {
nodes, ok := nodeids[n.ID]
if !ok {
return nil, fmt.Errorf(`unexpected foreign-key "owner_id" returned %v`, n.ID)
}
for i := range nodes {
nodes[i].Edges.Owner = n
}
}
}
return nodes, nil
}

14
examples/o2m2types/ent/user.go
View File

@@ -23,21 +23,27 @@ type User struct {
Age int `json:"age,omitempty"`
// Name holds the value of the "name" field.
Name string `json:"name,omitempty"`
// Edges holds the relations/edges for other nodes in the graph.
// The values are being populated by the UserQuery when eager-loading is set.
Edges struct {
// Pets holds the value of the pets edge.
Pets []*Pet
}
}
// scanValues returns the types for scanning values from sql.Rows.
func (*User) scanValues() []interface{} {
return []interface{}{
&sql.NullInt64{},
&sql.NullInt64{},
&sql.NullString{},
&sql.NullInt64{}, // id
&sql.NullInt64{}, // age
&sql.NullString{}, // name
}
}
// assignValues assigns the values that were returned from sql.Rows (after scanning)
// to the User fields.
func (u *User) assignValues(values ...interface{}) error {
if m, n := len(values), len(user.Columns); m != n {
if m, n := len(values), len(user.Columns); m < n {
return fmt.Errorf("mismatch number of scan values: %d != %d", m, n)
}
value, ok := values[0].(*sql.NullInt64)

2
examples/o2m2types/ent/user/user.go
View File

@@ -27,7 +27,7 @@ const (
PetsColumn = "owner_id"
)
// Columns holds all SQL columns are user fields.
// Columns holds all SQL columns for user fields.
var Columns = []string{
FieldID,
FieldAge,

46
examples/o2m2types/ent/user_query.go
View File

@@ -8,6 +8,7 @@ package ent
import (
"context"
"database/sql/driver"
"errors"
"fmt"
"math"
@@ -28,6 +29,8 @@ type UserQuery struct {
order []Order
unique []string
predicates []predicate.User
// eager-loading edges.
withPets *PetQuery
// intermediate query.
sql *sql.Selector
}
@@ -237,6 +240,17 @@ func (uq *UserQuery) Clone() *UserQuery {
}
}
// WithPets tells the query-builder to eager-loads the nodes that are connected to
// the "pets" edge. The optional arguments used to configure the query builder of the edge.
func (uq *UserQuery) WithPets(opts ...func(*PetQuery)) *UserQuery {
query := &PetQuery{config: uq.config}
for _, opt := range opts {
opt(query)
}
uq.withPets = query
return uq
}
// GroupBy used to group vertices by one or more fields/columns.
// It is often used with aggregate functions, like: count, max, mean, min, sum.
//
@@ -286,7 +300,8 @@ func (uq *UserQuery) sqlAll(ctx context.Context) ([]*User, error) {
spec.ScanValues = func() []interface{} {
node := &User{config: uq.config}
nodes = append(nodes, node)
return node.scanValues()
values := node.scanValues()
return values
}
spec.Assign = func(values ...interface{}) error {
if len(nodes) == 0 {
@@ -298,6 +313,35 @@ func (uq *UserQuery) sqlAll(ctx context.Context) ([]*User, error) {
if err := sqlgraph.QueryNodes(ctx, uq.driver, spec); err != nil {
return nil, err
}
if query := uq.withPets; query != nil {
fks := make([]driver.Value, 0, len(nodes))
nodeids := make(map[int]*User)
for i := range nodes {
fks = append(fks, nodes[i].ID)
nodeids[nodes[i].ID] = nodes[i]
}
query.withFKs = true
query.Where(predicate.Pet(func(s *sql.Selector) {
s.Where(sql.InValues(user.PetsColumn, fks...))
}))
neighbors, err := query.All(ctx)
if err != nil {
return nil, err
}
for _, n := range neighbors {
fk := n.owner_id
if fk == nil {
return nil, fmt.Errorf(`foreign-key "owner_id" is nil for node %v`, n.ID)
}
node, ok := nodeids[*fk]
if !ok {
return nil, fmt.Errorf(`unexpected foreign-key "owner_id" returned %v for node %v`, *fk, n.ID)
}
node.Edges.Pets = append(node.Edges.Pets, n)
}
}
return nodes, nil
}