SDK數(shù)據(jù)庫(kù) database·發(fā)起事務(wù)

Database.runTransaction(callback: function, times: number): Promise<any>

支持端：云函數(shù)

發(fā)起事務(wù)。僅可在云函數(shù)中使用。

參數(shù)

callback: function

事務(wù)執(zhí)行函數(shù)，需為 async 異步函數(shù)或返回 Promise 的函數(shù)

times: number

事務(wù)執(zhí)行最多次數(shù)，默認(rèn) 3 次，成功后不重復(fù)執(zhí)行，只有事務(wù)沖突時(shí)會(huì)重試，其他異常時(shí)不會(huì)重試

返回值

Promise.<any>

resolve 的結(jié)果為 callback 事務(wù)執(zhí)行函數(shù)的返回值，reject 的結(jié)果為事務(wù)執(zhí)行過(guò)程中拋出的異?；蛘呤?transaction.rollback 傳入的值

事務(wù)執(zhí)行函數(shù)說(shuō)明

事務(wù)執(zhí)行函數(shù)由開(kāi)發(fā)者傳入，函數(shù)接收一個(gè)參數(shù) transaction（類型定義見(jiàn) Transaction），其上提供 collection 方法和 rollback 方法。collection 方法用于取數(shù)據(jù)庫(kù)集合記錄引用進(jìn)行操作，rollback 方法用于在不想繼續(xù)執(zhí)行事務(wù)時(shí)終止并回滾事務(wù)。

事務(wù)執(zhí)行函數(shù)必須為 async 異步函數(shù)或返回 Promise 的函數(shù)，當(dāng)事務(wù)執(zhí)行函數(shù)返回時(shí)，SDK 會(huì)認(rèn)為用戶邏輯已完成，自動(dòng)提交（commit）事務(wù)，因此務(wù)必確保用戶事務(wù)邏輯完成后才在 async 異步函數(shù)中返回或 resolve Promise。

事務(wù)執(zhí)行函數(shù)可能會(huì)被執(zhí)行多次，在內(nèi)部發(fā)現(xiàn)事務(wù)沖突時(shí)會(huì)自動(dòng)重復(fù)執(zhí)行，如果超過(guò)設(shè)定的執(zhí)行次數(shù)上限，會(huì)報(bào)錯(cuò)退出。

在事務(wù)執(zhí)行函數(shù)中發(fā)生的錯(cuò)誤，都會(huì)認(rèn)為事務(wù)執(zhí)行失敗而拋錯(cuò)。

事務(wù)執(zhí)行函數(shù)返回的值會(huì)作為 runTransaction 返回的 Promise resolve 的值，在函數(shù)中拋出的異常會(huì)作為 runTransaction 返回的 Promise reject 的值，如果事務(wù)執(zhí)行函數(shù)中調(diào)用了 transaction.rollback，則傳入 rollback 函數(shù)的值會(huì)作為 runTransaction 返回的 Promise reject 的值。

限制

事務(wù)現(xiàn)僅支持在云函數(shù) wx-server-sdk 使用。事務(wù)操作時(shí)為保障效率和并發(fā)性，只允許進(jìn)行單記錄操作，不允許進(jìn)行批量操作，但可以在一個(gè)事務(wù)中對(duì)多個(gè)記錄進(jìn)行操作。

注意事項(xiàng)

開(kāi)發(fā)者提供的事務(wù)執(zhí)行函數(shù)正常返回時(shí)，SDK 會(huì)自動(dòng)提交（commit）事務(wù)，請(qǐng)勿在事務(wù)執(zhí)行函數(shù)內(nèi)調(diào)用 transaction.commit 方法，該方法僅在通過(guò) db.startTransaction 進(jìn)行事務(wù)操作時(shí)使用。

示例代碼

兩個(gè)賬戶之間進(jìn)行轉(zhuǎn)賬的簡(jiǎn)易示例

const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV
})
const db = cloud.database({
  throwOnNotFound: false,
})
const _ = db.command

exports.main = async (event) => {
  try {
    const result = await db.runTransaction(async transaction => {
      const aaaRes = await transaction.collection('account').doc('aaa').get()
      const bbbRes = await transaction.collection('account').doc('bbb').get()

      if (aaaRes.data && bbbRes.data) {
        const updateAAARes = await transaction.collection('account').doc('aaa').update({
          data: {
            amount: _.inc(-10)
          }
        })

        const updateBBBRes = await transaction.collection('account').doc('bbb').update({
          data: {
            amount: _.inc(10)
          }
        })

        console.log(`transaction succeeded`)

        // 會(huì)作為 runTransaction resolve 的結(jié)果返回
        return {
          aaaAccount: aaaRes.data.amount - 10,
        }
      } else {
        // 會(huì)作為 runTransaction reject 的結(jié)果出去
        await transaction.rollback(-100)
      }
    })

    return {
      success: true,
      aaaAccount: result.aaaAccount,
    }
  } catch (e) {
    console.error(`transaction error`, e)

    return {
      success: false,
      error: e
    }
  }
}