engine.go 45 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657
  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. "bufio"
  7. "bytes"
  8. "database/sql"
  9. "encoding/gob"
  10. "errors"
  11. "fmt"
  12. "io"
  13. "os"
  14. "reflect"
  15. "strconv"
  16. "strings"
  17. "sync"
  18. "time"
  19. "github.com/fsnotify/fsnotify"
  20. "github.com/xormplus/core"
  21. )
  22. // Engine is the major struct of xorm, it means a database manager.
  23. // Commonly, an application only need one engine.
  24. type Engine struct {
  25. db *core.DB
  26. dialect core.Dialect
  27. ColumnMapper core.IMapper
  28. TableMapper core.IMapper
  29. TagIdentifier string
  30. Tables map[reflect.Type]*core.Table
  31. sqlMap SqlMap
  32. sqlTemplate SqlTemplate
  33. watcher *fsnotify.Watcher
  34. mutex *sync.RWMutex
  35. Cacher core.Cacher
  36. showSQL bool
  37. showExecTime bool
  38. logger core.ILogger
  39. TZLocation *time.Location
  40. DatabaseTZ *time.Location // The timezone of the database
  41. disableGlobalCache bool
  42. }
  43. // ShowSQL show SQL statement or not on logger if log level is great than INFO
  44. func (engine *Engine) ShowSQL(show ...bool) {
  45. engine.logger.ShowSQL(show...)
  46. if len(show) == 0 {
  47. engine.showSQL = true
  48. } else {
  49. engine.showSQL = show[0]
  50. }
  51. }
  52. // ShowExecTime show SQL statement and execute time or not on logger if log level is great than INFO
  53. func (engine *Engine) ShowExecTime(show ...bool) {
  54. if len(show) == 0 {
  55. engine.showExecTime = true
  56. } else {
  57. engine.showExecTime = show[0]
  58. }
  59. }
  60. // Logger return the logger interface
  61. func (engine *Engine) Logger() core.ILogger {
  62. return engine.logger
  63. }
  64. // SetLogger set the new logger
  65. func (engine *Engine) SetLogger(logger core.ILogger) {
  66. engine.logger = logger
  67. engine.dialect.SetLogger(logger)
  68. }
  69. // SetDisableGlobalCache disable global cache or not
  70. func (engine *Engine) SetDisableGlobalCache(disable bool) {
  71. if engine.disableGlobalCache != disable {
  72. engine.disableGlobalCache = disable
  73. }
  74. }
  75. // DriverName return the current sql driver's name
  76. func (engine *Engine) DriverName() string {
  77. return engine.dialect.DriverName()
  78. }
  79. // DataSourceName return the current connection string
  80. func (engine *Engine) DataSourceName() string {
  81. return engine.dialect.DataSourceName()
  82. }
  83. // SetMapper set the name mapping rules
  84. func (engine *Engine) SetMapper(mapper core.IMapper) {
  85. engine.SetTableMapper(mapper)
  86. engine.SetColumnMapper(mapper)
  87. }
  88. // SetTableMapper set the table name mapping rule
  89. func (engine *Engine) SetTableMapper(mapper core.IMapper) {
  90. engine.TableMapper = mapper
  91. }
  92. // SetColumnMapper set the column name mapping rule
  93. func (engine *Engine) SetColumnMapper(mapper core.IMapper) {
  94. engine.ColumnMapper = mapper
  95. }
  96. // SupportInsertMany If engine's database support batch insert records like
  97. // "insert into user values (name, age), (name, age)".
  98. // When the return is ture, then engine.Insert(&users) will
  99. // generate batch sql and exeute.
  100. func (engine *Engine) SupportInsertMany() bool {
  101. return engine.dialect.SupportInsertMany()
  102. }
  103. // QuoteStr Engine's database use which character as quote.
  104. // mysql, sqlite use ` and postgres use "
  105. func (engine *Engine) QuoteStr() string {
  106. return engine.dialect.QuoteStr()
  107. }
  108. // Quote Use QuoteStr quote the string sql
  109. func (engine *Engine) Quote(value string) string {
  110. value = strings.TrimSpace(value)
  111. if len(value) == 0 {
  112. return value
  113. }
  114. if string(value[0]) == engine.dialect.QuoteStr() || value[0] == '`' {
  115. return value
  116. }
  117. value = strings.Replace(value, ".", engine.dialect.QuoteStr()+"."+engine.dialect.QuoteStr(), -1)
  118. return engine.dialect.QuoteStr() + value + engine.dialect.QuoteStr()
  119. }
  120. // QuoteTo quotes string and writes into the buffer
  121. func (engine *Engine) QuoteTo(buf *bytes.Buffer, value string) {
  122. if buf == nil {
  123. return
  124. }
  125. value = strings.TrimSpace(value)
  126. if value == "" {
  127. return
  128. }
  129. if string(value[0]) == engine.dialect.QuoteStr() || value[0] == '`' {
  130. buf.WriteString(value)
  131. return
  132. }
  133. value = strings.Replace(value, ".", engine.dialect.QuoteStr()+"."+engine.dialect.QuoteStr(), -1)
  134. buf.WriteString(engine.dialect.QuoteStr())
  135. buf.WriteString(value)
  136. buf.WriteString(engine.dialect.QuoteStr())
  137. }
  138. func (engine *Engine) quote(sql string) string {
  139. return engine.dialect.QuoteStr() + sql + engine.dialect.QuoteStr()
  140. }
  141. // SqlType will be depracated, please use SQLType instead
  142. //
  143. // Deprecated: use SQLType instead
  144. func (engine *Engine) SqlType(c *core.Column) string {
  145. return engine.SQLType(c)
  146. }
  147. // SQLType A simple wrapper to dialect's core.SqlType method
  148. func (engine *Engine) SQLType(c *core.Column) string {
  149. return engine.dialect.SqlType(c)
  150. }
  151. // AutoIncrStr Database's autoincrement statement
  152. func (engine *Engine) AutoIncrStr() string {
  153. return engine.dialect.AutoIncrStr()
  154. }
  155. // SetMaxOpenConns is only available for go 1.2+
  156. func (engine *Engine) SetMaxOpenConns(conns int) {
  157. engine.db.SetMaxOpenConns(conns)
  158. }
  159. // SetMaxIdleConns set the max idle connections on pool, default is 2
  160. func (engine *Engine) SetMaxIdleConns(conns int) {
  161. engine.db.SetMaxIdleConns(conns)
  162. }
  163. // SetDefaultCacher set the default cacher. Xorm's default not enable cacher.
  164. func (engine *Engine) SetDefaultCacher(cacher core.Cacher) {
  165. engine.Cacher = cacher
  166. }
  167. // NoCache If you has set default cacher, and you want temporilly stop use cache,
  168. // you can use NoCache()
  169. func (engine *Engine) NoCache() *Session {
  170. session := engine.NewSession()
  171. session.IsAutoClose = true
  172. return session.NoCache()
  173. }
  174. // NoCascade If you do not want to auto cascade load object
  175. func (engine *Engine) NoCascade() *Session {
  176. session := engine.NewSession()
  177. session.IsAutoClose = true
  178. return session.NoCascade()
  179. }
  180. // MapCacher Set a table use a special cacher
  181. func (engine *Engine) MapCacher(bean interface{}, cacher core.Cacher) {
  182. v := rValue(bean)
  183. tb := engine.autoMapType(v)
  184. tb.Cacher = cacher
  185. }
  186. // NewDB provides an interface to operate database directly
  187. func (engine *Engine) NewDB() (*core.DB, error) {
  188. return core.OpenDialect(engine.dialect)
  189. }
  190. // DB return the wrapper of sql.DB
  191. func (engine *Engine) DB() *core.DB {
  192. return engine.db
  193. }
  194. // Dialect return database dialect
  195. func (engine *Engine) Dialect() core.Dialect {
  196. return engine.dialect
  197. }
  198. // NewSession New a session
  199. func (engine *Engine) NewSession() *Session {
  200. session := &Session{Engine: engine}
  201. session.Init()
  202. return session
  203. }
  204. // Close the engine
  205. func (engine *Engine) Close() error {
  206. return engine.db.Close()
  207. }
  208. // Ping tests if database is alive
  209. func (engine *Engine) Ping() error {
  210. session := engine.NewSession()
  211. defer session.Close()
  212. engine.logger.Infof("PING DATABASE %v", engine.DriverName())
  213. return session.Ping()
  214. }
  215. // logging sql
  216. func (engine *Engine) logSQL(sqlStr string, sqlArgs ...interface{}) {
  217. if engine.showSQL && !engine.showExecTime {
  218. if len(sqlArgs) > 0 {
  219. engine.logger.Infof("[sql] %v [args] %v", sqlStr, sqlArgs)
  220. } else {
  221. engine.logger.Infof("[sql] %v", sqlStr)
  222. }
  223. }
  224. }
  225. func (engine *Engine) logSQLQueryTime(sqlStr string, args []interface{}, executionBlock func() (*core.Stmt, *core.Rows, error)) (*core.Stmt, *core.Rows, error) {
  226. if engine.showSQL && engine.showExecTime {
  227. b4ExecTime := time.Now()
  228. stmt, res, err := executionBlock()
  229. execDuration := time.Since(b4ExecTime)
  230. if len(args) > 0 {
  231. engine.logger.Infof("[sql] %s [args] %v - took: %v", sqlStr, args, execDuration)
  232. } else {
  233. engine.logger.Infof("[sql] %s - took: %v", sqlStr, execDuration)
  234. }
  235. return stmt, res, err
  236. }
  237. return executionBlock()
  238. }
  239. func (engine *Engine) logSQLExecutionTime(sqlStr string, args []interface{}, executionBlock func() (sql.Result, error)) (sql.Result, error) {
  240. if engine.showSQL && engine.showExecTime {
  241. b4ExecTime := time.Now()
  242. res, err := executionBlock()
  243. execDuration := time.Since(b4ExecTime)
  244. if len(args) > 0 {
  245. engine.logger.Infof("[sql] %s [args] %v - took: %v", sqlStr, args, execDuration)
  246. } else {
  247. engine.logger.Infof("[sql] %s - took: %v", sqlStr, execDuration)
  248. }
  249. return res, err
  250. }
  251. return executionBlock()
  252. }
  253. // Sql provides raw sql input parameter. When you have a complex SQL statement
  254. // and cannot use Where, Id, In and etc. Methods to describe, you can use SQL.
  255. //
  256. // Deprecated: use SQL instead.
  257. func (engine *Engine) Sql(querystring string, args ...interface{}) *Session {
  258. return engine.SQL(querystring, args...)
  259. }
  260. // SQL method let's you manually write raw SQL and operate
  261. // For example:
  262. //
  263. // engine.SQL("select * from user").Find(&users)
  264. //
  265. // This code will execute "select * from user" and set the records to users
  266. func (engine *Engine) SQL(query interface{}, args ...interface{}) *Session {
  267. session := engine.NewSession()
  268. session.IsAutoClose = true
  269. switch query.(type) {
  270. case string:
  271. session.IsSqlFunc = true
  272. default:
  273. session.IsSqlFunc = false
  274. }
  275. return session.SQL(query, args...)
  276. }
  277. // NoAutoTime Default if your struct has "created" or "updated" filed tag, the fields
  278. // will automatically be filled with current time when Insert or Update
  279. // invoked. Call NoAutoTime if you dont' want to fill automatically.
  280. func (engine *Engine) NoAutoTime() *Session {
  281. session := engine.NewSession()
  282. session.IsAutoClose = true
  283. return session.NoAutoTime()
  284. }
  285. // NoAutoCondition disable auto generate Where condition from bean or not
  286. func (engine *Engine) NoAutoCondition(no ...bool) *Session {
  287. session := engine.NewSession()
  288. session.IsAutoClose = true
  289. return session.NoAutoCondition(no...)
  290. }
  291. // DBMetas Retrieve all tables, columns, indexes' informations from database.
  292. func (engine *Engine) DBMetas() ([]*core.Table, error) {
  293. tables, err := engine.dialect.GetTables()
  294. if err != nil {
  295. return nil, err
  296. }
  297. for _, table := range tables {
  298. colSeq, cols, err := engine.dialect.GetColumns(table.Name)
  299. if err != nil {
  300. return nil, err
  301. }
  302. for _, name := range colSeq {
  303. table.AddColumn(cols[name])
  304. }
  305. indexes, err := engine.dialect.GetIndexes(table.Name)
  306. if err != nil {
  307. return nil, err
  308. }
  309. table.Indexes = indexes
  310. for _, index := range indexes {
  311. for _, name := range index.Cols {
  312. if col := table.GetColumn(name); col != nil {
  313. col.Indexes[index.Name] = index.Type
  314. } else {
  315. return nil, fmt.Errorf("Unknown col %s in index %v of table %v, columns %v", name, index.Name, table.Name, table.ColumnsSeq())
  316. }
  317. }
  318. }
  319. }
  320. return tables, nil
  321. }
  322. // DumpAllToFile dump database all table structs and data to a file
  323. func (engine *Engine) DumpAllToFile(fp string, tp ...core.DbType) error {
  324. f, err := os.Create(fp)
  325. if err != nil {
  326. return err
  327. }
  328. defer f.Close()
  329. return engine.DumpAll(f, tp...)
  330. }
  331. // DumpAll dump database all table structs and data to w
  332. func (engine *Engine) DumpAll(w io.Writer, tp ...core.DbType) error {
  333. tables, err := engine.DBMetas()
  334. if err != nil {
  335. return err
  336. }
  337. return engine.DumpTables(tables, w, tp...)
  338. }
  339. // DumpTablesToFile dump specified tables to SQL file.
  340. func (engine *Engine) DumpTablesToFile(tables []*core.Table, fp string, tp ...core.DbType) error {
  341. f, err := os.Create(fp)
  342. if err != nil {
  343. return err
  344. }
  345. defer f.Close()
  346. return engine.DumpTables(tables, f, tp...)
  347. }
  348. // DumpTables dump specify tables to io.Writer
  349. func (engine *Engine) DumpTables(tables []*core.Table, w io.Writer, tp ...core.DbType) error {
  350. return engine.dumpTables(tables, w, tp...)
  351. }
  352. // dumpTables dump database all table structs and data to w with specify db type
  353. func (engine *Engine) dumpTables(tables []*core.Table, w io.Writer, tp ...core.DbType) error {
  354. var dialect core.Dialect
  355. var distDBName string
  356. if len(tp) == 0 {
  357. dialect = engine.dialect
  358. distDBName = string(engine.dialect.DBType())
  359. } else {
  360. dialect = core.QueryDialect(tp[0])
  361. if dialect == nil {
  362. return errors.New("Unsupported database type")
  363. }
  364. dialect.Init(nil, engine.dialect.URI(), "", "")
  365. distDBName = string(tp[0])
  366. }
  367. _, err := io.WriteString(w, fmt.Sprintf("/*Generated by xorm v%s %s, from %s to %s*/\n\n",
  368. Version, time.Now().In(engine.TZLocation).Format("2006-01-02 15:04:05"), engine.dialect.DBType(), strings.ToUpper(distDBName)))
  369. if err != nil {
  370. return err
  371. }
  372. for i, table := range tables {
  373. if i > 0 {
  374. _, err = io.WriteString(w, "\n")
  375. if err != nil {
  376. return err
  377. }
  378. }
  379. _, err = io.WriteString(w, dialect.CreateTableSql(table, "", table.StoreEngine, "")+";\n")
  380. if err != nil {
  381. return err
  382. }
  383. for _, index := range table.Indexes {
  384. _, err = io.WriteString(w, dialect.CreateIndexSql(table.Name, index)+";\n")
  385. if err != nil {
  386. return err
  387. }
  388. }
  389. cols := table.ColumnsSeq()
  390. colNames := dialect.Quote(strings.Join(cols, dialect.Quote(", ")))
  391. rows, err := engine.DB().Query("SELECT " + colNames + " FROM " + engine.Quote(table.Name))
  392. if err != nil {
  393. return err
  394. }
  395. defer rows.Close()
  396. for rows.Next() {
  397. dest := make([]interface{}, len(cols))
  398. err = rows.ScanSlice(&dest)
  399. if err != nil {
  400. return err
  401. }
  402. _, err = io.WriteString(w, "INSERT INTO "+dialect.Quote(table.Name)+" ("+colNames+") VALUES (")
  403. if err != nil {
  404. return err
  405. }
  406. var temp string
  407. for i, d := range dest {
  408. col := table.GetColumn(cols[i])
  409. if col == nil {
  410. return errors.New("unknow column error")
  411. }
  412. if d == nil {
  413. temp += ", NULL"
  414. } else if col.SQLType.IsText() || col.SQLType.IsTime() {
  415. var v = fmt.Sprintf("%s", d)
  416. if strings.HasSuffix(v, " +0000 UTC") {
  417. temp += fmt.Sprintf(", '%s'", v[0:len(v)-len(" +0000 UTC")])
  418. } else {
  419. temp += ", '" + strings.Replace(v, "'", "''", -1) + "'"
  420. }
  421. } else if col.SQLType.IsBlob() {
  422. if reflect.TypeOf(d).Kind() == reflect.Slice {
  423. temp += fmt.Sprintf(", %s", dialect.FormatBytes(d.([]byte)))
  424. } else if reflect.TypeOf(d).Kind() == reflect.String {
  425. temp += fmt.Sprintf(", '%s'", d.(string))
  426. }
  427. } else if col.SQLType.IsNumeric() {
  428. switch reflect.TypeOf(d).Kind() {
  429. case reflect.Slice:
  430. temp += fmt.Sprintf(", %s", string(d.([]byte)))
  431. case reflect.Int16, reflect.Int8, reflect.Int32, reflect.Int64, reflect.Int:
  432. if col.SQLType.Name == core.Bool {
  433. temp += fmt.Sprintf(", %v", strconv.FormatBool(reflect.ValueOf(d).Int() > 0))
  434. } else {
  435. temp += fmt.Sprintf(", %v", d)
  436. }
  437. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  438. if col.SQLType.Name == core.Bool {
  439. temp += fmt.Sprintf(", %v", strconv.FormatBool(reflect.ValueOf(d).Uint() > 0))
  440. } else {
  441. temp += fmt.Sprintf(", %v", d)
  442. }
  443. default:
  444. temp += fmt.Sprintf(", %v", d)
  445. }
  446. } else {
  447. s := fmt.Sprintf("%v", d)
  448. if strings.Contains(s, ":") || strings.Contains(s, "-") {
  449. if strings.HasSuffix(s, " +0000 UTC") {
  450. temp += fmt.Sprintf(", '%s'", s[0:len(s)-len(" +0000 UTC")])
  451. } else {
  452. temp += fmt.Sprintf(", '%s'", s)
  453. }
  454. } else {
  455. temp += fmt.Sprintf(", %s", s)
  456. }
  457. }
  458. }
  459. _, err = io.WriteString(w, temp[2:]+");\n")
  460. if err != nil {
  461. return err
  462. }
  463. }
  464. }
  465. return nil
  466. }
  467. func (engine *Engine) tableName(beanOrTableName interface{}) (string, error) {
  468. v := rValue(beanOrTableName)
  469. if v.Type().Kind() == reflect.String {
  470. return beanOrTableName.(string), nil
  471. } else if v.Type().Kind() == reflect.Struct {
  472. return engine.tbName(v), nil
  473. }
  474. return "", errors.New("bean should be a struct or struct's point")
  475. }
  476. func (engine *Engine) tbName(v reflect.Value) string {
  477. if tb, ok := v.Interface().(TableName); ok {
  478. return tb.TableName()
  479. }
  480. if v.Type().Kind() == reflect.Ptr {
  481. if tb, ok := reflect.Indirect(v).Interface().(TableName); ok {
  482. return tb.TableName()
  483. }
  484. } else if v.CanAddr() {
  485. if tb, ok := v.Addr().Interface().(TableName); ok {
  486. return tb.TableName()
  487. }
  488. }
  489. return engine.TableMapper.Obj2Table(reflect.Indirect(v).Type().Name())
  490. }
  491. // Cascade use cascade or not
  492. func (engine *Engine) Cascade(trueOrFalse ...bool) *Session {
  493. session := engine.NewSession()
  494. session.IsAutoClose = true
  495. return session.Cascade(trueOrFalse...)
  496. }
  497. // Where method provide a condition query
  498. func (engine *Engine) Where(query interface{}, args ...interface{}) *Session {
  499. session := engine.NewSession()
  500. session.IsAutoClose = true
  501. return session.Where(query, args...)
  502. }
  503. // Id will be depracated, please use ID instead
  504. func (engine *Engine) Id(id interface{}) *Session {
  505. session := engine.NewSession()
  506. session.IsAutoClose = true
  507. return session.Id(id)
  508. }
  509. // ID method provoide a condition as (id) = ?
  510. func (engine *Engine) ID(id interface{}) *Session {
  511. session := engine.NewSession()
  512. session.IsAutoClose = true
  513. return session.ID(id)
  514. }
  515. // Before apply before Processor, affected bean is passed to closure arg
  516. func (engine *Engine) Before(closures func(interface{})) *Session {
  517. session := engine.NewSession()
  518. session.IsAutoClose = true
  519. return session.Before(closures)
  520. }
  521. // After apply after insert Processor, affected bean is passed to closure arg
  522. func (engine *Engine) After(closures func(interface{})) *Session {
  523. session := engine.NewSession()
  524. session.IsAutoClose = true
  525. return session.After(closures)
  526. }
  527. // Charset set charset when create table, only support mysql now
  528. func (engine *Engine) Charset(charset string) *Session {
  529. session := engine.NewSession()
  530. session.IsAutoClose = true
  531. return session.Charset(charset)
  532. }
  533. // StoreEngine set store engine when create table, only support mysql now
  534. func (engine *Engine) StoreEngine(storeEngine string) *Session {
  535. session := engine.NewSession()
  536. session.IsAutoClose = true
  537. return session.StoreEngine(storeEngine)
  538. }
  539. // Distinct use for distinct columns. Caution: when you are using cache,
  540. // distinct will not be cached because cache system need id,
  541. // but distinct will not provide id
  542. func (engine *Engine) Distinct(columns ...string) *Session {
  543. session := engine.NewSession()
  544. session.IsAutoClose = true
  545. return session.Distinct(columns...)
  546. }
  547. // Select customerize your select columns or contents
  548. func (engine *Engine) Select(str string) *Session {
  549. session := engine.NewSession()
  550. session.IsAutoClose = true
  551. return session.Select(str)
  552. }
  553. // Cols only use the parameters as select or update columns
  554. func (engine *Engine) Cols(columns ...string) *Session {
  555. session := engine.NewSession()
  556. session.IsAutoClose = true
  557. return session.Cols(columns...)
  558. }
  559. // AllCols indicates that all columns should be use
  560. func (engine *Engine) AllCols() *Session {
  561. session := engine.NewSession()
  562. session.IsAutoClose = true
  563. return session.AllCols()
  564. }
  565. // MustCols specify some columns must use even if they are empty
  566. func (engine *Engine) MustCols(columns ...string) *Session {
  567. session := engine.NewSession()
  568. session.IsAutoClose = true
  569. return session.MustCols(columns...)
  570. }
  571. // UseBool xorm automatically retrieve condition according struct, but
  572. // if struct has bool field, it will ignore them. So use UseBool
  573. // to tell system to do not ignore them.
  574. // If no parameters, it will use all the bool field of struct, or
  575. // it will use parameters's columns
  576. func (engine *Engine) UseBool(columns ...string) *Session {
  577. session := engine.NewSession()
  578. session.IsAutoClose = true
  579. return session.UseBool(columns...)
  580. }
  581. // Omit only not use the parameters as select or update columns
  582. func (engine *Engine) Omit(columns ...string) *Session {
  583. session := engine.NewSession()
  584. session.IsAutoClose = true
  585. return session.Omit(columns...)
  586. }
  587. // Nullable set null when column is zero-value and nullable for update
  588. func (engine *Engine) Nullable(columns ...string) *Session {
  589. session := engine.NewSession()
  590. session.IsAutoClose = true
  591. return session.Nullable(columns...)
  592. }
  593. // In will generate "column IN (?, ?)"
  594. func (engine *Engine) In(column string, args ...interface{}) *Session {
  595. session := engine.NewSession()
  596. session.IsAutoClose = true
  597. return session.In(column, args...)
  598. }
  599. // Incr provides a update string like "column = column + ?"
  600. func (engine *Engine) Incr(column string, arg ...interface{}) *Session {
  601. session := engine.NewSession()
  602. session.IsAutoClose = true
  603. return session.Incr(column, arg...)
  604. }
  605. // Decr provides a update string like "column = column - ?"
  606. func (engine *Engine) Decr(column string, arg ...interface{}) *Session {
  607. session := engine.NewSession()
  608. session.IsAutoClose = true
  609. return session.Decr(column, arg...)
  610. }
  611. // SetExpr provides a update string like "column = {expression}"
  612. func (engine *Engine) SetExpr(column string, expression string) *Session {
  613. session := engine.NewSession()
  614. session.IsAutoClose = true
  615. return session.SetExpr(column, expression)
  616. }
  617. // Table temporarily change the Get, Find, Update's table
  618. func (engine *Engine) Table(tableNameOrBean interface{}) *Session {
  619. session := engine.NewSession()
  620. session.IsAutoClose = true
  621. return session.Table(tableNameOrBean)
  622. }
  623. // Alias set the table alias
  624. func (engine *Engine) Alias(alias string) *Session {
  625. session := engine.NewSession()
  626. session.IsAutoClose = true
  627. return session.Alias(alias)
  628. }
  629. // Limit will generate "LIMIT start, limit"
  630. func (engine *Engine) Limit(limit int, start ...int) *Session {
  631. session := engine.NewSession()
  632. session.IsAutoClose = true
  633. return session.Limit(limit, start...)
  634. }
  635. // Desc will generate "ORDER BY column1 DESC, column2 DESC"
  636. func (engine *Engine) Desc(colNames ...string) *Session {
  637. session := engine.NewSession()
  638. session.IsAutoClose = true
  639. return session.Desc(colNames...)
  640. }
  641. // Asc will generate "ORDER BY column1,column2 Asc"
  642. // This method can chainable use.
  643. //
  644. // engine.Desc("name").Asc("age").Find(&users)
  645. // // SELECT * FROM user ORDER BY name DESC, age ASC
  646. //
  647. func (engine *Engine) Asc(colNames ...string) *Session {
  648. session := engine.NewSession()
  649. session.IsAutoClose = true
  650. return session.Asc(colNames...)
  651. }
  652. // OrderBy will generate "ORDER BY order"
  653. func (engine *Engine) OrderBy(order string) *Session {
  654. session := engine.NewSession()
  655. session.IsAutoClose = true
  656. return session.OrderBy(order)
  657. }
  658. // Join the join_operator should be one of INNER, LEFT OUTER, CROSS etc - this will be prepended to JOIN
  659. func (engine *Engine) Join(joinOperator string, tablename interface{}, condition string, args ...interface{}) *Session {
  660. session := engine.NewSession()
  661. session.IsAutoClose = true
  662. return session.Join(joinOperator, tablename, condition, args...)
  663. }
  664. // GroupBy generate group by statement
  665. func (engine *Engine) GroupBy(keys string) *Session {
  666. session := engine.NewSession()
  667. session.IsAutoClose = true
  668. return session.GroupBy(keys)
  669. }
  670. // Having generate having statement
  671. func (engine *Engine) Having(conditions string) *Session {
  672. session := engine.NewSession()
  673. session.IsAutoClose = true
  674. return session.Having(conditions)
  675. }
  676. func (engine *Engine) autoMapType(v reflect.Value) *core.Table {
  677. t := v.Type()
  678. engine.mutex.Lock()
  679. defer engine.mutex.Unlock()
  680. table, ok := engine.Tables[t]
  681. if !ok {
  682. table = engine.mapType(v)
  683. engine.Tables[t] = table
  684. if engine.Cacher != nil {
  685. if v.CanAddr() {
  686. engine.GobRegister(v.Addr().Interface())
  687. } else {
  688. engine.GobRegister(v.Interface())
  689. }
  690. }
  691. }
  692. return table
  693. }
  694. // GobRegister register one struct to gob for cache use
  695. func (engine *Engine) GobRegister(v interface{}) *Engine {
  696. //fmt.Printf("Type: %[1]T => Data: %[1]#v\n", v)
  697. gob.Register(v)
  698. return engine
  699. }
  700. // Table table struct
  701. type Table struct {
  702. *core.Table
  703. Name string
  704. }
  705. // TableInfo get table info according to bean's content
  706. func (engine *Engine) TableInfo(bean interface{}) *Table {
  707. v := rValue(bean)
  708. return &Table{engine.autoMapType(v), engine.tbName(v)}
  709. }
  710. func addIndex(indexName string, table *core.Table, col *core.Column, indexType int) {
  711. if index, ok := table.Indexes[indexName]; ok {
  712. index.AddColumn(col.Name)
  713. col.Indexes[index.Name] = indexType
  714. } else {
  715. index := core.NewIndex(indexName, indexType)
  716. index.AddColumn(col.Name)
  717. table.AddIndex(index)
  718. col.Indexes[index.Name] = indexType
  719. }
  720. }
  721. func (engine *Engine) newTable() *core.Table {
  722. table := core.NewEmptyTable()
  723. if !engine.disableGlobalCache {
  724. table.Cacher = engine.Cacher
  725. }
  726. return table
  727. }
  728. // TableName table name interface to define customerize table name
  729. type TableName interface {
  730. TableName() string
  731. }
  732. var (
  733. tpTableName = reflect.TypeOf((*TableName)(nil)).Elem()
  734. )
  735. func (engine *Engine) mapType(v reflect.Value) *core.Table {
  736. t := v.Type()
  737. table := engine.newTable()
  738. if tb, ok := v.Interface().(TableName); ok {
  739. table.Name = tb.TableName()
  740. } else {
  741. if v.CanAddr() {
  742. if tb, ok = v.Addr().Interface().(TableName); ok {
  743. table.Name = tb.TableName()
  744. }
  745. }
  746. if table.Name == "" {
  747. table.Name = engine.TableMapper.Obj2Table(t.Name())
  748. }
  749. }
  750. table.Type = t
  751. var idFieldColName string
  752. var err error
  753. var hasCacheTag, hasNoCacheTag bool
  754. for i := 0; i < t.NumField(); i++ {
  755. tag := t.Field(i).Tag
  756. ormTagStr := tag.Get(engine.TagIdentifier)
  757. var col *core.Column
  758. fieldValue := v.Field(i)
  759. fieldType := fieldValue.Type()
  760. if ormTagStr != "" {
  761. col = &core.Column{FieldName: t.Field(i).Name, Nullable: true, IsPrimaryKey: false,
  762. IsAutoIncrement: false, MapType: core.TWOSIDES, Indexes: make(map[string]int)}
  763. tags := splitTag(ormTagStr)
  764. if len(tags) > 0 {
  765. if tags[0] == "-" {
  766. continue
  767. }
  768. if strings.ToUpper(tags[0]) == "EXTENDS" {
  769. switch fieldValue.Kind() {
  770. case reflect.Ptr:
  771. f := fieldValue.Type().Elem()
  772. if f.Kind() == reflect.Struct {
  773. fieldPtr := fieldValue
  774. fieldValue = fieldValue.Elem()
  775. if !fieldValue.IsValid() || fieldPtr.IsNil() {
  776. fieldValue = reflect.New(f).Elem()
  777. }
  778. }
  779. fallthrough
  780. case reflect.Struct:
  781. parentTable := engine.mapType(fieldValue)
  782. for _, col := range parentTable.Columns() {
  783. col.FieldName = fmt.Sprintf("%v.%v", t.Field(i).Name, col.FieldName)
  784. table.AddColumn(col)
  785. for indexName, indexType := range col.Indexes {
  786. addIndex(indexName, table, col, indexType)
  787. }
  788. }
  789. continue
  790. default:
  791. //TODO: warning
  792. }
  793. }
  794. indexNames := make(map[string]int)
  795. var isIndex, isUnique bool
  796. var preKey string
  797. for j, key := range tags {
  798. k := strings.ToUpper(key)
  799. switch {
  800. case k == "<-":
  801. col.MapType = core.ONLYFROMDB
  802. case k == "->":
  803. col.MapType = core.ONLYTODB
  804. case k == "PK":
  805. col.IsPrimaryKey = true
  806. col.Nullable = false
  807. case k == "NULL":
  808. if j == 0 {
  809. col.Nullable = true
  810. } else {
  811. col.Nullable = (strings.ToUpper(tags[j-1]) != "NOT")
  812. }
  813. // TODO: for postgres how add autoincr?
  814. /*case strings.HasPrefix(k, "AUTOINCR(") && strings.HasSuffix(k, ")"):
  815. col.IsAutoIncrement = true
  816. autoStart := k[len("AUTOINCR")+1 : len(k)-1]
  817. autoStartInt, err := strconv.Atoi(autoStart)
  818. if err != nil {
  819. engine.LogError(err)
  820. }
  821. col.AutoIncrStart = autoStartInt*/
  822. case k == "AUTOINCR":
  823. col.IsAutoIncrement = true
  824. //col.AutoIncrStart = 1
  825. case k == "DEFAULT":
  826. col.Default = tags[j+1]
  827. case k == "CREATED":
  828. col.IsCreated = true
  829. case k == "VERSION":
  830. col.IsVersion = true
  831. col.Default = "1"
  832. case k == "UTC":
  833. col.TimeZone = time.UTC
  834. case k == "LOCAL":
  835. col.TimeZone = time.Local
  836. case strings.HasPrefix(k, "LOCALE(") && strings.HasSuffix(k, ")"):
  837. location := k[len("LOCALE")+1 : len(k)-1]
  838. col.TimeZone, err = time.LoadLocation(location)
  839. if err != nil {
  840. engine.logger.Error(err)
  841. }
  842. case k == "UPDATED":
  843. col.IsUpdated = true
  844. case k == "DELETED":
  845. col.IsDeleted = true
  846. case strings.HasPrefix(k, "INDEX(") && strings.HasSuffix(k, ")"):
  847. indexName := k[len("INDEX")+1 : len(k)-1]
  848. indexNames[indexName] = core.IndexType
  849. case k == "INDEX":
  850. isIndex = true
  851. case strings.HasPrefix(k, "UNIQUE(") && strings.HasSuffix(k, ")"):
  852. indexName := k[len("UNIQUE")+1 : len(k)-1]
  853. indexNames[indexName] = core.UniqueType
  854. case k == "UNIQUE":
  855. isUnique = true
  856. case k == "NOTNULL":
  857. col.Nullable = false
  858. case k == "CACHE":
  859. if !hasCacheTag {
  860. hasCacheTag = true
  861. }
  862. case k == "NOCACHE":
  863. if !hasNoCacheTag {
  864. hasNoCacheTag = true
  865. }
  866. case k == "NOT":
  867. default:
  868. if strings.HasPrefix(k, "'") && strings.HasSuffix(k, "'") {
  869. if preKey != "DEFAULT" {
  870. col.Name = key[1 : len(key)-1]
  871. }
  872. } else if strings.Contains(k, "(") && strings.HasSuffix(k, ")") {
  873. fs := strings.Split(k, "(")
  874. if _, ok := core.SqlTypes[fs[0]]; !ok {
  875. preKey = k
  876. continue
  877. }
  878. col.SQLType = core.SQLType{Name: fs[0]}
  879. if fs[0] == core.Enum && fs[1][0] == '\'' { //enum
  880. options := strings.Split(fs[1][0:len(fs[1])-1], ",")
  881. col.EnumOptions = make(map[string]int)
  882. for k, v := range options {
  883. v = strings.TrimSpace(v)
  884. v = strings.Trim(v, "'")
  885. col.EnumOptions[v] = k
  886. }
  887. } else if fs[0] == core.Set && fs[1][0] == '\'' { //set
  888. options := strings.Split(fs[1][0:len(fs[1])-1], ",")
  889. col.SetOptions = make(map[string]int)
  890. for k, v := range options {
  891. v = strings.TrimSpace(v)
  892. v = strings.Trim(v, "'")
  893. col.SetOptions[v] = k
  894. }
  895. } else {
  896. fs2 := strings.Split(fs[1][0:len(fs[1])-1], ",")
  897. if len(fs2) == 2 {
  898. col.Length, err = strconv.Atoi(fs2[0])
  899. if err != nil {
  900. engine.logger.Error(err)
  901. }
  902. col.Length2, err = strconv.Atoi(fs2[1])
  903. if err != nil {
  904. engine.logger.Error(err)
  905. }
  906. } else if len(fs2) == 1 {
  907. col.Length, err = strconv.Atoi(fs2[0])
  908. if err != nil {
  909. engine.logger.Error(err)
  910. }
  911. }
  912. }
  913. } else {
  914. if _, ok := core.SqlTypes[k]; ok {
  915. col.SQLType = core.SQLType{Name: k}
  916. } else if key != col.Default {
  917. col.Name = key
  918. }
  919. }
  920. engine.dialect.SqlType(col)
  921. }
  922. preKey = k
  923. }
  924. if col.SQLType.Name == "" {
  925. col.SQLType = core.Type2SQLType(fieldType)
  926. }
  927. if col.Length == 0 {
  928. col.Length = col.SQLType.DefaultLength
  929. }
  930. if col.Length2 == 0 {
  931. col.Length2 = col.SQLType.DefaultLength2
  932. }
  933. if col.Name == "" {
  934. col.Name = engine.ColumnMapper.Obj2Table(t.Field(i).Name)
  935. }
  936. if isUnique {
  937. indexNames[col.Name] = core.UniqueType
  938. } else if isIndex {
  939. indexNames[col.Name] = core.IndexType
  940. }
  941. for indexName, indexType := range indexNames {
  942. addIndex(indexName, table, col, indexType)
  943. }
  944. }
  945. } else {
  946. var sqlType core.SQLType
  947. if fieldValue.CanAddr() {
  948. if _, ok := fieldValue.Addr().Interface().(core.Conversion); ok {
  949. sqlType = core.SQLType{Name: core.Text}
  950. }
  951. }
  952. if _, ok := fieldValue.Interface().(core.Conversion); ok {
  953. sqlType = core.SQLType{Name: core.Text}
  954. } else {
  955. sqlType = core.Type2SQLType(fieldType)
  956. }
  957. col = core.NewColumn(engine.ColumnMapper.Obj2Table(t.Field(i).Name),
  958. t.Field(i).Name, sqlType, sqlType.DefaultLength,
  959. sqlType.DefaultLength2, true)
  960. }
  961. if col.IsAutoIncrement {
  962. col.Nullable = false
  963. }
  964. table.AddColumn(col)
  965. if fieldType.Kind() == reflect.Int64 && (strings.ToUpper(col.FieldName) == "ID" || strings.HasSuffix(strings.ToUpper(col.FieldName), ".ID")) {
  966. idFieldColName = col.Name
  967. }
  968. } // end for
  969. if idFieldColName != "" && len(table.PrimaryKeys) == 0 {
  970. col := table.GetColumn(idFieldColName)
  971. col.IsPrimaryKey = true
  972. col.IsAutoIncrement = true
  973. col.Nullable = false
  974. table.PrimaryKeys = append(table.PrimaryKeys, col.Name)
  975. table.AutoIncrement = col.Name
  976. }
  977. if hasCacheTag {
  978. if engine.Cacher != nil { // !nash! use engine's cacher if provided
  979. engine.logger.Info("enable cache on table:", table.Name)
  980. table.Cacher = engine.Cacher
  981. } else {
  982. engine.logger.Info("enable LRU cache on table:", table.Name)
  983. table.Cacher = NewLRUCacher2(NewMemoryStore(), time.Hour, 10000) // !nashtsai! HACK use LRU cacher for now
  984. }
  985. }
  986. if hasNoCacheTag {
  987. engine.logger.Info("no cache on table:", table.Name)
  988. table.Cacher = nil
  989. }
  990. return table
  991. }
  992. // IsTableEmpty if a table has any reocrd
  993. func (engine *Engine) IsTableEmpty(bean interface{}) (bool, error) {
  994. session := engine.NewSession()
  995. defer session.Close()
  996. return session.IsTableEmpty(bean)
  997. }
  998. // IsTableExist if a table is exist
  999. func (engine *Engine) IsTableExist(beanOrTableName interface{}) (bool, error) {
  1000. session := engine.NewSession()
  1001. defer session.Close()
  1002. return session.IsTableExist(beanOrTableName)
  1003. }
  1004. // IdOf get id from one struct
  1005. //
  1006. // Deprecated: use IDOf instead.
  1007. func (engine *Engine) IdOf(bean interface{}) core.PK {
  1008. return engine.IDOf(bean)
  1009. }
  1010. // IDOf get id from one struct
  1011. func (engine *Engine) IDOf(bean interface{}) core.PK {
  1012. return engine.IdOfV(reflect.ValueOf(bean))
  1013. }
  1014. // IdOfV get id from one value of struct
  1015. //
  1016. // Deprecated: use IDOfV instead.
  1017. func (engine *Engine) IdOfV(rv reflect.Value) core.PK {
  1018. return engine.IDOfV(rv)
  1019. }
  1020. // IDOfV get id from one value of struct
  1021. func (engine *Engine) IDOfV(rv reflect.Value) core.PK {
  1022. v := reflect.Indirect(rv)
  1023. table := engine.autoMapType(v)
  1024. pk := make([]interface{}, len(table.PrimaryKeys))
  1025. for i, col := range table.PKColumns() {
  1026. pkField := v.FieldByName(col.FieldName)
  1027. switch pkField.Kind() {
  1028. case reflect.String:
  1029. pk[i] = pkField.String()
  1030. case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
  1031. pk[i] = pkField.Int()
  1032. case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64:
  1033. pk[i] = pkField.Uint()
  1034. }
  1035. }
  1036. return core.PK(pk)
  1037. }
  1038. // CreateIndexes create indexes
  1039. func (engine *Engine) CreateIndexes(bean interface{}) error {
  1040. session := engine.NewSession()
  1041. defer session.Close()
  1042. return session.CreateIndexes(bean)
  1043. }
  1044. // CreateUniques create uniques
  1045. func (engine *Engine) CreateUniques(bean interface{}) error {
  1046. session := engine.NewSession()
  1047. defer session.Close()
  1048. return session.CreateUniques(bean)
  1049. }
  1050. func (engine *Engine) getCacher2(table *core.Table) core.Cacher {
  1051. return table.Cacher
  1052. }
  1053. func (engine *Engine) getCacher(v reflect.Value) core.Cacher {
  1054. if table := engine.autoMapType(v); table != nil {
  1055. return table.Cacher
  1056. }
  1057. return engine.Cacher
  1058. }
  1059. // ClearCacheBean if enabled cache, clear the cache bean
  1060. func (engine *Engine) ClearCacheBean(bean interface{}, id string) error {
  1061. v := rValue(bean)
  1062. t := v.Type()
  1063. if t.Kind() != reflect.Struct {
  1064. return errors.New("error params")
  1065. }
  1066. tableName := engine.tbName(v)
  1067. table := engine.autoMapType(v)
  1068. cacher := table.Cacher
  1069. if cacher == nil {
  1070. cacher = engine.Cacher
  1071. }
  1072. if cacher != nil {
  1073. cacher.ClearIds(tableName)
  1074. cacher.DelBean(tableName, id)
  1075. }
  1076. return nil
  1077. }
  1078. // ClearCache if enabled cache, clear some tables' cache
  1079. func (engine *Engine) ClearCache(beans ...interface{}) error {
  1080. for _, bean := range beans {
  1081. v := rValue(bean)
  1082. t := v.Type()
  1083. if t.Kind() != reflect.Struct {
  1084. return errors.New("error params")
  1085. }
  1086. tableName := engine.tbName(v)
  1087. table := engine.autoMapType(v)
  1088. cacher := table.Cacher
  1089. if cacher == nil {
  1090. cacher = engine.Cacher
  1091. }
  1092. if cacher != nil {
  1093. cacher.ClearIds(tableName)
  1094. cacher.ClearBeans(tableName)
  1095. }
  1096. }
  1097. return nil
  1098. }
  1099. // Sync the new struct changes to database, this method will automatically add
  1100. // table, column, index, unique. but will not delete or change anything.
  1101. // If you change some field, you should change the database manually.
  1102. func (engine *Engine) Sync(beans ...interface{}) error {
  1103. for _, bean := range beans {
  1104. v := rValue(bean)
  1105. tableName := engine.tbName(v)
  1106. table := engine.autoMapType(v)
  1107. s := engine.NewSession()
  1108. defer s.Close()
  1109. isExist, err := s.Table(bean).isTableExist(tableName)
  1110. if err != nil {
  1111. return err
  1112. }
  1113. if !isExist {
  1114. err = engine.CreateTables(bean)
  1115. if err != nil {
  1116. return err
  1117. }
  1118. }
  1119. /*isEmpty, err := engine.IsEmptyTable(bean)
  1120. if err != nil {
  1121. return err
  1122. }*/
  1123. var isEmpty bool
  1124. if isEmpty {
  1125. err = engine.DropTables(bean)
  1126. if err != nil {
  1127. return err
  1128. }
  1129. err = engine.CreateTables(bean)
  1130. if err != nil {
  1131. return err
  1132. }
  1133. } else {
  1134. for _, col := range table.Columns() {
  1135. isExist, err := engine.dialect.IsColumnExist(tableName, col.Name)
  1136. if err != nil {
  1137. return err
  1138. }
  1139. if !isExist {
  1140. session := engine.NewSession()
  1141. session.Statement.setRefValue(v)
  1142. defer session.Close()
  1143. err = session.addColumn(col.Name)
  1144. if err != nil {
  1145. return err
  1146. }
  1147. }
  1148. }
  1149. for name, index := range table.Indexes {
  1150. session := engine.NewSession()
  1151. session.Statement.setRefValue(v)
  1152. defer session.Close()
  1153. if index.Type == core.UniqueType {
  1154. //isExist, err := session.isIndexExist(table.Name, name, true)
  1155. isExist, err := session.isIndexExist2(tableName, index.Cols, true)
  1156. if err != nil {
  1157. return err
  1158. }
  1159. if !isExist {
  1160. session := engine.NewSession()
  1161. session.Statement.setRefValue(v)
  1162. defer session.Close()
  1163. err = session.addUnique(tableName, name)
  1164. if err != nil {
  1165. return err
  1166. }
  1167. }
  1168. } else if index.Type == core.IndexType {
  1169. isExist, err := session.isIndexExist2(tableName, index.Cols, false)
  1170. if err != nil {
  1171. return err
  1172. }
  1173. if !isExist {
  1174. session := engine.NewSession()
  1175. session.Statement.setRefValue(v)
  1176. defer session.Close()
  1177. err = session.addIndex(tableName, name)
  1178. if err != nil {
  1179. return err
  1180. }
  1181. }
  1182. } else {
  1183. return errors.New("unknow index type")
  1184. }
  1185. }
  1186. }
  1187. }
  1188. return nil
  1189. }
  1190. // Sync2 synchronize structs to database tables
  1191. func (engine *Engine) Sync2(beans ...interface{}) error {
  1192. s := engine.NewSession()
  1193. defer s.Close()
  1194. return s.Sync2(beans...)
  1195. }
  1196. func (engine *Engine) unMap(beans ...interface{}) (e error) {
  1197. engine.mutex.Lock()
  1198. defer engine.mutex.Unlock()
  1199. for _, bean := range beans {
  1200. t := rType(bean)
  1201. if _, ok := engine.Tables[t]; ok {
  1202. delete(engine.Tables, t)
  1203. }
  1204. }
  1205. return
  1206. }
  1207. // Drop all mapped table
  1208. func (engine *Engine) dropAll() error {
  1209. session := engine.NewSession()
  1210. defer session.Close()
  1211. err := session.begin()
  1212. if err != nil {
  1213. return err
  1214. }
  1215. err = session.dropAll()
  1216. if err != nil {
  1217. session.rollback()
  1218. return err
  1219. }
  1220. return session.commit()
  1221. }
  1222. // CreateTables create tabls according bean
  1223. func (engine *Engine) CreateTables(beans ...interface{}) error {
  1224. session := engine.NewSession()
  1225. defer session.Close()
  1226. err := session.begin()
  1227. if err != nil {
  1228. return err
  1229. }
  1230. for _, bean := range beans {
  1231. err = session.CreateTable(bean)
  1232. if err != nil {
  1233. session.rollback()
  1234. return err
  1235. }
  1236. }
  1237. return session.commit()
  1238. }
  1239. // DropTables drop specify tables
  1240. func (engine *Engine) DropTables(beans ...interface{}) error {
  1241. session := engine.NewSession()
  1242. defer session.Close()
  1243. err := session.begin()
  1244. if err != nil {
  1245. return err
  1246. }
  1247. for _, bean := range beans {
  1248. err = session.DropTable(bean)
  1249. if err != nil {
  1250. session.rollback()
  1251. return err
  1252. }
  1253. }
  1254. return session.commit()
  1255. }
  1256. func (engine *Engine) createAll() error {
  1257. session := engine.NewSession()
  1258. defer session.Close()
  1259. return session.createAll()
  1260. }
  1261. // Exec raw sql
  1262. func (engine *Engine) Exec(sql string, args ...interface{}) (sql.Result, error) {
  1263. session := engine.NewSession()
  1264. defer session.Close()
  1265. return session.Exec(sql, args...)
  1266. }
  1267. // Query a raw sql and return records as []map[string][]byte
  1268. func (engine *Engine) Query(sql string, paramStr ...interface{}) (resultsSlice []map[string][]byte, err error) {
  1269. session := engine.NewSession()
  1270. defer session.Close()
  1271. return session.query(sql, paramStr...)
  1272. }
  1273. // Exec a raw sql and return records as []map[string][]byte
  1274. func (engine *Engine) Query2(sql string, paramStr ...interface{}) (resultsSlice []map[string]string, err error) {
  1275. session := engine.NewSession()
  1276. defer session.Close()
  1277. return session.query2(sql, paramStr...)
  1278. }
  1279. // Insert one or more records
  1280. func (engine *Engine) Insert(beans ...interface{}) (int64, error) {
  1281. session := engine.NewSession()
  1282. defer session.Close()
  1283. return session.Insert(beans...)
  1284. }
  1285. // InsertOne insert only one record
  1286. func (engine *Engine) InsertOne(bean interface{}) (int64, error) {
  1287. session := engine.NewSession()
  1288. defer session.Close()
  1289. return session.InsertOne(bean)
  1290. }
  1291. // Update records, bean's non-empty fields are updated contents,
  1292. // condiBean' non-empty filds are conditions
  1293. // CAUTION:
  1294. // 1.bool will defaultly be updated content nor conditions
  1295. // You should call UseBool if you have bool to use.
  1296. // 2.float32 & float64 may be not inexact as conditions
  1297. func (engine *Engine) Update(bean interface{}, condiBeans ...interface{}) (int64, error) {
  1298. session := engine.NewSession()
  1299. defer session.Close()
  1300. return session.Update(bean, condiBeans...)
  1301. }
  1302. // Delete records, bean's non-empty fields are conditions
  1303. func (engine *Engine) Delete(bean interface{}) (int64, error) {
  1304. session := engine.NewSession()
  1305. defer session.Close()
  1306. return session.Delete(bean)
  1307. }
  1308. // Get retrieve one record from table, bean's non-empty fields
  1309. // are conditions
  1310. func (engine *Engine) Get(bean interface{}) (bool, error) {
  1311. session := engine.NewSession()
  1312. defer session.Close()
  1313. return session.Get(bean)
  1314. }
  1315. // Find retrieve records from table, condiBeans's non-empty fields
  1316. // are conditions. beans could be []Struct, []*Struct, map[int64]Struct
  1317. // map[int64]*Struct
  1318. func (engine *Engine) Find(beans interface{}, condiBeans ...interface{}) error {
  1319. session := engine.NewSession()
  1320. defer session.Close()
  1321. return session.Find(beans, condiBeans...)
  1322. }
  1323. // Iterate record by record handle records from table, bean's non-empty fields
  1324. // are conditions.
  1325. func (engine *Engine) Iterate(bean interface{}, fun IterFunc) error {
  1326. session := engine.NewSession()
  1327. defer session.Close()
  1328. return session.Iterate(bean, fun)
  1329. }
  1330. // Rows return sql.Rows compatible Rows obj, as a forward Iterator object for iterating record by record, bean's non-empty fields
  1331. // are conditions.
  1332. func (engine *Engine) Rows(bean interface{}) (*Rows, error) {
  1333. session := engine.NewSession()
  1334. return session.Rows(bean)
  1335. }
  1336. // Count counts the records. bean's non-empty fields are conditions.
  1337. func (engine *Engine) Count(bean interface{}) (int64, error) {
  1338. session := engine.NewSession()
  1339. defer session.Close()
  1340. return session.Count(bean)
  1341. }
  1342. // Sum sum the records by some column. bean's non-empty fields are conditions.
  1343. func (engine *Engine) Sum(bean interface{}, colName string) (float64, error) {
  1344. session := engine.NewSession()
  1345. defer session.Close()
  1346. return session.Sum(bean, colName)
  1347. }
  1348. // Sums sum the records by some columns. bean's non-empty fields are conditions.
  1349. func (engine *Engine) Sums(bean interface{}, colNames ...string) ([]float64, error) {
  1350. session := engine.NewSession()
  1351. defer session.Close()
  1352. return session.Sums(bean, colNames...)
  1353. }
  1354. // SumsInt like Sums but return slice of int64 instead of float64.
  1355. func (engine *Engine) SumsInt(bean interface{}, colNames ...string) ([]int64, error) {
  1356. session := engine.NewSession()
  1357. defer session.Close()
  1358. return session.SumsInt(bean, colNames...)
  1359. }
  1360. // ImportFile SQL DDL file
  1361. func (engine *Engine) ImportFile(ddlPath string) ([]sql.Result, error) {
  1362. file, err := os.Open(ddlPath)
  1363. if err != nil {
  1364. return nil, err
  1365. }
  1366. defer file.Close()
  1367. return engine.Import(file)
  1368. }
  1369. // Import SQL DDL from io.Reader
  1370. func (engine *Engine) Import(r io.Reader) ([]sql.Result, error) {
  1371. var results []sql.Result
  1372. var lastError error
  1373. scanner := bufio.NewScanner(r)
  1374. semiColSpliter := func(data []byte, atEOF bool) (advance int, token []byte, err error) {
  1375. if atEOF && len(data) == 0 {
  1376. return 0, nil, nil
  1377. }
  1378. if i := bytes.IndexByte(data, ';'); i >= 0 {
  1379. return i + 1, data[0:i], nil
  1380. }
  1381. // If we're at EOF, we have a final, non-terminated line. Return it.
  1382. if atEOF {
  1383. return len(data), data, nil
  1384. }
  1385. // Request more data.
  1386. return 0, nil, nil
  1387. }
  1388. scanner.Split(semiColSpliter)
  1389. for scanner.Scan() {
  1390. query := strings.Trim(scanner.Text(), " \t\n\r")
  1391. if len(query) > 0 {
  1392. engine.logSQL(query)
  1393. result, err := engine.DB().Exec(query)
  1394. results = append(results, result)
  1395. if err != nil {
  1396. return nil, err
  1397. //lastError = err
  1398. }
  1399. }
  1400. }
  1401. return results, lastError
  1402. }
  1403. // TZTime change one time to xorm time location
  1404. func (engine *Engine) TZTime(t time.Time) time.Time {
  1405. if !t.IsZero() { // if time is not initialized it's not suitable for Time.In()
  1406. return t.In(engine.TZLocation)
  1407. }
  1408. return t
  1409. }
  1410. // NowTime return current time
  1411. func (engine *Engine) NowTime(sqlTypeName string) interface{} {
  1412. t := time.Now()
  1413. return engine.FormatTime(sqlTypeName, t)
  1414. }
  1415. // NowTime2 return current time
  1416. func (engine *Engine) NowTime2(sqlTypeName string) (interface{}, time.Time) {
  1417. t := time.Now()
  1418. return engine.FormatTime(sqlTypeName, t), t
  1419. }
  1420. // FormatTime format time
  1421. func (engine *Engine) FormatTime(sqlTypeName string, t time.Time) (v interface{}) {
  1422. return engine.formatTime(engine.TZLocation, sqlTypeName, t)
  1423. }
  1424. func (engine *Engine) formatColTime(col *core.Column, t time.Time) (v interface{}) {
  1425. if col.DisableTimeZone {
  1426. return engine.formatTime(nil, col.SQLType.Name, t)
  1427. } else if col.TimeZone != nil {
  1428. return engine.formatTime(col.TimeZone, col.SQLType.Name, t)
  1429. }
  1430. return engine.formatTime(engine.TZLocation, col.SQLType.Name, t)
  1431. }
  1432. func (engine *Engine) formatTime(tz *time.Location, sqlTypeName string, t time.Time) (v interface{}) {
  1433. if engine.dialect.DBType() == core.ORACLE {
  1434. return t
  1435. }
  1436. if tz != nil {
  1437. t = t.In(tz)
  1438. } else {
  1439. t = engine.TZTime(t)
  1440. }
  1441. switch sqlTypeName {
  1442. case core.Time:
  1443. s := t.Format("2006-01-02 15:04:05") //time.RFC3339
  1444. v = s[11:19]
  1445. case core.Date:
  1446. v = t.Format("2006-01-02")
  1447. case core.DateTime, core.TimeStamp:
  1448. if engine.dialect.DBType() == "ql" {
  1449. v = t
  1450. } else if engine.dialect.DBType() == "sqlite3" {
  1451. v = t.UTC().Format("2006-01-02 15:04:05")
  1452. } else {
  1453. v = t.Format("2006-01-02 15:04:05")
  1454. }
  1455. case core.TimeStampz:
  1456. if engine.dialect.DBType() == core.MSSQL {
  1457. v = t.Format("2006-01-02T15:04:05.9999999Z07:00")
  1458. } else if engine.DriverName() == "mssql" {
  1459. v = t
  1460. } else {
  1461. v = t.Format(time.RFC3339Nano)
  1462. }
  1463. case core.BigInt, core.Int:
  1464. v = t.Unix()
  1465. default:
  1466. v = t
  1467. }
  1468. return
  1469. }
  1470. // Unscoped always disable struct tag "deleted"
  1471. func (engine *Engine) Unscoped() *Session {
  1472. session := engine.NewSession()
  1473. session.IsAutoClose = true
  1474. return session.Unscoped()
  1475. }