engine.go 45 KB

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