engine.go 46 KB

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