engine.go 46 KB

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