engine.go 47 KB

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