engine.go 47 KB

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