engine.go 45 KB

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