engine.go 47 KB

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