statement.go 34 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249
  1. // Copyright 2015 The Xorm Authors. All rights reserved.
  2. // Use of this source code is governed by a BSD-style
  3. // license that can be found in the LICENSE file.
  4. package xorm
  5. import (
  6. "bytes"
  7. "database/sql/driver"
  8. "encoding/json"
  9. "errors"
  10. "fmt"
  11. "reflect"
  12. "strings"
  13. "time"
  14. "github.com/go-xorm/builder"
  15. "github.com/xormplus/core"
  16. )
  17. type incrParam struct {
  18. colName string
  19. arg interface{}
  20. }
  21. type decrParam struct {
  22. colName string
  23. arg interface{}
  24. }
  25. type exprParam struct {
  26. colName string
  27. expr string
  28. }
  29. // Statement save all the sql info for executing SQL
  30. type Statement struct {
  31. RefTable *core.Table
  32. Engine *Engine
  33. Start int
  34. LimitN int
  35. idParam *core.PK
  36. OrderStr string
  37. JoinStr string
  38. joinArgs []interface{}
  39. GroupByStr string
  40. HavingStr string
  41. ColumnStr string
  42. selectStr string
  43. columnMap map[string]bool
  44. useAllCols bool
  45. OmitStr string
  46. AltTableName string
  47. tableName string
  48. RawSQL string
  49. RawParams []interface{}
  50. UseCascade bool
  51. UseAutoJoin bool
  52. StoreEngine string
  53. Charset string
  54. UseCache bool
  55. UseAutoTime bool
  56. noAutoCondition bool
  57. IsDistinct bool
  58. IsForUpdate bool
  59. TableAlias string
  60. allUseBool bool
  61. checkVersion bool
  62. unscoped bool
  63. mustColumnMap map[string]bool
  64. nullableMap map[string]bool
  65. incrColumns map[string]incrParam
  66. decrColumns map[string]decrParam
  67. exprColumns map[string]exprParam
  68. cond builder.Cond
  69. }
  70. // Init reset all the statement's fields
  71. func (statement *Statement) Init() {
  72. statement.RefTable = nil
  73. statement.Start = 0
  74. statement.LimitN = 0
  75. statement.OrderStr = ""
  76. statement.UseCascade = true
  77. statement.JoinStr = ""
  78. statement.joinArgs = make([]interface{}, 0)
  79. statement.GroupByStr = ""
  80. statement.HavingStr = ""
  81. statement.ColumnStr = ""
  82. statement.OmitStr = ""
  83. statement.columnMap = make(map[string]bool)
  84. statement.AltTableName = ""
  85. statement.tableName = ""
  86. statement.idParam = nil
  87. statement.RawSQL = ""
  88. statement.RawParams = make([]interface{}, 0)
  89. statement.UseCache = true
  90. statement.UseAutoTime = true
  91. statement.noAutoCondition = false
  92. statement.IsDistinct = false
  93. statement.IsForUpdate = false
  94. statement.TableAlias = ""
  95. statement.selectStr = ""
  96. statement.allUseBool = false
  97. statement.useAllCols = false
  98. statement.mustColumnMap = make(map[string]bool)
  99. statement.nullableMap = make(map[string]bool)
  100. statement.checkVersion = true
  101. statement.unscoped = false
  102. statement.incrColumns = make(map[string]incrParam)
  103. statement.decrColumns = make(map[string]decrParam)
  104. statement.exprColumns = make(map[string]exprParam)
  105. statement.cond = builder.NewCond()
  106. }
  107. // NoAutoCondition if you do not want convert bean's field as query condition, then use this function
  108. func (statement *Statement) NoAutoCondition(no ...bool) *Statement {
  109. statement.noAutoCondition = true
  110. if len(no) > 0 {
  111. statement.noAutoCondition = no[0]
  112. }
  113. return statement
  114. }
  115. // Alias set the table alias
  116. func (statement *Statement) Alias(alias string) *Statement {
  117. statement.TableAlias = alias
  118. return statement
  119. }
  120. // SQL adds raw sql statement
  121. func (statement *Statement) SQL(query interface{}, args ...interface{}) *Statement {
  122. switch query.(type) {
  123. case (*builder.Builder):
  124. var err error
  125. statement.RawSQL, statement.RawParams, err = query.(*builder.Builder).ToSQL()
  126. if err != nil {
  127. statement.Engine.logger.Error(err)
  128. }
  129. case string:
  130. statement.RawSQL = query.(string)
  131. statement.RawParams = args
  132. default:
  133. statement.Engine.logger.Error("unsupported sql type")
  134. }
  135. return statement
  136. }
  137. // Where add Where statement
  138. func (statement *Statement) Where(query interface{}, args ...interface{}) *Statement {
  139. return statement.And(query, args...)
  140. }
  141. // And add Where & and statement
  142. func (statement *Statement) And(query interface{}, args ...interface{}) *Statement {
  143. switch query.(type) {
  144. case string:
  145. cond := builder.Expr(query.(string), args...)
  146. statement.cond = statement.cond.And(cond)
  147. case builder.Cond:
  148. cond := query.(builder.Cond)
  149. statement.cond = statement.cond.And(cond)
  150. for _, v := range args {
  151. if vv, ok := v.(builder.Cond); ok {
  152. statement.cond = statement.cond.And(vv)
  153. }
  154. }
  155. default:
  156. // TODO: not support condition type
  157. }
  158. return statement
  159. }
  160. // Or add Where & Or statement
  161. func (statement *Statement) Or(query interface{}, args ...interface{}) *Statement {
  162. switch query.(type) {
  163. case string:
  164. cond := builder.Expr(query.(string), args...)
  165. statement.cond = statement.cond.Or(cond)
  166. case builder.Cond:
  167. cond := query.(builder.Cond)
  168. statement.cond = statement.cond.Or(cond)
  169. for _, v := range args {
  170. if vv, ok := v.(builder.Cond); ok {
  171. statement.cond = statement.cond.Or(vv)
  172. }
  173. }
  174. default:
  175. // TODO: not support condition type
  176. }
  177. return statement
  178. }
  179. // In generate "Where column IN (?) " statement
  180. func (statement *Statement) In(column string, args ...interface{}) *Statement {
  181. in := builder.In(statement.Engine.Quote(column), args...)
  182. statement.cond = statement.cond.And(in)
  183. return statement
  184. }
  185. // NotIn generate "Where column NOT IN (?) " statement
  186. func (statement *Statement) NotIn(column string, args ...interface{}) *Statement {
  187. notIn := builder.NotIn(statement.Engine.Quote(column), args...)
  188. statement.cond = statement.cond.And(notIn)
  189. return statement
  190. }
  191. func (statement *Statement) setRefValue(v reflect.Value) error {
  192. var err error
  193. statement.RefTable, err = statement.Engine.autoMapType(reflect.Indirect(v))
  194. if err != nil {
  195. return err
  196. }
  197. statement.tableName = statement.Engine.tbName(v)
  198. return nil
  199. }
  200. // Table tempororily set table name, the parameter could be a string or a pointer of struct
  201. func (statement *Statement) Table(tableNameOrBean interface{}) *Statement {
  202. v := rValue(tableNameOrBean)
  203. t := v.Type()
  204. if t.Kind() == reflect.String {
  205. statement.AltTableName = tableNameOrBean.(string)
  206. } else if t.Kind() == reflect.Struct {
  207. var err error
  208. statement.RefTable, err = statement.Engine.autoMapType(v)
  209. if err != nil {
  210. statement.Engine.logger.Error(err)
  211. return statement
  212. }
  213. statement.AltTableName = statement.Engine.tbName(v)
  214. }
  215. return statement
  216. }
  217. // Auto generating update columnes and values according a struct
  218. func buildUpdates(engine *Engine, table *core.Table, bean interface{},
  219. includeVersion bool, includeUpdated bool, includeNil bool,
  220. includeAutoIncr bool, allUseBool bool, useAllCols bool,
  221. mustColumnMap map[string]bool, nullableMap map[string]bool,
  222. columnMap map[string]bool, update, unscoped bool) ([]string, []interface{}) {
  223. var colNames = make([]string, 0)
  224. var args = make([]interface{}, 0)
  225. for _, col := range table.Columns() {
  226. if !includeVersion && col.IsVersion {
  227. continue
  228. }
  229. if col.IsCreated {
  230. continue
  231. }
  232. if !includeUpdated && col.IsUpdated {
  233. continue
  234. }
  235. if !includeAutoIncr && col.IsAutoIncrement {
  236. continue
  237. }
  238. if col.IsDeleted && !unscoped {
  239. continue
  240. }
  241. if use, ok := columnMap[strings.ToLower(col.Name)]; ok && !use {
  242. continue
  243. }
  244. fieldValuePtr, err := col.ValueOf(bean)
  245. if err != nil {
  246. engine.logger.Error(err)
  247. continue
  248. }
  249. fieldValue := *fieldValuePtr
  250. fieldType := reflect.TypeOf(fieldValue.Interface())
  251. requiredField := useAllCols
  252. includeNil := useAllCols
  253. if b, ok := getFlagForColumn(mustColumnMap, col); ok {
  254. if b {
  255. requiredField = true
  256. } else {
  257. continue
  258. }
  259. }
  260. // !evalphobia! set fieldValue as nil when column is nullable and zero-value
  261. if b, ok := getFlagForColumn(nullableMap, col); ok {
  262. if b && col.Nullable && isZero(fieldValue.Interface()) {
  263. var nilValue *int
  264. fieldValue = reflect.ValueOf(nilValue)
  265. fieldType = reflect.TypeOf(fieldValue.Interface())
  266. includeNil = true
  267. }
  268. }
  269. var val interface{}
  270. if fieldValue.CanAddr() {
  271. if structConvert, ok := fieldValue.Addr().Interface().(core.Conversion); ok {
  272. data, err := structConvert.ToDB()
  273. if err != nil {
  274. engine.logger.Error(err)
  275. } else {
  276. val = data
  277. }
  278. goto APPEND
  279. }
  280. }
  281. if structConvert, ok := fieldValue.Interface().(core.Conversion); ok {
  282. data, err := structConvert.ToDB()
  283. if err != nil {
  284. engine.logger.Error(err)
  285. } else {
  286. val = data
  287. }
  288. goto APPEND
  289. }
  290. if fieldType.Kind() == reflect.Ptr {
  291. if fieldValue.IsNil() {
  292. if includeNil {
  293. args = append(args, nil)
  294. colNames = append(colNames, fmt.Sprintf("%v=?", engine.Quote(col.Name)))
  295. }
  296. continue
  297. } else if !fieldValue.IsValid() {
  298. continue
  299. } else {
  300. // dereference ptr type to instance type
  301. fieldValue = fieldValue.Elem()
  302. fieldType = reflect.TypeOf(fieldValue.Interface())
  303. requiredField = true
  304. }
  305. }
  306. switch fieldType.Kind() {
  307. case reflect.Bool:
  308. if allUseBool || requiredField {
  309. val = fieldValue.Interface()
  310. } else {
  311. // if a bool in a struct, it will not be as a condition because it default is false,
  312. // please use Where() instead
  313. continue
  314. }
  315. case reflect.String:
  316. if !requiredField && fieldValue.String() == "" {
  317. continue
  318. }
  319. // for MyString, should convert to string or panic
  320. if fieldType.String() != reflect.String.String() {
  321. val = fieldValue.String()
  322. } else {
  323. val = fieldValue.Interface()
  324. }
  325. case reflect.Int8, reflect.Int16, reflect.Int, reflect.Int32, reflect.Int64:
  326. if !requiredField && fieldValue.Int() == 0 {
  327. continue
  328. }
  329. val = fieldValue.Interface()
  330. case reflect.Float32, reflect.Float64:
  331. if !requiredField && fieldValue.Float() == 0.0 {
  332. continue
  333. }
  334. val = fieldValue.Interface()
  335. case reflect.Uint8, reflect.Uint16, reflect.Uint, reflect.Uint32, reflect.Uint64:
  336. if !requiredField && fieldValue.Uint() == 0 {
  337. continue
  338. }
  339. t := int64(fieldValue.Uint())
  340. val = reflect.ValueOf(&t).Interface()
  341. case reflect.Struct:
  342. if fieldType.ConvertibleTo(core.TimeType) {
  343. t := fieldValue.Convert(core.TimeType).Interface().(time.Time)
  344. if !requiredField && (t.IsZero() || !fieldValue.IsValid()) {
  345. continue
  346. }
  347. val = engine.formatColTime(col, t)
  348. } else if nulType, ok := fieldValue.Interface().(driver.Valuer); ok {
  349. val, _ = nulType.Value()
  350. } else {
  351. if !col.SQLType.IsJson() {
  352. engine.autoMapType(fieldValue)
  353. if table, ok := engine.Tables[fieldValue.Type()]; ok {
  354. if len(table.PrimaryKeys) == 1 {
  355. pkField := reflect.Indirect(fieldValue).FieldByName(table.PKColumns()[0].FieldName)
  356. // fix non-int pk issues
  357. if pkField.IsValid() && (!requiredField && !isZero(pkField.Interface())) {
  358. val = pkField.Interface()
  359. } else {
  360. continue
  361. }
  362. } else {
  363. //TODO: how to handler?
  364. panic("not supported")
  365. }
  366. } else {
  367. val = fieldValue.Interface()
  368. }
  369. } else {
  370. // Blank struct could not be as update data
  371. if requiredField || !isStructZero(fieldValue) {
  372. bytes, err := json.Marshal(fieldValue.Interface())
  373. if err != nil {
  374. panic(fmt.Sprintf("mashal %v failed", fieldValue.Interface()))
  375. }
  376. if col.SQLType.IsText() {
  377. val = string(bytes)
  378. } else if col.SQLType.IsBlob() {
  379. val = bytes
  380. }
  381. } else {
  382. continue
  383. }
  384. }
  385. }
  386. case reflect.Array, reflect.Slice, reflect.Map:
  387. if !requiredField {
  388. if fieldValue == reflect.Zero(fieldType) {
  389. continue
  390. }
  391. if fieldType.Kind() == reflect.Array {
  392. if isArrayValueZero(fieldValue) {
  393. continue
  394. }
  395. } else if fieldValue.IsNil() || !fieldValue.IsValid() || fieldValue.Len() == 0 {
  396. continue
  397. }
  398. }
  399. if col.SQLType.IsText() {
  400. bytes, err := json.Marshal(fieldValue.Interface())
  401. if err != nil {
  402. engine.logger.Error(err)
  403. continue
  404. }
  405. val = string(bytes)
  406. } else if col.SQLType.IsBlob() {
  407. var bytes []byte
  408. var err error
  409. if fieldType.Kind() == reflect.Slice &&
  410. fieldType.Elem().Kind() == reflect.Uint8 {
  411. if fieldValue.Len() > 0 {
  412. val = fieldValue.Bytes()
  413. } else {
  414. continue
  415. }
  416. } else if fieldType.Kind() == reflect.Array &&
  417. fieldType.Elem().Kind() == reflect.Uint8 {
  418. val = fieldValue.Slice(0, 0).Interface()
  419. } else {
  420. bytes, err = json.Marshal(fieldValue.Interface())
  421. if err != nil {
  422. engine.logger.Error(err)
  423. continue
  424. }
  425. val = bytes
  426. }
  427. } else {
  428. continue
  429. }
  430. default:
  431. val = fieldValue.Interface()
  432. }
  433. APPEND:
  434. args = append(args, val)
  435. if col.IsPrimaryKey && engine.dialect.DBType() == "ql" {
  436. continue
  437. }
  438. colNames = append(colNames, fmt.Sprintf("%v = ?", engine.Quote(col.Name)))
  439. }
  440. return colNames, args
  441. }
  442. func (statement *Statement) needTableName() bool {
  443. return len(statement.JoinStr) > 0
  444. }
  445. func (statement *Statement) colName(col *core.Column, tableName string) string {
  446. if statement.needTableName() {
  447. var nm = tableName
  448. if len(statement.TableAlias) > 0 {
  449. nm = statement.TableAlias
  450. }
  451. return statement.Engine.Quote(nm) + "." + statement.Engine.Quote(col.Name)
  452. }
  453. return statement.Engine.Quote(col.Name)
  454. }
  455. // TableName return current tableName
  456. func (statement *Statement) TableName() string {
  457. if statement.AltTableName != "" {
  458. return statement.AltTableName
  459. }
  460. return statement.tableName
  461. }
  462. // ID generate "where id = ? " statement or for composite key "where key1 = ? and key2 = ?"
  463. func (statement *Statement) ID(id interface{}) *Statement {
  464. idValue := reflect.ValueOf(id)
  465. idType := reflect.TypeOf(idValue.Interface())
  466. switch idType {
  467. case ptrPkType:
  468. if pkPtr, ok := (id).(*core.PK); ok {
  469. statement.idParam = pkPtr
  470. return statement
  471. }
  472. case pkType:
  473. if pk, ok := (id).(core.PK); ok {
  474. statement.idParam = &pk
  475. return statement
  476. }
  477. }
  478. switch idType.Kind() {
  479. case reflect.String:
  480. statement.idParam = &core.PK{idValue.Convert(reflect.TypeOf("")).Interface()}
  481. return statement
  482. }
  483. statement.idParam = &core.PK{id}
  484. return statement
  485. }
  486. // Incr Generate "Update ... Set column = column + arg" statement
  487. func (statement *Statement) Incr(column string, arg ...interface{}) *Statement {
  488. k := strings.ToLower(column)
  489. if len(arg) > 0 {
  490. statement.incrColumns[k] = incrParam{column, arg[0]}
  491. } else {
  492. statement.incrColumns[k] = incrParam{column, 1}
  493. }
  494. return statement
  495. }
  496. // Decr Generate "Update ... Set column = column - arg" statement
  497. func (statement *Statement) Decr(column string, arg ...interface{}) *Statement {
  498. k := strings.ToLower(column)
  499. if len(arg) > 0 {
  500. statement.decrColumns[k] = decrParam{column, arg[0]}
  501. } else {
  502. statement.decrColumns[k] = decrParam{column, 1}
  503. }
  504. return statement
  505. }
  506. // SetExpr Generate "Update ... Set column = {expression}" statement
  507. func (statement *Statement) SetExpr(column string, expression string) *Statement {
  508. k := strings.ToLower(column)
  509. statement.exprColumns[k] = exprParam{column, expression}
  510. return statement
  511. }
  512. // Generate "Update ... Set column = column + arg" statement
  513. func (statement *Statement) getInc() map[string]incrParam {
  514. return statement.incrColumns
  515. }
  516. // Generate "Update ... Set column = column - arg" statement
  517. func (statement *Statement) getDec() map[string]decrParam {
  518. return statement.decrColumns
  519. }
  520. // Generate "Update ... Set column = {expression}" statement
  521. func (statement *Statement) getExpr() map[string]exprParam {
  522. return statement.exprColumns
  523. }
  524. func (statement *Statement) col2NewColsWithQuote(columns ...string) []string {
  525. newColumns := make([]string, 0)
  526. for _, col := range columns {
  527. col = strings.Replace(col, "`", "", -1)
  528. col = strings.Replace(col, statement.Engine.QuoteStr(), "", -1)
  529. ccols := strings.Split(col, ",")
  530. for _, c := range ccols {
  531. fields := strings.Split(strings.TrimSpace(c), ".")
  532. if len(fields) == 1 {
  533. newColumns = append(newColumns, statement.Engine.quote(fields[0]))
  534. } else if len(fields) == 2 {
  535. newColumns = append(newColumns, statement.Engine.quote(fields[0])+"."+
  536. statement.Engine.quote(fields[1]))
  537. } else {
  538. panic(errors.New("unwanted colnames"))
  539. }
  540. }
  541. }
  542. return newColumns
  543. }
  544. func (statement *Statement) colmap2NewColsWithQuote() []string {
  545. newColumns := make([]string, 0, len(statement.columnMap))
  546. for col := range statement.columnMap {
  547. fields := strings.Split(strings.TrimSpace(col), ".")
  548. if len(fields) == 1 {
  549. newColumns = append(newColumns, statement.Engine.quote(fields[0]))
  550. } else if len(fields) == 2 {
  551. newColumns = append(newColumns, statement.Engine.quote(fields[0])+"."+
  552. statement.Engine.quote(fields[1]))
  553. } else {
  554. panic(errors.New("unwanted colnames"))
  555. }
  556. }
  557. return newColumns
  558. }
  559. // Distinct generates "DISTINCT col1, col2 " statement
  560. func (statement *Statement) Distinct(columns ...string) *Statement {
  561. statement.IsDistinct = true
  562. statement.Cols(columns...)
  563. return statement
  564. }
  565. // ForUpdate generates "SELECT ... FOR UPDATE" statement
  566. func (statement *Statement) ForUpdate() *Statement {
  567. statement.IsForUpdate = true
  568. return statement
  569. }
  570. // Select replace select
  571. func (statement *Statement) Select(str string) *Statement {
  572. statement.selectStr = str
  573. return statement
  574. }
  575. // Cols generate "col1, col2" statement
  576. func (statement *Statement) Cols(columns ...string) *Statement {
  577. cols := col2NewCols(columns...)
  578. for _, nc := range cols {
  579. statement.columnMap[strings.ToLower(nc)] = true
  580. }
  581. newColumns := statement.colmap2NewColsWithQuote()
  582. statement.ColumnStr = strings.Join(newColumns, ", ")
  583. statement.ColumnStr = strings.Replace(statement.ColumnStr, statement.Engine.quote("*"), "*", -1)
  584. return statement
  585. }
  586. // AllCols update use only: update all columns
  587. func (statement *Statement) AllCols() *Statement {
  588. statement.useAllCols = true
  589. return statement
  590. }
  591. // MustCols update use only: must update columns
  592. func (statement *Statement) MustCols(columns ...string) *Statement {
  593. newColumns := col2NewCols(columns...)
  594. for _, nc := range newColumns {
  595. statement.mustColumnMap[strings.ToLower(nc)] = true
  596. }
  597. return statement
  598. }
  599. // UseBool indicates that use bool fields as update contents and query contiditions
  600. func (statement *Statement) UseBool(columns ...string) *Statement {
  601. if len(columns) > 0 {
  602. statement.MustCols(columns...)
  603. } else {
  604. statement.allUseBool = true
  605. }
  606. return statement
  607. }
  608. // Omit do not use the columns
  609. func (statement *Statement) Omit(columns ...string) {
  610. newColumns := col2NewCols(columns...)
  611. for _, nc := range newColumns {
  612. statement.columnMap[strings.ToLower(nc)] = false
  613. }
  614. statement.OmitStr = statement.Engine.Quote(strings.Join(newColumns, statement.Engine.Quote(", ")))
  615. }
  616. // Nullable Update use only: update columns to null when value is nullable and zero-value
  617. func (statement *Statement) Nullable(columns ...string) {
  618. newColumns := col2NewCols(columns...)
  619. for _, nc := range newColumns {
  620. statement.nullableMap[strings.ToLower(nc)] = true
  621. }
  622. }
  623. // Top generate LIMIT limit statement
  624. func (statement *Statement) Top(limit int) *Statement {
  625. statement.Limit(limit)
  626. return statement
  627. }
  628. // Limit generate LIMIT start, limit statement
  629. func (statement *Statement) Limit(limit int, start ...int) *Statement {
  630. statement.LimitN = limit
  631. if len(start) > 0 {
  632. statement.Start = start[0]
  633. }
  634. return statement
  635. }
  636. // OrderBy generate "Order By order" statement
  637. func (statement *Statement) OrderBy(order string) *Statement {
  638. if len(statement.OrderStr) > 0 {
  639. statement.OrderStr += ", "
  640. }
  641. statement.OrderStr += order
  642. return statement
  643. }
  644. // Desc generate `ORDER BY xx DESC`
  645. func (statement *Statement) Desc(colNames ...string) *Statement {
  646. var buf bytes.Buffer
  647. fmt.Fprintf(&buf, statement.OrderStr)
  648. if len(statement.OrderStr) > 0 {
  649. fmt.Fprint(&buf, ", ")
  650. }
  651. newColNames := statement.col2NewColsWithQuote(colNames...)
  652. fmt.Fprintf(&buf, "%v DESC", strings.Join(newColNames, " DESC, "))
  653. statement.OrderStr = buf.String()
  654. return statement
  655. }
  656. // Asc provide asc order by query condition, the input parameters are columns.
  657. func (statement *Statement) Asc(colNames ...string) *Statement {
  658. var buf bytes.Buffer
  659. fmt.Fprintf(&buf, statement.OrderStr)
  660. if len(statement.OrderStr) > 0 {
  661. fmt.Fprint(&buf, ", ")
  662. }
  663. newColNames := statement.col2NewColsWithQuote(colNames...)
  664. fmt.Fprintf(&buf, "%v ASC", strings.Join(newColNames, " ASC, "))
  665. statement.OrderStr = buf.String()
  666. return statement
  667. }
  668. // Join The joinOP should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN
  669. func (statement *Statement) Join(joinOP string, tablename interface{}, condition string, args ...interface{}) *Statement {
  670. var buf bytes.Buffer
  671. if len(statement.JoinStr) > 0 {
  672. fmt.Fprintf(&buf, "%v %v JOIN ", statement.JoinStr, joinOP)
  673. } else {
  674. fmt.Fprintf(&buf, "%v JOIN ", joinOP)
  675. }
  676. switch tablename.(type) {
  677. case []string:
  678. t := tablename.([]string)
  679. if len(t) > 1 {
  680. fmt.Fprintf(&buf, "%v AS %v", statement.Engine.Quote(t[0]), statement.Engine.Quote(t[1]))
  681. } else if len(t) == 1 {
  682. fmt.Fprintf(&buf, statement.Engine.Quote(t[0]))
  683. }
  684. case []interface{}:
  685. t := tablename.([]interface{})
  686. l := len(t)
  687. var table string
  688. if l > 0 {
  689. f := t[0]
  690. v := rValue(f)
  691. t := v.Type()
  692. if t.Kind() == reflect.String {
  693. table = f.(string)
  694. } else if t.Kind() == reflect.Struct {
  695. table = statement.Engine.tbName(v)
  696. }
  697. }
  698. if l > 1 {
  699. fmt.Fprintf(&buf, "%v AS %v", statement.Engine.Quote(table),
  700. statement.Engine.Quote(fmt.Sprintf("%v", t[1])))
  701. } else if l == 1 {
  702. fmt.Fprintf(&buf, statement.Engine.Quote(table))
  703. }
  704. default:
  705. fmt.Fprintf(&buf, statement.Engine.Quote(fmt.Sprintf("%v", tablename)))
  706. }
  707. fmt.Fprintf(&buf, " ON %v", condition)
  708. statement.JoinStr = buf.String()
  709. statement.joinArgs = append(statement.joinArgs, args...)
  710. return statement
  711. }
  712. // GroupBy generate "Group By keys" statement
  713. func (statement *Statement) GroupBy(keys string) *Statement {
  714. statement.GroupByStr = keys
  715. return statement
  716. }
  717. // Having generate "Having conditions" statement
  718. func (statement *Statement) Having(conditions string) *Statement {
  719. statement.HavingStr = fmt.Sprintf("HAVING %v", conditions)
  720. return statement
  721. }
  722. // Unscoped always disable struct tag "deleted"
  723. func (statement *Statement) Unscoped() *Statement {
  724. statement.unscoped = true
  725. return statement
  726. }
  727. func (statement *Statement) genColumnStr() string {
  728. var buf bytes.Buffer
  729. if statement.RefTable == nil {
  730. return ""
  731. }
  732. columns := statement.RefTable.Columns()
  733. for _, col := range columns {
  734. if statement.OmitStr != "" {
  735. if _, ok := getFlagForColumn(statement.columnMap, col); ok {
  736. continue
  737. }
  738. }
  739. if col.MapType == core.ONLYTODB {
  740. continue
  741. }
  742. if buf.Len() != 0 {
  743. buf.WriteString(", ")
  744. }
  745. if col.IsPrimaryKey && statement.Engine.Dialect().DBType() == "ql" {
  746. buf.WriteString("id() AS ")
  747. }
  748. if statement.JoinStr != "" {
  749. if statement.TableAlias != "" {
  750. buf.WriteString(statement.TableAlias)
  751. } else {
  752. buf.WriteString(statement.TableName())
  753. }
  754. buf.WriteString(".")
  755. }
  756. statement.Engine.QuoteTo(&buf, col.Name)
  757. }
  758. return buf.String()
  759. }
  760. func (statement *Statement) genCreateTableSQL() string {
  761. return statement.Engine.dialect.CreateTableSql(statement.RefTable, statement.TableName(),
  762. statement.StoreEngine, statement.Charset)
  763. }
  764. func (statement *Statement) genIndexSQL() []string {
  765. var sqls []string
  766. tbName := statement.TableName()
  767. quote := statement.Engine.Quote
  768. for idxName, index := range statement.RefTable.Indexes {
  769. if index.Type == core.IndexType {
  770. sql := fmt.Sprintf("CREATE INDEX %v ON %v (%v);", quote(indexName(tbName, idxName)),
  771. quote(tbName), quote(strings.Join(index.Cols, quote(","))))
  772. sqls = append(sqls, sql)
  773. }
  774. }
  775. return sqls
  776. }
  777. func uniqueName(tableName, uqeName string) string {
  778. return fmt.Sprintf("UQE_%v_%v", tableName, uqeName)
  779. }
  780. func (statement *Statement) genUniqueSQL() []string {
  781. var sqls []string
  782. tbName := statement.TableName()
  783. for _, index := range statement.RefTable.Indexes {
  784. if index.Type == core.UniqueType {
  785. sql := statement.Engine.dialect.CreateIndexSql(tbName, index)
  786. sqls = append(sqls, sql)
  787. }
  788. }
  789. return sqls
  790. }
  791. func (statement *Statement) genDelIndexSQL() []string {
  792. var sqls []string
  793. tbName := statement.TableName()
  794. for idxName, index := range statement.RefTable.Indexes {
  795. var rIdxName string
  796. if index.Type == core.UniqueType {
  797. rIdxName = uniqueName(tbName, idxName)
  798. } else if index.Type == core.IndexType {
  799. rIdxName = indexName(tbName, idxName)
  800. }
  801. sql := fmt.Sprintf("DROP INDEX %v", statement.Engine.Quote(rIdxName))
  802. if statement.Engine.dialect.IndexOnTable() {
  803. sql += fmt.Sprintf(" ON %v", statement.Engine.Quote(statement.TableName()))
  804. }
  805. sqls = append(sqls, sql)
  806. }
  807. return sqls
  808. }
  809. func (statement *Statement) genAddColumnStr(col *core.Column) (string, []interface{}) {
  810. quote := statement.Engine.Quote
  811. sql := fmt.Sprintf("ALTER TABLE %v ADD %v;", quote(statement.TableName()),
  812. col.String(statement.Engine.dialect))
  813. return sql, []interface{}{}
  814. }
  815. func (statement *Statement) buildConds(table *core.Table, bean interface{}, includeVersion bool, includeUpdated bool, includeNil bool, includeAutoIncr bool, addedTableName bool) (builder.Cond, error) {
  816. return statement.Engine.buildConds(table, bean, includeVersion, includeUpdated, includeNil, includeAutoIncr, statement.allUseBool, statement.useAllCols,
  817. statement.unscoped, statement.mustColumnMap, statement.TableName(), statement.TableAlias, addedTableName)
  818. }
  819. func (statement *Statement) mergeConds(bean interface{}) error {
  820. if !statement.noAutoCondition {
  821. var addedTableName = (len(statement.JoinStr) > 0)
  822. autoCond, err := statement.buildConds(statement.RefTable, bean, true, true, false, true, addedTableName)
  823. if err != nil {
  824. return err
  825. }
  826. statement.cond = statement.cond.And(autoCond)
  827. }
  828. if err := statement.processIDParam(); err != nil {
  829. return err
  830. }
  831. return nil
  832. }
  833. func (statement *Statement) genConds(bean interface{}) (string, []interface{}, error) {
  834. if err := statement.mergeConds(bean); err != nil {
  835. return "", nil, err
  836. }
  837. return builder.ToSQL(statement.cond)
  838. }
  839. func (statement *Statement) genGetSQL(bean interface{}) (string, []interface{}, error) {
  840. v := rValue(bean)
  841. isStruct := v.Kind() == reflect.Struct
  842. if isStruct {
  843. statement.setRefValue(v)
  844. }
  845. var columnStr = statement.ColumnStr
  846. if len(statement.selectStr) > 0 {
  847. columnStr = statement.selectStr
  848. } else {
  849. // TODO: always generate column names, not use * even if join
  850. if len(statement.JoinStr) == 0 {
  851. if len(columnStr) == 0 {
  852. if len(statement.GroupByStr) > 0 {
  853. columnStr = statement.Engine.Quote(strings.Replace(statement.GroupByStr, ",", statement.Engine.Quote(","), -1))
  854. } else {
  855. columnStr = statement.genColumnStr()
  856. }
  857. }
  858. } else {
  859. if len(columnStr) == 0 {
  860. if len(statement.GroupByStr) > 0 {
  861. columnStr = statement.Engine.Quote(strings.Replace(statement.GroupByStr, ",", statement.Engine.Quote(","), -1))
  862. }
  863. }
  864. }
  865. }
  866. if len(columnStr) == 0 {
  867. columnStr = "*"
  868. }
  869. if isStruct {
  870. if err := statement.mergeConds(bean); err != nil {
  871. return "", nil, err
  872. }
  873. }
  874. condSQL, condArgs, err := builder.ToSQL(statement.cond)
  875. if err != nil {
  876. return "", nil, err
  877. }
  878. sqlStr, err := statement.genSelectSQL(columnStr, condSQL)
  879. if err != nil {
  880. return "", nil, err
  881. }
  882. return sqlStr, append(statement.joinArgs, condArgs...), nil
  883. }
  884. func (statement *Statement) genCountSQL(beans ...interface{}) (string, []interface{}, error) {
  885. var condSQL string
  886. var condArgs []interface{}
  887. var err error
  888. if len(beans) > 0 {
  889. statement.setRefValue(rValue(beans[0]))
  890. condSQL, condArgs, err = statement.genConds(beans[0])
  891. } else {
  892. condSQL, condArgs, err = builder.ToSQL(statement.cond)
  893. }
  894. if err != nil {
  895. return "", nil, err
  896. }
  897. var selectSQL = statement.selectStr
  898. if len(selectSQL) <= 0 {
  899. if statement.IsDistinct {
  900. selectSQL = fmt.Sprintf("count(DISTINCT %s)", statement.ColumnStr)
  901. } else {
  902. selectSQL = "count(*)"
  903. }
  904. }
  905. sqlStr, err := statement.genSelectSQL(selectSQL, condSQL)
  906. if err != nil {
  907. return "", nil, err
  908. }
  909. return sqlStr, append(statement.joinArgs, condArgs...), nil
  910. }
  911. func (statement *Statement) genSumSQL(bean interface{}, columns ...string) (string, []interface{}, error) {
  912. statement.setRefValue(rValue(bean))
  913. var sumStrs = make([]string, 0, len(columns))
  914. for _, colName := range columns {
  915. if !strings.Contains(colName, " ") && !strings.Contains(colName, "(") {
  916. colName = statement.Engine.Quote(colName)
  917. }
  918. sumStrs = append(sumStrs, fmt.Sprintf("COALESCE(sum(%s),0)", colName))
  919. }
  920. sumSelect := strings.Join(sumStrs, ", ")
  921. condSQL, condArgs, err := statement.genConds(bean)
  922. if err != nil {
  923. return "", nil, err
  924. }
  925. sqlStr, err := statement.genSelectSQL(sumSelect, condSQL)
  926. if err != nil {
  927. return "", nil, err
  928. }
  929. return sqlStr, append(statement.joinArgs, condArgs...), nil
  930. }
  931. func (statement *Statement) genSelectSQL(columnStr, condSQL string) (a string, err error) {
  932. var distinct string
  933. if statement.IsDistinct && !strings.HasPrefix(columnStr, "count") {
  934. distinct = "DISTINCT "
  935. }
  936. var dialect = statement.Engine.Dialect()
  937. var quote = statement.Engine.Quote
  938. var top string
  939. var mssqlCondi string
  940. if err := statement.processIDParam(); err != nil {
  941. return "", err
  942. }
  943. var buf bytes.Buffer
  944. if len(condSQL) > 0 {
  945. fmt.Fprintf(&buf, " WHERE %v", condSQL)
  946. }
  947. var whereStr = buf.String()
  948. var fromStr = " FROM "
  949. if dialect.DBType() == core.MSSQL && strings.Contains(statement.TableName(), "..") {
  950. fromStr += statement.TableName()
  951. } else {
  952. fromStr += quote(statement.TableName())
  953. }
  954. if statement.TableAlias != "" {
  955. if dialect.DBType() == core.ORACLE {
  956. fromStr += " " + quote(statement.TableAlias)
  957. } else {
  958. fromStr += " AS " + quote(statement.TableAlias)
  959. }
  960. }
  961. if statement.JoinStr != "" {
  962. fromStr = fmt.Sprintf("%v %v", fromStr, statement.JoinStr)
  963. }
  964. if dialect.DBType() == core.MSSQL {
  965. if statement.LimitN > 0 {
  966. top = fmt.Sprintf(" TOP %d ", statement.LimitN)
  967. }
  968. if statement.Start > 0 {
  969. var column string
  970. if len(statement.RefTable.PKColumns()) == 0 {
  971. for _, index := range statement.RefTable.Indexes {
  972. if len(index.Cols) == 1 {
  973. column = index.Cols[0]
  974. break
  975. }
  976. }
  977. if len(column) == 0 {
  978. column = statement.RefTable.ColumnsSeq()[0]
  979. }
  980. } else {
  981. column = statement.RefTable.PKColumns()[0].Name
  982. }
  983. if statement.needTableName() {
  984. if len(statement.TableAlias) > 0 {
  985. column = statement.TableAlias + "." + column
  986. } else {
  987. column = statement.TableName() + "." + column
  988. }
  989. }
  990. var orderStr string
  991. if len(statement.OrderStr) > 0 {
  992. orderStr = " ORDER BY " + statement.OrderStr
  993. }
  994. var groupStr string
  995. if len(statement.GroupByStr) > 0 {
  996. groupStr = " GROUP BY " + statement.GroupByStr
  997. }
  998. mssqlCondi = fmt.Sprintf("(%s NOT IN (SELECT TOP %d %s%s%s%s%s))",
  999. column, statement.Start, column, fromStr, whereStr, orderStr, groupStr)
  1000. }
  1001. }
  1002. // !nashtsai! REVIEW Sprintf is considered slowest mean of string concatnation, better to work with builder pattern
  1003. a = fmt.Sprintf("SELECT %v%v%v%v%v", distinct, top, columnStr, fromStr, whereStr)
  1004. if len(mssqlCondi) > 0 {
  1005. if len(whereStr) > 0 {
  1006. a += " AND " + mssqlCondi
  1007. } else {
  1008. a += " WHERE " + mssqlCondi
  1009. }
  1010. }
  1011. if statement.GroupByStr != "" {
  1012. a = fmt.Sprintf("%v GROUP BY %v", a, statement.GroupByStr)
  1013. }
  1014. if statement.HavingStr != "" {
  1015. a = fmt.Sprintf("%v %v", a, statement.HavingStr)
  1016. }
  1017. if statement.OrderStr != "" {
  1018. a = fmt.Sprintf("%v ORDER BY %v", a, statement.OrderStr)
  1019. }
  1020. if dialect.DBType() != core.MSSQL && dialect.DBType() != core.ORACLE {
  1021. if statement.Start > 0 {
  1022. a = fmt.Sprintf("%v LIMIT %v OFFSET %v", a, statement.LimitN, statement.Start)
  1023. } else if statement.LimitN > 0 {
  1024. a = fmt.Sprintf("%v LIMIT %v", a, statement.LimitN)
  1025. }
  1026. } else if dialect.DBType() == core.ORACLE {
  1027. if statement.Start != 0 || statement.LimitN != 0 {
  1028. a = fmt.Sprintf("SELECT %v FROM (SELECT %v,ROWNUM RN FROM (%v) at WHERE ROWNUM <= %d) aat WHERE RN > %d", columnStr, columnStr, a, statement.Start+statement.LimitN, statement.Start)
  1029. }
  1030. }
  1031. if statement.IsForUpdate {
  1032. a = dialect.ForUpdateSql(a)
  1033. }
  1034. return
  1035. }
  1036. func (statement *Statement) processIDParam() error {
  1037. if statement.idParam == nil {
  1038. return nil
  1039. }
  1040. if len(statement.RefTable.PrimaryKeys) != len(*statement.idParam) {
  1041. return fmt.Errorf("ID condition is error, expect %d primarykeys, there are %d",
  1042. len(statement.RefTable.PrimaryKeys),
  1043. len(*statement.idParam),
  1044. )
  1045. }
  1046. for i, col := range statement.RefTable.PKColumns() {
  1047. var colName = statement.colName(col, statement.TableName())
  1048. statement.cond = statement.cond.And(builder.Eq{colName: (*(statement.idParam))[i]})
  1049. }
  1050. return nil
  1051. }
  1052. func (statement *Statement) joinColumns(cols []*core.Column, includeTableName bool) string {
  1053. var colnames = make([]string, len(cols))
  1054. for i, col := range cols {
  1055. if includeTableName {
  1056. colnames[i] = statement.Engine.Quote(statement.TableName()) +
  1057. "." + statement.Engine.Quote(col.Name)
  1058. } else {
  1059. colnames[i] = statement.Engine.Quote(col.Name)
  1060. }
  1061. }
  1062. return strings.Join(colnames, ", ")
  1063. }
  1064. func (statement *Statement) convertIDSQL(sqlStr string) string {
  1065. if statement.RefTable != nil {
  1066. cols := statement.RefTable.PKColumns()
  1067. if len(cols) == 0 {
  1068. return ""
  1069. }
  1070. colstrs := statement.joinColumns(cols, false)
  1071. sqls := splitNNoCase(sqlStr, " from ", 2)
  1072. if len(sqls) != 2 {
  1073. return ""
  1074. }
  1075. var top string
  1076. if statement.LimitN > 0 && statement.Engine.dialect.DBType() == core.MSSQL {
  1077. top = fmt.Sprintf("TOP %d ", statement.LimitN)
  1078. }
  1079. return fmt.Sprintf("SELECT %s%s FROM %v", top, colstrs, sqls[1])
  1080. }
  1081. return ""
  1082. }
  1083. func (statement *Statement) convertUpdateSQL(sqlStr string) (string, string) {
  1084. if statement.RefTable == nil || len(statement.RefTable.PrimaryKeys) != 1 {
  1085. return "", ""
  1086. }
  1087. colstrs := statement.joinColumns(statement.RefTable.PKColumns(), true)
  1088. sqls := splitNNoCase(sqlStr, "where", 2)
  1089. if len(sqls) != 2 {
  1090. if len(sqls) == 1 {
  1091. return sqls[0], fmt.Sprintf("SELECT %v FROM %v",
  1092. colstrs, statement.Engine.Quote(statement.TableName()))
  1093. }
  1094. return "", ""
  1095. }
  1096. var whereStr = sqls[1]
  1097. //TODO: for postgres only, if any other database?
  1098. var paraStr string
  1099. if statement.Engine.dialect.DBType() == core.POSTGRES {
  1100. paraStr = "$"
  1101. } else if statement.Engine.dialect.DBType() == core.MSSQL {
  1102. paraStr = ":"
  1103. }
  1104. if paraStr != "" {
  1105. if strings.Contains(sqls[1], paraStr) {
  1106. dollers := strings.Split(sqls[1], paraStr)
  1107. whereStr = dollers[0]
  1108. for i, c := range dollers[1:] {
  1109. ccs := strings.SplitN(c, " ", 2)
  1110. whereStr += fmt.Sprintf(paraStr+"%v %v", i+1, ccs[1])
  1111. }
  1112. }
  1113. }
  1114. return sqls[0], fmt.Sprintf("SELECT %v FROM %v WHERE %v",
  1115. colstrs, statement.Engine.Quote(statement.TableName()),
  1116. whereStr)
  1117. }