15 // Scope contain current operation's information when you perform any operation on the database
23 primaryKeyField *Field
29 // IndirectValue return scope's reflect value's indirect value
30 func (scope *Scope) IndirectValue() reflect.Value {
31 return indirect(reflect.ValueOf(scope.Value))
34 // New create a new Scope without search information
35 func (scope *Scope) New(value interface{}) *Scope {
36 return &Scope{db: scope.NewDB(), Search: &search{}, Value: value}
39 ////////////////////////////////////////////////////////////////////////////////
41 ////////////////////////////////////////////////////////////////////////////////
43 // DB return scope's DB connection
44 func (scope *Scope) DB() *DB {
48 // NewDB create a new DB without search information
49 func (scope *Scope) NewDB() *DB {
51 db := scope.db.clone()
59 // SQLDB return *sql.DB
60 func (scope *Scope) SQLDB() SQLCommon {
64 // Dialect get dialect
65 func (scope *Scope) Dialect() Dialect {
66 return scope.db.dialect
69 // Quote used to quote string to escape them for database
70 func (scope *Scope) Quote(str string) string {
71 if strings.Contains(str, ".") {
73 for _, str := range strings.Split(str, ".") {
74 newStrs = append(newStrs, scope.Dialect().Quote(str))
76 return strings.Join(newStrs, ".")
79 return scope.Dialect().Quote(str)
82 // Err add error to Scope
83 func (scope *Scope) Err(err error) error {
85 scope.db.AddError(err)
90 // HasError check if there are any error
91 func (scope *Scope) HasError() bool {
92 return scope.db.Error != nil
95 // Log print log message
96 func (scope *Scope) Log(v ...interface{}) {
100 // SkipLeft skip remaining callbacks
101 func (scope *Scope) SkipLeft() {
102 scope.skipLeft = true
105 // Fields get value's fields
106 func (scope *Scope) Fields() []*Field {
107 if scope.fields == nil {
110 indirectScopeValue = scope.IndirectValue()
111 isStruct = indirectScopeValue.Kind() == reflect.Struct
114 for _, structField := range scope.GetModelStruct().StructFields {
116 fieldValue := indirectScopeValue
117 for _, name := range structField.Names {
118 if fieldValue.Kind() == reflect.Ptr && fieldValue.IsNil() {
119 fieldValue.Set(reflect.New(fieldValue.Type().Elem()))
121 fieldValue = reflect.Indirect(fieldValue).FieldByName(name)
123 fields = append(fields, &Field{StructField: structField, Field: fieldValue, IsBlank: isBlank(fieldValue)})
125 fields = append(fields, &Field{StructField: structField, IsBlank: true})
128 scope.fields = &fields
134 // FieldByName find `gorm.Field` with field name or db name
135 func (scope *Scope) FieldByName(name string) (field *Field, ok bool) {
137 dbName = ToColumnName(name)
138 mostMatchedField *Field
141 for _, field := range scope.Fields() {
142 if field.Name == name || field.DBName == name {
145 if field.DBName == dbName {
146 mostMatchedField = field
149 return mostMatchedField, mostMatchedField != nil
152 // PrimaryFields return scope's primary fields
153 func (scope *Scope) PrimaryFields() (fields []*Field) {
154 for _, field := range scope.Fields() {
155 if field.IsPrimaryKey {
156 fields = append(fields, field)
162 // PrimaryField return scope's main primary field, if defined more that one primary fields, will return the one having column name `id` or the first one
163 func (scope *Scope) PrimaryField() *Field {
164 if primaryFields := scope.GetModelStruct().PrimaryFields; len(primaryFields) > 0 {
165 if len(primaryFields) > 1 {
166 if field, ok := scope.FieldByName("id"); ok {
170 return scope.PrimaryFields()[0]
175 // PrimaryKey get main primary field's db name
176 func (scope *Scope) PrimaryKey() string {
177 if field := scope.PrimaryField(); field != nil {
183 // PrimaryKeyZero check main primary field's value is blank or not
184 func (scope *Scope) PrimaryKeyZero() bool {
185 field := scope.PrimaryField()
186 return field == nil || field.IsBlank
189 // PrimaryKeyValue get the primary key's value
190 func (scope *Scope) PrimaryKeyValue() interface{} {
191 if field := scope.PrimaryField(); field != nil && field.Field.IsValid() {
192 return field.Field.Interface()
197 // HasColumn to check if has column
198 func (scope *Scope) HasColumn(column string) bool {
199 for _, field := range scope.GetStructFields() {
200 if field.IsNormal && (field.Name == column || field.DBName == column) {
207 // SetColumn to set the column's value, column could be field or field's name/dbname
208 func (scope *Scope) SetColumn(column interface{}, value interface{}) error {
209 var updateAttrs = map[string]interface{}{}
210 if attrs, ok := scope.InstanceGet("gorm:update_attrs"); ok {
211 updateAttrs = attrs.(map[string]interface{})
212 defer scope.InstanceSet("gorm:update_attrs", updateAttrs)
215 if field, ok := column.(*Field); ok {
216 updateAttrs[field.DBName] = value
217 return field.Set(value)
218 } else if name, ok := column.(string); ok {
220 dbName = ToDBName(name)
221 mostMatchedField *Field
223 for _, field := range scope.Fields() {
224 if field.DBName == value {
225 updateAttrs[field.DBName] = value
226 return field.Set(value)
228 if (field.DBName == dbName) || (field.Name == name && mostMatchedField == nil) {
229 mostMatchedField = field
233 if mostMatchedField != nil {
234 updateAttrs[mostMatchedField.DBName] = value
235 return mostMatchedField.Set(value)
238 return errors.New("could not convert column to field")
241 // CallMethod call scope value's method, if it is a slice, will call its element's method one by one
242 func (scope *Scope) CallMethod(methodName string) {
243 if scope.Value == nil {
247 if indirectScopeValue := scope.IndirectValue(); indirectScopeValue.Kind() == reflect.Slice {
248 for i := 0; i < indirectScopeValue.Len(); i++ {
249 scope.callMethod(methodName, indirectScopeValue.Index(i))
252 scope.callMethod(methodName, indirectScopeValue)
256 // AddToVars add value as sql's vars, used to prevent SQL injection
257 func (scope *Scope) AddToVars(value interface{}) string {
258 _, skipBindVar := scope.InstanceGet("skip_bindvar")
260 if expr, ok := value.(*expr); ok {
262 for _, arg := range expr.args {
266 exp = strings.Replace(exp, "?", scope.AddToVars(arg), 1)
272 scope.SQLVars = append(scope.SQLVars, value)
277 return scope.Dialect().BindVar(len(scope.SQLVars))
280 // SelectAttrs return selected attributes
281 func (scope *Scope) SelectAttrs() []string {
282 if scope.selectAttrs == nil {
284 for _, value := range scope.Search.selects {
285 if str, ok := value.(string); ok {
286 attrs = append(attrs, str)
287 } else if strs, ok := value.([]string); ok {
288 attrs = append(attrs, strs...)
289 } else if strs, ok := value.([]interface{}); ok {
290 for _, str := range strs {
291 attrs = append(attrs, fmt.Sprintf("%v", str))
295 scope.selectAttrs = &attrs
297 return *scope.selectAttrs
300 // OmitAttrs return omitted attributes
301 func (scope *Scope) OmitAttrs() []string {
302 return scope.Search.omits
305 type tabler interface {
309 type dbTabler interface {
310 TableName(*DB) string
313 // TableName return table name
314 func (scope *Scope) TableName() string {
315 if scope.Search != nil && len(scope.Search.tableName) > 0 {
316 return scope.Search.tableName
319 if tabler, ok := scope.Value.(tabler); ok {
320 return tabler.TableName()
323 if tabler, ok := scope.Value.(dbTabler); ok {
324 return tabler.TableName(scope.db)
327 return scope.GetModelStruct().TableName(scope.db.Model(scope.Value))
330 // QuotedTableName return quoted table name
331 func (scope *Scope) QuotedTableName() (name string) {
332 if scope.Search != nil && len(scope.Search.tableName) > 0 {
333 if strings.Contains(scope.Search.tableName, " ") {
334 return scope.Search.tableName
336 return scope.Quote(scope.Search.tableName)
339 return scope.Quote(scope.TableName())
342 // CombinedConditionSql return combined condition sql
343 func (scope *Scope) CombinedConditionSql() string {
344 joinSQL := scope.joinsSQL()
345 whereSQL := scope.whereSQL()
346 if scope.Search.raw {
347 whereSQL = strings.TrimSuffix(strings.TrimPrefix(whereSQL, "WHERE ("), ")")
349 return joinSQL + whereSQL + scope.groupSQL() +
350 scope.havingSQL() + scope.orderSQL() + scope.limitAndOffsetSQL()
354 func (scope *Scope) Raw(sql string) *Scope {
355 scope.SQL = strings.Replace(sql, "$$$", "?", -1)
359 // Exec perform generated SQL
360 func (scope *Scope) Exec() *Scope {
361 defer scope.trace(NowFunc())
363 if !scope.HasError() {
364 if result, err := scope.SQLDB().Exec(scope.SQL, scope.SQLVars...); scope.Err(err) == nil {
365 if count, err := result.RowsAffected(); scope.Err(err) == nil {
366 scope.db.RowsAffected = count
373 // Set set value by name
374 func (scope *Scope) Set(name string, value interface{}) *Scope {
375 scope.db.InstantSet(name, value)
379 // Get get setting by name
380 func (scope *Scope) Get(name string) (interface{}, bool) {
381 return scope.db.Get(name)
384 // InstanceID get InstanceID for scope
385 func (scope *Scope) InstanceID() string {
386 if scope.instanceID == "" {
387 scope.instanceID = fmt.Sprintf("%v%v", &scope, &scope.db)
389 return scope.instanceID
392 // InstanceSet set instance setting for current operation, but not for operations in callbacks, like saving associations callback
393 func (scope *Scope) InstanceSet(name string, value interface{}) *Scope {
394 return scope.Set(name+scope.InstanceID(), value)
397 // InstanceGet get instance setting from current operation
398 func (scope *Scope) InstanceGet(name string) (interface{}, bool) {
399 return scope.Get(name + scope.InstanceID())
402 // Begin start a transaction
403 func (scope *Scope) Begin() *Scope {
404 if db, ok := scope.SQLDB().(sqlDb); ok {
405 if tx, err := db.Begin(); err == nil {
406 scope.db.db = interface{}(tx).(SQLCommon)
407 scope.InstanceSet("gorm:started_transaction", true)
413 // CommitOrRollback commit current transaction if no error happened, otherwise will rollback it
414 func (scope *Scope) CommitOrRollback() *Scope {
415 if _, ok := scope.InstanceGet("gorm:started_transaction"); ok {
416 if db, ok := scope.db.db.(sqlTx); ok {
417 if scope.HasError() {
420 scope.Err(db.Commit())
422 scope.db.db = scope.db.parent.db
428 ////////////////////////////////////////////////////////////////////////////////
429 // Private Methods For *gorm.Scope
430 ////////////////////////////////////////////////////////////////////////////////
432 func (scope *Scope) callMethod(methodName string, reflectValue reflect.Value) {
433 // Only get address from non-pointer
434 if reflectValue.CanAddr() && reflectValue.Kind() != reflect.Ptr {
435 reflectValue = reflectValue.Addr()
438 if methodValue := reflectValue.MethodByName(methodName); methodValue.IsValid() {
439 switch method := methodValue.Interface().(type) {
445 newDB := scope.NewDB()
447 scope.Err(newDB.Error)
450 case func(*Scope) error:
451 scope.Err(method(scope))
452 case func(*DB) error:
453 newDB := scope.NewDB()
454 scope.Err(method(newDB))
455 scope.Err(newDB.Error)
457 scope.Err(fmt.Errorf("unsupported function %v", methodName))
463 columnRegexp = regexp.MustCompile("^[a-zA-Z\\d]+(\\.[a-zA-Z\\d]+)*$") // only match string like `name`, `users.name`
464 isNumberRegexp = regexp.MustCompile("^\\s*\\d+\\s*$") // match if string is number
465 comparisonRegexp = regexp.MustCompile("(?i) (=|<>|(>|<)(=?)|LIKE|IS|IN) ")
466 countingQueryRegexp = regexp.MustCompile("(?i)^count(.+)$")
469 func (scope *Scope) quoteIfPossible(str string) string {
470 if columnRegexp.MatchString(str) {
471 return scope.Quote(str)
476 func (scope *Scope) scan(rows *sql.Rows, columns []string, fields []*Field) {
479 values = make([]interface{}, len(columns))
480 selectFields []*Field
481 selectedColumnsMap = map[string]int{}
482 resetFields = map[int]*Field{}
485 for index, column := range columns {
486 values[index] = &ignored
488 selectFields = fields
490 if idx, ok := selectedColumnsMap[column]; ok {
492 selectFields = selectFields[offset:]
495 for fieldIndex, field := range selectFields {
496 if field.DBName == column {
497 if field.Field.Kind() == reflect.Ptr {
498 values[index] = field.Field.Addr().Interface()
500 reflectValue := reflect.New(reflect.PtrTo(field.Struct.Type))
501 reflectValue.Elem().Set(field.Field.Addr())
502 values[index] = reflectValue.Interface()
503 resetFields[index] = field
506 selectedColumnsMap[column] = offset + fieldIndex
515 scope.Err(rows.Scan(values...))
517 for index, field := range resetFields {
518 if v := reflect.ValueOf(values[index]).Elem().Elem(); v.IsValid() {
524 func (scope *Scope) primaryCondition(value interface{}) string {
525 return fmt.Sprintf("(%v.%v = %v)", scope.QuotedTableName(), scope.Quote(scope.PrimaryKey()), value)
528 func (scope *Scope) buildCondition(clause map[string]interface{}, include bool) (str string) {
530 quotedTableName = scope.QuotedTableName()
531 quotedPrimaryKey = scope.Quote(scope.PrimaryKey())
536 // If building not conditions
542 switch value := clause["query"].(type) {
544 return fmt.Sprintf("(%v.%v %s %v)", quotedTableName, quotedPrimaryKey, equalSQL, value.Int64)
545 case int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64:
546 return fmt.Sprintf("(%v.%v %s %v)", quotedTableName, quotedPrimaryKey, equalSQL, value)
547 case []int, []int8, []int16, []int32, []int64, []uint, []uint8, []uint16, []uint32, []uint64, []string, []interface{}:
548 if !include && reflect.ValueOf(value).Len() == 0 {
551 str = fmt.Sprintf("(%v.%v %s (?))", quotedTableName, quotedPrimaryKey, inSQL)
552 clause["args"] = []interface{}{value}
554 if isNumberRegexp.MatchString(value) {
555 return fmt.Sprintf("(%v.%v %s %v)", quotedTableName, quotedPrimaryKey, equalSQL, scope.AddToVars(value))
560 if comparisonRegexp.MatchString(value) {
561 str = fmt.Sprintf("NOT (%v)", value)
563 str = fmt.Sprintf("(%v.%v NOT IN (?))", quotedTableName, scope.Quote(value))
566 str = fmt.Sprintf("(%v)", value)
569 case map[string]interface{}:
571 for key, value := range value {
573 sqls = append(sqls, fmt.Sprintf("(%v.%v %s %v)", quotedTableName, scope.Quote(key), equalSQL, scope.AddToVars(value)))
576 sqls = append(sqls, fmt.Sprintf("(%v.%v IS NOT NULL)", quotedTableName, scope.Quote(key)))
578 sqls = append(sqls, fmt.Sprintf("(%v.%v IS NULL)", quotedTableName, scope.Quote(key)))
582 return strings.Join(sqls, " AND ")
585 newScope := scope.New(value)
587 if len(newScope.Fields()) == 0 {
588 scope.Err(fmt.Errorf("invalid query condition: %v", value))
591 scopeQuotedTableName := newScope.QuotedTableName()
592 for _, field := range newScope.Fields() {
593 if !field.IsIgnored && !field.IsBlank {
594 sqls = append(sqls, fmt.Sprintf("(%v.%v %s %v)", scopeQuotedTableName, scope.Quote(field.DBName), equalSQL, scope.AddToVars(field.Field.Interface())))
597 return strings.Join(sqls, " AND ")
599 scope.Err(fmt.Errorf("invalid query condition: %v", value))
603 replacements := []string{}
604 args := clause["args"].([]interface{})
605 for _, arg := range args {
607 switch reflect.ValueOf(arg).Kind() {
608 case reflect.Slice: // For where("id in (?)", []int64{1,2})
609 if scanner, ok := interface{}(arg).(driver.Valuer); ok {
610 arg, err = scanner.Value()
611 replacements = append(replacements, scope.AddToVars(arg))
612 } else if b, ok := arg.([]byte); ok {
613 replacements = append(replacements, scope.AddToVars(b))
614 } else if as, ok := arg.([][]interface{}); ok {
615 var tempMarks []string
616 for _, a := range as {
617 var arrayMarks []string
618 for _, v := range a {
619 arrayMarks = append(arrayMarks, scope.AddToVars(v))
622 if len(arrayMarks) > 0 {
623 tempMarks = append(tempMarks, fmt.Sprintf("(%v)", strings.Join(arrayMarks, ",")))
627 if len(tempMarks) > 0 {
628 replacements = append(replacements, strings.Join(tempMarks, ","))
630 } else if values := reflect.ValueOf(arg); values.Len() > 0 {
631 var tempMarks []string
632 for i := 0; i < values.Len(); i++ {
633 tempMarks = append(tempMarks, scope.AddToVars(values.Index(i).Interface()))
635 replacements = append(replacements, strings.Join(tempMarks, ","))
637 replacements = append(replacements, scope.AddToVars(Expr("NULL")))
640 if valuer, ok := interface{}(arg).(driver.Valuer); ok {
641 arg, err = valuer.Value()
644 replacements = append(replacements, scope.AddToVars(arg))
652 buff := bytes.NewBuffer([]byte{})
654 for _, s := range str {
655 if s == '?' && len(replacements) > i {
656 buff.WriteString(replacements[i])
668 func (scope *Scope) buildSelectQuery(clause map[string]interface{}) (str string) {
669 switch value := clause["query"].(type) {
673 str = strings.Join(value, ", ")
676 args := clause["args"].([]interface{})
677 replacements := []string{}
678 for _, arg := range args {
679 switch reflect.ValueOf(arg).Kind() {
681 values := reflect.ValueOf(arg)
682 var tempMarks []string
683 for i := 0; i < values.Len(); i++ {
684 tempMarks = append(tempMarks, scope.AddToVars(values.Index(i).Interface()))
686 replacements = append(replacements, strings.Join(tempMarks, ","))
688 if valuer, ok := interface{}(arg).(driver.Valuer); ok {
689 arg, _ = valuer.Value()
691 replacements = append(replacements, scope.AddToVars(arg))
695 buff := bytes.NewBuffer([]byte{})
697 for pos, char := range str {
699 buff.WriteString(replacements[i])
711 func (scope *Scope) whereSQL() (sql string) {
713 quotedTableName = scope.QuotedTableName()
714 deletedAtField, hasDeletedAtField = scope.FieldByName("DeletedAt")
715 primaryConditions, andConditions, orConditions []string
718 if !scope.Search.Unscoped && hasDeletedAtField {
719 sql := fmt.Sprintf("%v.%v IS NULL", quotedTableName, scope.Quote(deletedAtField.DBName))
720 primaryConditions = append(primaryConditions, sql)
723 if !scope.PrimaryKeyZero() {
724 for _, field := range scope.PrimaryFields() {
725 sql := fmt.Sprintf("%v.%v = %v", quotedTableName, scope.Quote(field.DBName), scope.AddToVars(field.Field.Interface()))
726 primaryConditions = append(primaryConditions, sql)
730 for _, clause := range scope.Search.whereConditions {
731 if sql := scope.buildCondition(clause, true); sql != "" {
732 andConditions = append(andConditions, sql)
736 for _, clause := range scope.Search.orConditions {
737 if sql := scope.buildCondition(clause, true); sql != "" {
738 orConditions = append(orConditions, sql)
742 for _, clause := range scope.Search.notConditions {
743 if sql := scope.buildCondition(clause, false); sql != "" {
744 andConditions = append(andConditions, sql)
748 orSQL := strings.Join(orConditions, " OR ")
749 combinedSQL := strings.Join(andConditions, " AND ")
750 if len(combinedSQL) > 0 {
752 combinedSQL = combinedSQL + " OR " + orSQL
758 if len(primaryConditions) > 0 {
759 sql = "WHERE " + strings.Join(primaryConditions, " AND ")
760 if len(combinedSQL) > 0 {
761 sql = sql + " AND (" + combinedSQL + ")"
763 } else if len(combinedSQL) > 0 {
764 sql = "WHERE " + combinedSQL
769 func (scope *Scope) selectSQL() string {
770 if len(scope.Search.selects) == 0 {
771 if len(scope.Search.joinConditions) > 0 {
772 return fmt.Sprintf("%v.*", scope.QuotedTableName())
776 return scope.buildSelectQuery(scope.Search.selects)
779 func (scope *Scope) orderSQL() string {
780 if len(scope.Search.orders) == 0 || scope.Search.ignoreOrderQuery {
785 for _, order := range scope.Search.orders {
786 if str, ok := order.(string); ok {
787 orders = append(orders, scope.quoteIfPossible(str))
788 } else if expr, ok := order.(*expr); ok {
790 for _, arg := range expr.args {
791 exp = strings.Replace(exp, "?", scope.AddToVars(arg), 1)
793 orders = append(orders, exp)
796 return " ORDER BY " + strings.Join(orders, ",")
799 func (scope *Scope) limitAndOffsetSQL() string {
800 return scope.Dialect().LimitAndOffsetSQL(scope.Search.limit, scope.Search.offset)
803 func (scope *Scope) groupSQL() string {
804 if len(scope.Search.group) == 0 {
807 return " GROUP BY " + scope.Search.group
810 func (scope *Scope) havingSQL() string {
811 if len(scope.Search.havingConditions) == 0 {
815 var andConditions []string
816 for _, clause := range scope.Search.havingConditions {
817 if sql := scope.buildCondition(clause, true); sql != "" {
818 andConditions = append(andConditions, sql)
822 combinedSQL := strings.Join(andConditions, " AND ")
823 if len(combinedSQL) == 0 {
827 return " HAVING " + combinedSQL
830 func (scope *Scope) joinsSQL() string {
831 var joinConditions []string
832 for _, clause := range scope.Search.joinConditions {
833 if sql := scope.buildCondition(clause, true); sql != "" {
834 joinConditions = append(joinConditions, strings.TrimSuffix(strings.TrimPrefix(sql, "("), ")"))
838 return strings.Join(joinConditions, " ") + " "
841 func (scope *Scope) prepareQuerySQL() {
842 if scope.Search.raw {
843 scope.Raw(scope.CombinedConditionSql())
845 scope.Raw(fmt.Sprintf("SELECT %v FROM %v %v", scope.selectSQL(), scope.QuotedTableName(), scope.CombinedConditionSql()))
850 func (scope *Scope) inlineCondition(values ...interface{}) *Scope {
852 scope.Search.Where(values[0], values[1:]...)
857 func (scope *Scope) callCallbacks(funcs []*func(s *Scope)) *Scope {
859 if err := recover(); err != nil {
860 if db, ok := scope.db.db.(sqlTx); ok {
866 for _, f := range funcs {
875 func convertInterfaceToMap(values interface{}, withIgnoredField bool) map[string]interface{} {
876 var attrs = map[string]interface{}{}
878 switch value := values.(type) {
879 case map[string]interface{}:
882 for _, v := range value {
883 for key, value := range convertInterfaceToMap(v, withIgnoredField) {
888 reflectValue := reflect.ValueOf(values)
890 switch reflectValue.Kind() {
892 for _, key := range reflectValue.MapKeys() {
893 attrs[ToColumnName(key.Interface().(string))] = reflectValue.MapIndex(key).Interface()
896 for _, field := range (&Scope{Value: values}).Fields() {
897 if !field.IsBlank && (withIgnoredField || !field.IsIgnored) {
898 attrs[field.DBName] = field.Field.Interface()
906 func (scope *Scope) updatedAttrsWithValues(value interface{}) (results map[string]interface{}, hasUpdate bool) {
907 if scope.IndirectValue().Kind() != reflect.Struct {
908 return convertInterfaceToMap(value, false), true
911 results = map[string]interface{}{}
913 for key, value := range convertInterfaceToMap(value, true) {
914 if field, ok := scope.FieldByName(key); ok && scope.changeableField(field) {
915 if _, ok := value.(*expr); ok {
917 results[field.DBName] = value
919 err := field.Set(value)
920 if field.IsNormal && !field.IsIgnored {
922 if err == ErrUnaddressable {
923 results[field.DBName] = value
925 results[field.DBName] = field.Field.Interface()
934 func (scope *Scope) row() *sql.Row {
935 defer scope.trace(NowFunc())
937 result := &RowQueryResult{}
938 scope.InstanceSet("row_query_result", result)
939 scope.callCallbacks(scope.db.parent.callbacks.rowQueries)
944 func (scope *Scope) rows() (*sql.Rows, error) {
945 defer scope.trace(NowFunc())
947 result := &RowsQueryResult{}
948 scope.InstanceSet("row_query_result", result)
949 scope.callCallbacks(scope.db.parent.callbacks.rowQueries)
951 return result.Rows, result.Error
954 func (scope *Scope) initialize() *Scope {
955 for _, clause := range scope.Search.whereConditions {
956 scope.updatedAttrsWithValues(clause["query"])
958 scope.updatedAttrsWithValues(scope.Search.initAttrs)
959 scope.updatedAttrsWithValues(scope.Search.assignAttrs)
963 func (scope *Scope) isQueryForColumn(query interface{}, column string) bool {
964 queryStr := strings.ToLower(fmt.Sprint(query))
965 if queryStr == column {
969 if strings.HasSuffix(queryStr, "as "+column) {
973 if strings.HasSuffix(queryStr, "as "+scope.Quote(column)) {
980 func (scope *Scope) pluck(column string, value interface{}) *Scope {
981 dest := reflect.Indirect(reflect.ValueOf(value))
982 if dest.Kind() != reflect.Slice {
983 scope.Err(fmt.Errorf("results should be a slice, not %s", dest.Kind()))
987 if query, ok := scope.Search.selects["query"]; !ok || !scope.isQueryForColumn(query, column) {
988 scope.Search.Select(column)
991 rows, err := scope.rows()
992 if scope.Err(err) == nil {
995 elem := reflect.New(dest.Type().Elem()).Interface()
996 scope.Err(rows.Scan(elem))
997 dest.Set(reflect.Append(dest, reflect.ValueOf(elem).Elem()))
1000 if err := rows.Err(); err != nil {
1007 func (scope *Scope) count(value interface{}) *Scope {
1008 if query, ok := scope.Search.selects["query"]; !ok || !countingQueryRegexp.MatchString(fmt.Sprint(query)) {
1009 if len(scope.Search.group) != 0 {
1010 scope.Search.Select("count(*) FROM ( SELECT count(*) as name ")
1011 scope.Search.group += " ) AS count_table"
1013 scope.Search.Select("count(*)")
1016 scope.Search.ignoreOrderQuery = true
1017 scope.Err(scope.row().Scan(value))
1021 func (scope *Scope) typeName() string {
1022 typ := scope.IndirectValue().Type()
1024 for typ.Kind() == reflect.Slice || typ.Kind() == reflect.Ptr {
1031 // trace print sql log
1032 func (scope *Scope) trace(t time.Time) {
1033 if len(scope.SQL) > 0 {
1034 scope.db.slog(scope.SQL, t, scope.SQLVars...)
1038 func (scope *Scope) changeableField(field *Field) bool {
1039 if selectAttrs := scope.SelectAttrs(); len(selectAttrs) > 0 {
1040 for _, attr := range selectAttrs {
1041 if field.Name == attr || field.DBName == attr {
1048 for _, attr := range scope.OmitAttrs() {
1049 if field.Name == attr || field.DBName == attr {
1057 func (scope *Scope) related(value interface{}, foreignKeys ...string) *Scope {
1058 toScope := scope.db.NewScope(value)
1059 tx := scope.db.Set("gorm:association:source", scope.Value)
1061 for _, foreignKey := range append(foreignKeys, toScope.typeName()+"Id", scope.typeName()+"Id") {
1062 fromField, _ := scope.FieldByName(foreignKey)
1063 toField, _ := toScope.FieldByName(foreignKey)
1065 if fromField != nil {
1066 if relationship := fromField.Relationship; relationship != nil {
1067 if relationship.Kind == "many_to_many" {
1068 joinTableHandler := relationship.JoinTableHandler
1069 scope.Err(joinTableHandler.JoinWith(joinTableHandler, tx, scope.Value).Find(value).Error)
1070 } else if relationship.Kind == "belongs_to" {
1071 for idx, foreignKey := range relationship.ForeignDBNames {
1072 if field, ok := scope.FieldByName(foreignKey); ok {
1073 tx = tx.Where(fmt.Sprintf("%v = ?", scope.Quote(relationship.AssociationForeignDBNames[idx])), field.Field.Interface())
1076 scope.Err(tx.Find(value).Error)
1077 } else if relationship.Kind == "has_many" || relationship.Kind == "has_one" {
1078 for idx, foreignKey := range relationship.ForeignDBNames {
1079 if field, ok := scope.FieldByName(relationship.AssociationForeignDBNames[idx]); ok {
1080 tx = tx.Where(fmt.Sprintf("%v = ?", scope.Quote(foreignKey)), field.Field.Interface())
1084 if relationship.PolymorphicType != "" {
1085 tx = tx.Where(fmt.Sprintf("%v = ?", scope.Quote(relationship.PolymorphicDBName)), relationship.PolymorphicValue)
1087 scope.Err(tx.Find(value).Error)
1090 sql := fmt.Sprintf("%v = ?", scope.Quote(toScope.PrimaryKey()))
1091 scope.Err(tx.Where(sql, fromField.Field.Interface()).Find(value).Error)
1094 } else if toField != nil {
1095 sql := fmt.Sprintf("%v = ?", scope.Quote(toField.DBName))
1096 scope.Err(tx.Where(sql, scope.PrimaryKeyValue()).Find(value).Error)
1101 scope.Err(fmt.Errorf("invalid association %v", foreignKeys))
1105 // getTableOptions return the table options string or an empty string if the table options does not exist
1106 func (scope *Scope) getTableOptions() string {
1107 tableOptions, ok := scope.Get("gorm:table_options")
1111 return " " + tableOptions.(string)
1114 func (scope *Scope) createJoinTable(field *StructField) {
1115 if relationship := field.Relationship; relationship != nil && relationship.JoinTableHandler != nil {
1116 joinTableHandler := relationship.JoinTableHandler
1117 joinTable := joinTableHandler.Table(scope.db)
1118 if !scope.Dialect().HasTable(joinTable) {
1119 toScope := &Scope{Value: reflect.New(field.Struct.Type).Interface()}
1121 var sqlTypes, primaryKeys []string
1122 for idx, fieldName := range relationship.ForeignFieldNames {
1123 if field, ok := scope.FieldByName(fieldName); ok {
1124 foreignKeyStruct := field.clone()
1125 foreignKeyStruct.IsPrimaryKey = false
1126 foreignKeyStruct.TagSettingsSet("IS_JOINTABLE_FOREIGNKEY", "true")
1127 foreignKeyStruct.TagSettingsDelete("AUTO_INCREMENT")
1128 sqlTypes = append(sqlTypes, scope.Quote(relationship.ForeignDBNames[idx])+" "+scope.Dialect().DataTypeOf(foreignKeyStruct))
1129 primaryKeys = append(primaryKeys, scope.Quote(relationship.ForeignDBNames[idx]))
1133 for idx, fieldName := range relationship.AssociationForeignFieldNames {
1134 if field, ok := toScope.FieldByName(fieldName); ok {
1135 foreignKeyStruct := field.clone()
1136 foreignKeyStruct.IsPrimaryKey = false
1137 foreignKeyStruct.TagSettingsSet("IS_JOINTABLE_FOREIGNKEY", "true")
1138 foreignKeyStruct.TagSettingsDelete("AUTO_INCREMENT")
1139 sqlTypes = append(sqlTypes, scope.Quote(relationship.AssociationForeignDBNames[idx])+" "+scope.Dialect().DataTypeOf(foreignKeyStruct))
1140 primaryKeys = append(primaryKeys, scope.Quote(relationship.AssociationForeignDBNames[idx]))
1144 scope.Err(scope.NewDB().Exec(fmt.Sprintf("CREATE TABLE %v (%v, PRIMARY KEY (%v))%s", scope.Quote(joinTable), strings.Join(sqlTypes, ","), strings.Join(primaryKeys, ","), scope.getTableOptions())).Error)
1146 scope.NewDB().Table(joinTable).AutoMigrate(joinTableHandler)
1150 func (scope *Scope) createTable() *Scope {
1152 var primaryKeys []string
1153 var primaryKeyInColumnType = false
1154 for _, field := range scope.GetModelStruct().StructFields {
1156 sqlTag := scope.Dialect().DataTypeOf(field)
1158 // Check if the primary key constraint was specified as
1159 // part of the column type. If so, we can only support
1160 // one column as the primary key.
1161 if strings.Contains(strings.ToLower(sqlTag), "primary key") {
1162 primaryKeyInColumnType = true
1165 tags = append(tags, scope.Quote(field.DBName)+" "+sqlTag)
1168 if field.IsPrimaryKey {
1169 primaryKeys = append(primaryKeys, scope.Quote(field.DBName))
1171 scope.createJoinTable(field)
1174 var primaryKeyStr string
1175 if len(primaryKeys) > 0 && !primaryKeyInColumnType {
1176 primaryKeyStr = fmt.Sprintf(", PRIMARY KEY (%v)", strings.Join(primaryKeys, ","))
1179 scope.Raw(fmt.Sprintf("CREATE TABLE %v (%v %v)%s", scope.QuotedTableName(), strings.Join(tags, ","), primaryKeyStr, scope.getTableOptions())).Exec()
1185 func (scope *Scope) dropTable() *Scope {
1186 scope.Raw(fmt.Sprintf("DROP TABLE %v%s", scope.QuotedTableName(), scope.getTableOptions())).Exec()
1190 func (scope *Scope) modifyColumn(column string, typ string) {
1191 scope.db.AddError(scope.Dialect().ModifyColumn(scope.QuotedTableName(), scope.Quote(column), typ))
1194 func (scope *Scope) dropColumn(column string) {
1195 scope.Raw(fmt.Sprintf("ALTER TABLE %v DROP COLUMN %v", scope.QuotedTableName(), scope.Quote(column))).Exec()
1198 func (scope *Scope) addIndex(unique bool, indexName string, column ...string) {
1199 if scope.Dialect().HasIndex(scope.TableName(), indexName) {
1203 var columns []string
1204 for _, name := range column {
1205 columns = append(columns, scope.quoteIfPossible(name))
1208 sqlCreate := "CREATE INDEX"
1210 sqlCreate = "CREATE UNIQUE INDEX"
1213 scope.Raw(fmt.Sprintf("%s %v ON %v(%v) %v", sqlCreate, indexName, scope.QuotedTableName(), strings.Join(columns, ", "), scope.whereSQL())).Exec()
1216 func (scope *Scope) addForeignKey(field string, dest string, onDelete string, onUpdate string) {
1217 // Compatible with old generated key
1218 keyName := scope.Dialect().BuildKeyName(scope.TableName(), field, dest, "foreign")
1220 if scope.Dialect().HasForeignKey(scope.TableName(), keyName) {
1223 var query = `ALTER TABLE %s ADD CONSTRAINT %s FOREIGN KEY (%s) REFERENCES %s ON DELETE %s ON UPDATE %s;`
1224 scope.Raw(fmt.Sprintf(query, scope.QuotedTableName(), scope.quoteIfPossible(keyName), scope.quoteIfPossible(field), dest, onDelete, onUpdate)).Exec()
1227 func (scope *Scope) removeForeignKey(field string, dest string) {
1228 keyName := scope.Dialect().BuildKeyName(scope.TableName(), field, dest, "foreign")
1229 if !scope.Dialect().HasForeignKey(scope.TableName(), keyName) {
1234 if scope.Dialect().GetName() == mysql.GetName() {
1235 query = `ALTER TABLE %s DROP FOREIGN KEY %s;`
1237 query = `ALTER TABLE %s DROP CONSTRAINT %s;`
1240 scope.Raw(fmt.Sprintf(query, scope.QuotedTableName(), scope.quoteIfPossible(keyName))).Exec()
1243 func (scope *Scope) removeIndex(indexName string) {
1244 scope.Dialect().RemoveIndex(scope.TableName(), indexName)
1247 func (scope *Scope) autoMigrate() *Scope {
1248 tableName := scope.TableName()
1249 quotedTableName := scope.QuotedTableName()
1251 if !scope.Dialect().HasTable(tableName) {
1254 for _, field := range scope.GetModelStruct().StructFields {
1255 if !scope.Dialect().HasColumn(tableName, field.DBName) {
1257 sqlTag := scope.Dialect().DataTypeOf(field)
1258 scope.Raw(fmt.Sprintf("ALTER TABLE %v ADD %v %v;", quotedTableName, scope.Quote(field.DBName), sqlTag)).Exec()
1261 scope.createJoinTable(field)
1268 func (scope *Scope) autoIndex() *Scope {
1269 var indexes = map[string][]string{}
1270 var uniqueIndexes = map[string][]string{}
1272 for _, field := range scope.GetStructFields() {
1273 if name, ok := field.TagSettingsGet("INDEX"); ok {
1274 names := strings.Split(name, ",")
1276 for _, name := range names {
1277 if name == "INDEX" || name == "" {
1278 name = scope.Dialect().BuildKeyName("idx", scope.TableName(), field.DBName)
1280 indexes[name] = append(indexes[name], field.DBName)
1284 if name, ok := field.TagSettingsGet("UNIQUE_INDEX"); ok {
1285 names := strings.Split(name, ",")
1287 for _, name := range names {
1288 if name == "UNIQUE_INDEX" || name == "" {
1289 name = scope.Dialect().BuildKeyName("uix", scope.TableName(), field.DBName)
1291 uniqueIndexes[name] = append(uniqueIndexes[name], field.DBName)
1296 for name, columns := range indexes {
1297 if db := scope.NewDB().Table(scope.TableName()).Model(scope.Value).AddIndex(name, columns...); db.Error != nil {
1298 scope.db.AddError(db.Error)
1302 for name, columns := range uniqueIndexes {
1303 if db := scope.NewDB().Table(scope.TableName()).Model(scope.Value).AddUniqueIndex(name, columns...); db.Error != nil {
1304 scope.db.AddError(db.Error)
1311 func (scope *Scope) getColumnAsArray(columns []string, values ...interface{}) (results [][]interface{}) {
1312 for _, value := range values {
1313 indirectValue := indirect(reflect.ValueOf(value))
1315 switch indirectValue.Kind() {
1317 for i := 0; i < indirectValue.Len(); i++ {
1318 var result []interface{}
1319 var object = indirect(indirectValue.Index(i))
1320 var hasValue = false
1321 for _, column := range columns {
1322 field := object.FieldByName(column)
1323 if hasValue || !isBlank(field) {
1326 result = append(result, field.Interface())
1330 results = append(results, result)
1333 case reflect.Struct:
1334 var result []interface{}
1335 var hasValue = false
1336 for _, column := range columns {
1337 field := indirectValue.FieldByName(column)
1338 if hasValue || !isBlank(field) {
1341 result = append(result, field.Interface())
1345 results = append(results, result)
1353 func (scope *Scope) getColumnAsScope(column string) *Scope {
1354 indirectScopeValue := scope.IndirectValue()
1356 switch indirectScopeValue.Kind() {
1358 if fieldStruct, ok := scope.GetModelStruct().ModelType.FieldByName(column); ok {
1359 fieldType := fieldStruct.Type
1360 if fieldType.Kind() == reflect.Slice || fieldType.Kind() == reflect.Ptr {
1361 fieldType = fieldType.Elem()
1364 resultsMap := map[interface{}]bool{}
1365 results := reflect.New(reflect.SliceOf(reflect.PtrTo(fieldType))).Elem()
1367 for i := 0; i < indirectScopeValue.Len(); i++ {
1368 result := indirect(indirect(indirectScopeValue.Index(i)).FieldByName(column))
1370 if result.Kind() == reflect.Slice {
1371 for j := 0; j < result.Len(); j++ {
1372 if elem := result.Index(j); elem.CanAddr() && resultsMap[elem.Addr()] != true {
1373 resultsMap[elem.Addr()] = true
1374 results = reflect.Append(results, elem.Addr())
1377 } else if result.CanAddr() && resultsMap[result.Addr()] != true {
1378 resultsMap[result.Addr()] = true
1379 results = reflect.Append(results, result.Addr())
1382 return scope.New(results.Interface())
1384 case reflect.Struct:
1385 if field := indirectScopeValue.FieldByName(column); field.CanAddr() {
1386 return scope.New(field.Addr().Interface())
1392 func (scope *Scope) hasConditions() bool {
1393 return !scope.PrimaryKeyZero() ||
1394 len(scope.Search.whereConditions) > 0 ||
1395 len(scope.Search.orConditions) > 0 ||
1396 len(scope.Search.notConditions) > 0