engine.go 45 KB

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