engine.go 47 KB

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