query.go 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303
  1. package callbacks
  2. import (
  3. "fmt"
  4. "reflect"
  5. "strings"
  6. "gorm.io/gorm"
  7. "gorm.io/gorm/clause"
  8. "gorm.io/gorm/schema"
  9. "gorm.io/gorm/utils"
  10. )
  11. func Query(db *gorm.DB) {
  12. if db.Error == nil {
  13. BuildQuerySQL(db)
  14. if !db.DryRun && db.Error == nil {
  15. rows, err := db.Statement.ConnPool.QueryContext(db.Statement.Context, db.Statement.SQL.String(), db.Statement.Vars...)
  16. if err != nil {
  17. db.AddError(err)
  18. return
  19. }
  20. defer func() {
  21. db.AddError(rows.Close())
  22. }()
  23. gorm.Scan(rows, db, 0)
  24. }
  25. }
  26. }
  27. func BuildQuerySQL(db *gorm.DB) {
  28. if db.Statement.Schema != nil {
  29. for _, c := range db.Statement.Schema.QueryClauses {
  30. db.Statement.AddClause(c)
  31. }
  32. }
  33. if db.Statement.SQL.Len() == 0 {
  34. db.Statement.SQL.Grow(100)
  35. clauseSelect := clause.Select{Distinct: db.Statement.Distinct}
  36. if db.Statement.ReflectValue.Kind() == reflect.Struct && db.Statement.ReflectValue.Type() == db.Statement.Schema.ModelType {
  37. var conds []clause.Expression
  38. for _, primaryField := range db.Statement.Schema.PrimaryFields {
  39. if v, isZero := primaryField.ValueOf(db.Statement.Context, db.Statement.ReflectValue); !isZero {
  40. conds = append(conds, clause.Eq{Column: clause.Column{Table: db.Statement.Table, Name: primaryField.DBName}, Value: v})
  41. }
  42. }
  43. if len(conds) > 0 {
  44. db.Statement.AddClause(clause.Where{Exprs: conds})
  45. }
  46. }
  47. if len(db.Statement.Selects) > 0 {
  48. clauseSelect.Columns = make([]clause.Column, len(db.Statement.Selects))
  49. for idx, name := range db.Statement.Selects {
  50. if db.Statement.Schema == nil {
  51. clauseSelect.Columns[idx] = clause.Column{Name: name, Raw: true}
  52. } else if f := db.Statement.Schema.LookUpField(name); f != nil {
  53. clauseSelect.Columns[idx] = clause.Column{Name: f.DBName}
  54. } else {
  55. clauseSelect.Columns[idx] = clause.Column{Name: name, Raw: true}
  56. }
  57. }
  58. } else if db.Statement.Schema != nil && len(db.Statement.Omits) > 0 {
  59. selectColumns, _ := db.Statement.SelectAndOmitColumns(false, false)
  60. clauseSelect.Columns = make([]clause.Column, 0, len(db.Statement.Schema.DBNames))
  61. for _, dbName := range db.Statement.Schema.DBNames {
  62. if v, ok := selectColumns[dbName]; (ok && v) || !ok {
  63. clauseSelect.Columns = append(clauseSelect.Columns, clause.Column{Table: db.Statement.Table, Name: dbName})
  64. }
  65. }
  66. } else if db.Statement.Schema != nil && db.Statement.ReflectValue.IsValid() {
  67. queryFields := db.QueryFields
  68. if !queryFields {
  69. switch db.Statement.ReflectValue.Kind() {
  70. case reflect.Struct:
  71. queryFields = db.Statement.ReflectValue.Type() != db.Statement.Schema.ModelType
  72. case reflect.Slice:
  73. queryFields = db.Statement.ReflectValue.Type().Elem() != db.Statement.Schema.ModelType
  74. }
  75. }
  76. if queryFields {
  77. stmt := gorm.Statement{DB: db}
  78. // smaller struct
  79. if err := stmt.Parse(db.Statement.Dest); err == nil && (db.QueryFields || stmt.Schema.ModelType != db.Statement.Schema.ModelType) {
  80. clauseSelect.Columns = make([]clause.Column, len(stmt.Schema.DBNames))
  81. for idx, dbName := range stmt.Schema.DBNames {
  82. clauseSelect.Columns[idx] = clause.Column{Table: db.Statement.Table, Name: dbName}
  83. }
  84. }
  85. }
  86. }
  87. // inline joins
  88. fromClause := clause.From{}
  89. if v, ok := db.Statement.Clauses["FROM"].Expression.(clause.From); ok {
  90. fromClause = v
  91. }
  92. if len(db.Statement.Joins) != 0 || len(fromClause.Joins) != 0 {
  93. if len(db.Statement.Selects) == 0 && len(db.Statement.Omits) == 0 && db.Statement.Schema != nil {
  94. clauseSelect.Columns = make([]clause.Column, len(db.Statement.Schema.DBNames))
  95. for idx, dbName := range db.Statement.Schema.DBNames {
  96. clauseSelect.Columns[idx] = clause.Column{Table: db.Statement.Table, Name: dbName}
  97. }
  98. }
  99. specifiedRelationsName := make(map[string]interface{})
  100. for _, join := range db.Statement.Joins {
  101. if db.Statement.Schema != nil {
  102. var isRelations bool // is relations or raw sql
  103. var relations []*schema.Relationship
  104. relation, ok := db.Statement.Schema.Relationships.Relations[join.Name]
  105. if ok {
  106. isRelations = true
  107. relations = append(relations, relation)
  108. } else {
  109. // handle nested join like "Manager.Company"
  110. nestedJoinNames := strings.Split(join.Name, ".")
  111. if len(nestedJoinNames) > 1 {
  112. isNestedJoin := true
  113. gussNestedRelations := make([]*schema.Relationship, 0, len(nestedJoinNames))
  114. currentRelations := db.Statement.Schema.Relationships.Relations
  115. for _, relname := range nestedJoinNames {
  116. // incomplete match, only treated as raw sql
  117. if relation, ok = currentRelations[relname]; ok {
  118. gussNestedRelations = append(gussNestedRelations, relation)
  119. currentRelations = relation.FieldSchema.Relationships.Relations
  120. } else {
  121. isNestedJoin = false
  122. break
  123. }
  124. }
  125. if isNestedJoin {
  126. isRelations = true
  127. relations = gussNestedRelations
  128. }
  129. }
  130. }
  131. if isRelations {
  132. genJoinClause := func(joinType clause.JoinType, parentTableName string, relation *schema.Relationship) clause.Join {
  133. tableAliasName := relation.Name
  134. if parentTableName != clause.CurrentTable {
  135. tableAliasName = utils.NestedRelationName(parentTableName, tableAliasName)
  136. }
  137. columnStmt := gorm.Statement{
  138. Table: tableAliasName, DB: db, Schema: relation.FieldSchema,
  139. Selects: join.Selects, Omits: join.Omits,
  140. }
  141. selectColumns, restricted := columnStmt.SelectAndOmitColumns(false, false)
  142. for _, s := range relation.FieldSchema.DBNames {
  143. if v, ok := selectColumns[s]; (ok && v) || (!ok && !restricted) {
  144. clauseSelect.Columns = append(clauseSelect.Columns, clause.Column{
  145. Table: tableAliasName,
  146. Name: s,
  147. Alias: utils.NestedRelationName(tableAliasName, s),
  148. })
  149. }
  150. }
  151. exprs := make([]clause.Expression, len(relation.References))
  152. for idx, ref := range relation.References {
  153. if ref.OwnPrimaryKey {
  154. exprs[idx] = clause.Eq{
  155. Column: clause.Column{Table: parentTableName, Name: ref.PrimaryKey.DBName},
  156. Value: clause.Column{Table: tableAliasName, Name: ref.ForeignKey.DBName},
  157. }
  158. } else {
  159. if ref.PrimaryValue == "" {
  160. exprs[idx] = clause.Eq{
  161. Column: clause.Column{Table: parentTableName, Name: ref.ForeignKey.DBName},
  162. Value: clause.Column{Table: tableAliasName, Name: ref.PrimaryKey.DBName},
  163. }
  164. } else {
  165. exprs[idx] = clause.Eq{
  166. Column: clause.Column{Table: tableAliasName, Name: ref.ForeignKey.DBName},
  167. Value: ref.PrimaryValue,
  168. }
  169. }
  170. }
  171. }
  172. {
  173. onStmt := gorm.Statement{Table: tableAliasName, DB: db, Clauses: map[string]clause.Clause{}}
  174. for _, c := range relation.FieldSchema.QueryClauses {
  175. onStmt.AddClause(c)
  176. }
  177. if join.On != nil {
  178. onStmt.AddClause(join.On)
  179. }
  180. if cs, ok := onStmt.Clauses["WHERE"]; ok {
  181. if where, ok := cs.Expression.(clause.Where); ok {
  182. where.Build(&onStmt)
  183. if onSQL := onStmt.SQL.String(); onSQL != "" {
  184. vars := onStmt.Vars
  185. for idx, v := range vars {
  186. bindvar := strings.Builder{}
  187. onStmt.Vars = vars[0 : idx+1]
  188. db.Dialector.BindVarTo(&bindvar, &onStmt, v)
  189. onSQL = strings.Replace(onSQL, bindvar.String(), "?", 1)
  190. }
  191. exprs = append(exprs, clause.Expr{SQL: onSQL, Vars: vars})
  192. }
  193. }
  194. }
  195. }
  196. return clause.Join{
  197. Type: joinType,
  198. Table: clause.Table{Name: relation.FieldSchema.Table, Alias: tableAliasName},
  199. ON: clause.Where{Exprs: exprs},
  200. }
  201. }
  202. parentTableName := clause.CurrentTable
  203. for _, rel := range relations {
  204. // joins table alias like "Manager, Company, Manager__Company"
  205. nestedAlias := utils.NestedRelationName(parentTableName, rel.Name)
  206. if _, ok := specifiedRelationsName[nestedAlias]; !ok {
  207. fromClause.Joins = append(fromClause.Joins, genJoinClause(join.JoinType, parentTableName, rel))
  208. specifiedRelationsName[nestedAlias] = nil
  209. }
  210. if parentTableName != clause.CurrentTable {
  211. parentTableName = utils.NestedRelationName(parentTableName, rel.Name)
  212. } else {
  213. parentTableName = rel.Name
  214. }
  215. }
  216. } else {
  217. fromClause.Joins = append(fromClause.Joins, clause.Join{
  218. Expression: clause.NamedExpr{SQL: join.Name, Vars: join.Conds},
  219. })
  220. }
  221. } else {
  222. fromClause.Joins = append(fromClause.Joins, clause.Join{
  223. Expression: clause.NamedExpr{SQL: join.Name, Vars: join.Conds},
  224. })
  225. }
  226. }
  227. db.Statement.AddClause(fromClause)
  228. } else {
  229. db.Statement.AddClauseIfNotExists(clause.From{})
  230. }
  231. db.Statement.AddClauseIfNotExists(clauseSelect)
  232. db.Statement.Build(db.Statement.BuildClauses...)
  233. }
  234. }
  235. func Preload(db *gorm.DB) {
  236. if db.Error == nil && len(db.Statement.Preloads) > 0 {
  237. if db.Statement.Schema == nil {
  238. db.AddError(fmt.Errorf("%w when using preload", gorm.ErrModelValueRequired))
  239. return
  240. }
  241. joins := make([]string, 0, len(db.Statement.Joins))
  242. for _, join := range db.Statement.Joins {
  243. joins = append(joins, join.Name)
  244. }
  245. tx := preloadDB(db, db.Statement.ReflectValue, db.Statement.Dest)
  246. if tx.Error != nil {
  247. return
  248. }
  249. db.AddError(preloadEntryPoint(tx, joins, &tx.Statement.Schema.Relationships, db.Statement.Preloads, db.Statement.Preloads[clause.Associations]))
  250. }
  251. }
  252. func AfterQuery(db *gorm.DB) {
  253. // clear the joins after query because preload need it
  254. if v, ok := db.Statement.Clauses["FROM"].Expression.(clause.From); ok {
  255. fromClause := db.Statement.Clauses["FROM"]
  256. fromClause.Expression = clause.From{Tables: v.Tables, Joins: utils.RTrimSlice(v.Joins, len(db.Statement.Joins))} // keep the original From Joins
  257. db.Statement.Clauses["FROM"] = fromClause
  258. }
  259. if db.Error == nil && db.Statement.Schema != nil && !db.Statement.SkipHooks && db.Statement.Schema.AfterFind && db.RowsAffected > 0 {
  260. callMethod(db, func(value interface{}, tx *gorm.DB) bool {
  261. if i, ok := value.(AfterFindInterface); ok {
  262. db.AddError(i.AfterFind(tx))
  263. return true
  264. }
  265. return false
  266. })
  267. }
  268. }