engine.go 45 KB

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