Skip to content

事务 ​

API ​

如果您想在单个事务下执行多个语句,请使用 transaction 函数。

kotlin
val players = listOf<Player>()
database.playerQueries.transaction {
  players.forEach { player ->
    database.playerQueries.insert(
      player_number = player.number,
      full_name = player.fullName
    )
  }
}

要从事务中返回值,请使用 transactionWithResult 函数。

kotlin
val players: List<Player> = database.playerQueries.transactionWithResult {
  database.playerQueries.selectAll().executeAsList()
}

回滚 ​

如果事务中的任何位置发生异常,事务都将回滚。您可以在事务内部的任何位置手动回滚事务,但如果您的事务返回一个值,则需要为该事务指定一个要返回的值。

kotlin
database.playerQueries.transaction {
  players.forEach { player ->
    if (player.number == 0) rollback()
    database.playerQueries.insert(
      player_number = player.number,
      full_name = player.fullName
    )
  }
}
kotlin
val numberInserted: Int = database.playerQueries.transactionWithResult {
  players.forEach { player ->
    if (player.number == 0) rollback(0)
    database.playerQueries.insert(
      player_number = player.number,
      full_name = player.fullName
    )
  }
  players.size
}

回调 ​

您可以注册在事务完成或回滚后触发的回调:

kotlin
database.playerQueries.transaction {
  afterRollback { log("No players were inserted.") }
  afterCommit { log("${players.size} players were inserted.") }

  players.forEach { player ->
    database.playerQueries.insert(
      player_number = player.number,
      full_name = player.fullName
    )
  }
}

大型查询的一致性 ​

使用 AndroidSqliteDriver 时,查询结果是通过大小有限的 CursorWindow(默认 2 MB)读取的。当结果无法完全容纳在一个窗口中时,AndroidSqliteDriver 会再次执行该语句以填充下一个窗口。在事务外部执行的查询可能会观察到其他线程在窗口切换之间提交的更改,从而从数据库返回不一致的行。

为了确保大型查询读取到单一且一致的快照,请在事务内部执行该查询。

kotlin
val players: List<Player> = database.playerQueries.transactionWithResult {
  database.playerQueries.selectAll().executeAsList()
}

使用事务意味着其他写入者需要等待,直到该事务结束。

在 AndroidSqliteDriver(API 28+)上设置更大的 windowSizeBytes 可以避免创建额外的窗口。

信息

避免使用带有 RETURNING 子句且结果可能无法容纳在一个窗口中的 INSERT、UPDATE 或 DELETE 语句。该语句会针对每个额外的窗口再次执行,因此其更改会被应用多次。事务无法防止这种情况发生。