tx.go 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356
  1. // Code generated by ent, DO NOT EDIT.
  2. package ent
  3. import (
  4. "context"
  5. stdsql "database/sql"
  6. "fmt"
  7. "sync"
  8. "entgo.io/ent/dialect"
  9. )
  10. // Tx is a transactional client that is created by calling Client.Tx().
  11. type Tx struct {
  12. config
  13. // Agent is the client for interacting with the Agent builders.
  14. Agent *AgentClient
  15. // AgentBase is the client for interacting with the AgentBase builders.
  16. AgentBase *AgentBaseClient
  17. // AliyunAvatar is the client for interacting with the AliyunAvatar builders.
  18. AliyunAvatar *AliyunAvatarClient
  19. // AllocAgent is the client for interacting with the AllocAgent builders.
  20. AllocAgent *AllocAgentClient
  21. // ApiKey is the client for interacting with the ApiKey builders.
  22. ApiKey *ApiKeyClient
  23. // BatchMsg is the client for interacting with the BatchMsg builders.
  24. BatchMsg *BatchMsgClient
  25. // Category is the client for interacting with the Category builders.
  26. Category *CategoryClient
  27. // ChatRecords is the client for interacting with the ChatRecords builders.
  28. ChatRecords *ChatRecordsClient
  29. // ChatSession is the client for interacting with the ChatSession builders.
  30. ChatSession *ChatSessionClient
  31. // Contact is the client for interacting with the Contact builders.
  32. Contact *ContactClient
  33. // CreditBalance is the client for interacting with the CreditBalance builders.
  34. CreditBalance *CreditBalanceClient
  35. // CreditUsage is the client for interacting with the CreditUsage builders.
  36. CreditUsage *CreditUsageClient
  37. // Employee is the client for interacting with the Employee builders.
  38. Employee *EmployeeClient
  39. // EmployeeConfig is the client for interacting with the EmployeeConfig builders.
  40. EmployeeConfig *EmployeeConfigClient
  41. // Label is the client for interacting with the Label builders.
  42. Label *LabelClient
  43. // LabelRelationship is the client for interacting with the LabelRelationship builders.
  44. LabelRelationship *LabelRelationshipClient
  45. // LabelTagging is the client for interacting with the LabelTagging builders.
  46. LabelTagging *LabelTaggingClient
  47. // Message is the client for interacting with the Message builders.
  48. Message *MessageClient
  49. // MessageRecords is the client for interacting with the MessageRecords builders.
  50. MessageRecords *MessageRecordsClient
  51. // Msg is the client for interacting with the Msg builders.
  52. Msg *MsgClient
  53. // PayRecharge is the client for interacting with the PayRecharge builders.
  54. PayRecharge *PayRechargeClient
  55. // Server is the client for interacting with the Server builders.
  56. Server *ServerClient
  57. // SopNode is the client for interacting with the SopNode builders.
  58. SopNode *SopNodeClient
  59. // SopStage is the client for interacting with the SopStage builders.
  60. SopStage *SopStageClient
  61. // SopTask is the client for interacting with the SopTask builders.
  62. SopTask *SopTaskClient
  63. // Token is the client for interacting with the Token builders.
  64. Token *TokenClient
  65. // Tutorial is the client for interacting with the Tutorial builders.
  66. Tutorial *TutorialClient
  67. // UsageDetail is the client for interacting with the UsageDetail builders.
  68. UsageDetail *UsageDetailClient
  69. // UsageStatisticDay is the client for interacting with the UsageStatisticDay builders.
  70. UsageStatisticDay *UsageStatisticDayClient
  71. // UsageStatisticHour is the client for interacting with the UsageStatisticHour builders.
  72. UsageStatisticHour *UsageStatisticHourClient
  73. // UsageStatisticMonth is the client for interacting with the UsageStatisticMonth builders.
  74. UsageStatisticMonth *UsageStatisticMonthClient
  75. // UsageTotal is the client for interacting with the UsageTotal builders.
  76. UsageTotal *UsageTotalClient
  77. // Whatsapp is the client for interacting with the Whatsapp builders.
  78. Whatsapp *WhatsappClient
  79. // WhatsappChannel is the client for interacting with the WhatsappChannel builders.
  80. WhatsappChannel *WhatsappChannelClient
  81. // WorkExperience is the client for interacting with the WorkExperience builders.
  82. WorkExperience *WorkExperienceClient
  83. // WpChatroom is the client for interacting with the WpChatroom builders.
  84. WpChatroom *WpChatroomClient
  85. // WpChatroomMember is the client for interacting with the WpChatroomMember builders.
  86. WpChatroomMember *WpChatroomMemberClient
  87. // Wx is the client for interacting with the Wx builders.
  88. Wx *WxClient
  89. // WxCard is the client for interacting with the WxCard builders.
  90. WxCard *WxCardClient
  91. // WxCardUser is the client for interacting with the WxCardUser builders.
  92. WxCardUser *WxCardUserClient
  93. // WxCardVisit is the client for interacting with the WxCardVisit builders.
  94. WxCardVisit *WxCardVisitClient
  95. // lazily loaded.
  96. client *Client
  97. clientOnce sync.Once
  98. // ctx lives for the life of the transaction. It is
  99. // the same context used by the underlying connection.
  100. ctx context.Context
  101. }
  102. type (
  103. // Committer is the interface that wraps the Commit method.
  104. Committer interface {
  105. Commit(context.Context, *Tx) error
  106. }
  107. // The CommitFunc type is an adapter to allow the use of ordinary
  108. // function as a Committer. If f is a function with the appropriate
  109. // signature, CommitFunc(f) is a Committer that calls f.
  110. CommitFunc func(context.Context, *Tx) error
  111. // CommitHook defines the "commit middleware". A function that gets a Committer
  112. // and returns a Committer. For example:
  113. //
  114. // hook := func(next ent.Committer) ent.Committer {
  115. // return ent.CommitFunc(func(ctx context.Context, tx *ent.Tx) error {
  116. // // Do some stuff before.
  117. // if err := next.Commit(ctx, tx); err != nil {
  118. // return err
  119. // }
  120. // // Do some stuff after.
  121. // return nil
  122. // })
  123. // }
  124. //
  125. CommitHook func(Committer) Committer
  126. )
  127. // Commit calls f(ctx, m).
  128. func (f CommitFunc) Commit(ctx context.Context, tx *Tx) error {
  129. return f(ctx, tx)
  130. }
  131. // Commit commits the transaction.
  132. func (tx *Tx) Commit() error {
  133. txDriver := tx.config.driver.(*txDriver)
  134. var fn Committer = CommitFunc(func(context.Context, *Tx) error {
  135. return txDriver.tx.Commit()
  136. })
  137. txDriver.mu.Lock()
  138. hooks := append([]CommitHook(nil), txDriver.onCommit...)
  139. txDriver.mu.Unlock()
  140. for i := len(hooks) - 1; i >= 0; i-- {
  141. fn = hooks[i](fn)
  142. }
  143. return fn.Commit(tx.ctx, tx)
  144. }
  145. // OnCommit adds a hook to call on commit.
  146. func (tx *Tx) OnCommit(f CommitHook) {
  147. txDriver := tx.config.driver.(*txDriver)
  148. txDriver.mu.Lock()
  149. txDriver.onCommit = append(txDriver.onCommit, f)
  150. txDriver.mu.Unlock()
  151. }
  152. type (
  153. // Rollbacker is the interface that wraps the Rollback method.
  154. Rollbacker interface {
  155. Rollback(context.Context, *Tx) error
  156. }
  157. // The RollbackFunc type is an adapter to allow the use of ordinary
  158. // function as a Rollbacker. If f is a function with the appropriate
  159. // signature, RollbackFunc(f) is a Rollbacker that calls f.
  160. RollbackFunc func(context.Context, *Tx) error
  161. // RollbackHook defines the "rollback middleware". A function that gets a Rollbacker
  162. // and returns a Rollbacker. For example:
  163. //
  164. // hook := func(next ent.Rollbacker) ent.Rollbacker {
  165. // return ent.RollbackFunc(func(ctx context.Context, tx *ent.Tx) error {
  166. // // Do some stuff before.
  167. // if err := next.Rollback(ctx, tx); err != nil {
  168. // return err
  169. // }
  170. // // Do some stuff after.
  171. // return nil
  172. // })
  173. // }
  174. //
  175. RollbackHook func(Rollbacker) Rollbacker
  176. )
  177. // Rollback calls f(ctx, m).
  178. func (f RollbackFunc) Rollback(ctx context.Context, tx *Tx) error {
  179. return f(ctx, tx)
  180. }
  181. // Rollback rollbacks the transaction.
  182. func (tx *Tx) Rollback() error {
  183. txDriver := tx.config.driver.(*txDriver)
  184. var fn Rollbacker = RollbackFunc(func(context.Context, *Tx) error {
  185. return txDriver.tx.Rollback()
  186. })
  187. txDriver.mu.Lock()
  188. hooks := append([]RollbackHook(nil), txDriver.onRollback...)
  189. txDriver.mu.Unlock()
  190. for i := len(hooks) - 1; i >= 0; i-- {
  191. fn = hooks[i](fn)
  192. }
  193. return fn.Rollback(tx.ctx, tx)
  194. }
  195. // OnRollback adds a hook to call on rollback.
  196. func (tx *Tx) OnRollback(f RollbackHook) {
  197. txDriver := tx.config.driver.(*txDriver)
  198. txDriver.mu.Lock()
  199. txDriver.onRollback = append(txDriver.onRollback, f)
  200. txDriver.mu.Unlock()
  201. }
  202. // Client returns a Client that binds to current transaction.
  203. func (tx *Tx) Client() *Client {
  204. tx.clientOnce.Do(func() {
  205. tx.client = &Client{config: tx.config}
  206. tx.client.init()
  207. })
  208. return tx.client
  209. }
  210. func (tx *Tx) init() {
  211. tx.Agent = NewAgentClient(tx.config)
  212. tx.AgentBase = NewAgentBaseClient(tx.config)
  213. tx.AliyunAvatar = NewAliyunAvatarClient(tx.config)
  214. tx.AllocAgent = NewAllocAgentClient(tx.config)
  215. tx.ApiKey = NewApiKeyClient(tx.config)
  216. tx.BatchMsg = NewBatchMsgClient(tx.config)
  217. tx.Category = NewCategoryClient(tx.config)
  218. tx.ChatRecords = NewChatRecordsClient(tx.config)
  219. tx.ChatSession = NewChatSessionClient(tx.config)
  220. tx.Contact = NewContactClient(tx.config)
  221. tx.CreditBalance = NewCreditBalanceClient(tx.config)
  222. tx.CreditUsage = NewCreditUsageClient(tx.config)
  223. tx.Employee = NewEmployeeClient(tx.config)
  224. tx.EmployeeConfig = NewEmployeeConfigClient(tx.config)
  225. tx.Label = NewLabelClient(tx.config)
  226. tx.LabelRelationship = NewLabelRelationshipClient(tx.config)
  227. tx.LabelTagging = NewLabelTaggingClient(tx.config)
  228. tx.Message = NewMessageClient(tx.config)
  229. tx.MessageRecords = NewMessageRecordsClient(tx.config)
  230. tx.Msg = NewMsgClient(tx.config)
  231. tx.PayRecharge = NewPayRechargeClient(tx.config)
  232. tx.Server = NewServerClient(tx.config)
  233. tx.SopNode = NewSopNodeClient(tx.config)
  234. tx.SopStage = NewSopStageClient(tx.config)
  235. tx.SopTask = NewSopTaskClient(tx.config)
  236. tx.Token = NewTokenClient(tx.config)
  237. tx.Tutorial = NewTutorialClient(tx.config)
  238. tx.UsageDetail = NewUsageDetailClient(tx.config)
  239. tx.UsageStatisticDay = NewUsageStatisticDayClient(tx.config)
  240. tx.UsageStatisticHour = NewUsageStatisticHourClient(tx.config)
  241. tx.UsageStatisticMonth = NewUsageStatisticMonthClient(tx.config)
  242. tx.UsageTotal = NewUsageTotalClient(tx.config)
  243. tx.Whatsapp = NewWhatsappClient(tx.config)
  244. tx.WhatsappChannel = NewWhatsappChannelClient(tx.config)
  245. tx.WorkExperience = NewWorkExperienceClient(tx.config)
  246. tx.WpChatroom = NewWpChatroomClient(tx.config)
  247. tx.WpChatroomMember = NewWpChatroomMemberClient(tx.config)
  248. tx.Wx = NewWxClient(tx.config)
  249. tx.WxCard = NewWxCardClient(tx.config)
  250. tx.WxCardUser = NewWxCardUserClient(tx.config)
  251. tx.WxCardVisit = NewWxCardVisitClient(tx.config)
  252. }
  253. // txDriver wraps the given dialect.Tx with a nop dialect.Driver implementation.
  254. // The idea is to support transactions without adding any extra code to the builders.
  255. // When a builder calls to driver.Tx(), it gets the same dialect.Tx instance.
  256. // Commit and Rollback are nop for the internal builders and the user must call one
  257. // of them in order to commit or rollback the transaction.
  258. //
  259. // If a closed transaction is embedded in one of the generated entities, and the entity
  260. // applies a query, for example: Agent.QueryXXX(), the query will be executed
  261. // through the driver which created this transaction.
  262. //
  263. // Note that txDriver is not goroutine safe.
  264. type txDriver struct {
  265. // the driver we started the transaction from.
  266. drv dialect.Driver
  267. // tx is the underlying transaction.
  268. tx dialect.Tx
  269. // completion hooks.
  270. mu sync.Mutex
  271. onCommit []CommitHook
  272. onRollback []RollbackHook
  273. }
  274. // newTx creates a new transactional driver.
  275. func newTx(ctx context.Context, drv dialect.Driver) (*txDriver, error) {
  276. tx, err := drv.Tx(ctx)
  277. if err != nil {
  278. return nil, err
  279. }
  280. return &txDriver{tx: tx, drv: drv}, nil
  281. }
  282. // Tx returns the transaction wrapper (txDriver) to avoid Commit or Rollback calls
  283. // from the internal builders. Should be called only by the internal builders.
  284. func (tx *txDriver) Tx(context.Context) (dialect.Tx, error) { return tx, nil }
  285. // Dialect returns the dialect of the driver we started the transaction from.
  286. func (tx *txDriver) Dialect() string { return tx.drv.Dialect() }
  287. // Close is a nop close.
  288. func (*txDriver) Close() error { return nil }
  289. // Commit is a nop commit for the internal builders.
  290. // User must call `Tx.Commit` in order to commit the transaction.
  291. func (*txDriver) Commit() error { return nil }
  292. // Rollback is a nop rollback for the internal builders.
  293. // User must call `Tx.Rollback` in order to rollback the transaction.
  294. func (*txDriver) Rollback() error { return nil }
  295. // Exec calls tx.Exec.
  296. func (tx *txDriver) Exec(ctx context.Context, query string, args, v any) error {
  297. return tx.tx.Exec(ctx, query, args, v)
  298. }
  299. // Query calls tx.Query.
  300. func (tx *txDriver) Query(ctx context.Context, query string, args, v any) error {
  301. return tx.tx.Query(ctx, query, args, v)
  302. }
  303. var _ dialect.Driver = (*txDriver)(nil)
  304. // ExecContext allows calling the underlying ExecContext method of the transaction if it is supported by it.
  305. // See, database/sql#Tx.ExecContext for more information.
  306. func (tx *txDriver) ExecContext(ctx context.Context, query string, args ...any) (stdsql.Result, error) {
  307. ex, ok := tx.tx.(interface {
  308. ExecContext(context.Context, string, ...any) (stdsql.Result, error)
  309. })
  310. if !ok {
  311. return nil, fmt.Errorf("Tx.ExecContext is not supported")
  312. }
  313. return ex.ExecContext(ctx, query, args...)
  314. }
  315. // QueryContext allows calling the underlying QueryContext method of the transaction if it is supported by it.
  316. // See, database/sql#Tx.QueryContext for more information.
  317. func (tx *txDriver) QueryContext(ctx context.Context, query string, args ...any) (*stdsql.Rows, error) {
  318. q, ok := tx.tx.(interface {
  319. QueryContext(context.Context, string, ...any) (*stdsql.Rows, error)
  320. })
  321. if !ok {
  322. return nil, fmt.Errorf("Tx.QueryContext is not supported")
  323. }
  324. return q.QueryContext(ctx, query, args...)
  325. }