engine.go 47 KB

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