トランザクション
API
1つのトランザクション内で複数のステートメントを実行する場合は、transaction 関数を使用します。
val players = listOf<Player>()
database.playerQueries.transaction {
players.forEach { player ->
database.playerQueries.insert(
player_number = player.number,
full_name = player.fullName
)
}
}トランザクションから値を返すには、transactionWithResult 関数を使用します。
val players: List<Player> = database.playerQueries.transactionWithResult {
database.playerQueries.selectAll().executeAsList()
}ロールバック
トランザクション内で例外が発生すると、そのトランザクションはロールバックされます。トランザクション内の任意の場所で手動でロールバックすることも可能ですが、トランザクションが値を返す場合は、そのトランザクションが戻り値として返す値を指定する必要があります。
database.playerQueries.transaction {
players.forEach { player ->
if (player.number == 0) rollback()
database.playerQueries.insert(
player_number = player.number,
full_name = player.fullName
)
}
}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
}コールバック
トランザクションが完了またはロールバックした後に実行されるコールバックを登録できます。
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 を使用する場合、クエリ結果は制限されたサイズ(デフォルトで 2 MB)の CursorWindow を介して読み取られます。結果が1つのウィンドウに収まらない場合、AndroidSqliteDriver は次のウィンドウを埋めるためにステートメントを再実行します。トランザクション外で実行されたクエリは、ウィンドウの処理間に別のスレッドによってコミットされた変更を検知する可能性があり、データベースから一貫性のない行を返すことがあります。
大規模なクエリが単一の一貫したスナップショットを読み取ることを保証するには、トランザクション内でクエリを実行してください。
val players: List<Player> = database.playerQueries.transactionWithResult {
database.playerQueries.selectAll().executeAsList()
}トランザクションを使用すると、他の書き込み処理はそのトランザクションが終了するまで待機することになります。
AndroidSqliteDriver(API 28以降)でより大きな windowSizeBytes を設定することで、追加ウィンドウの作成を回避できます。
情報
結果が1つのウィンドウに収まらない可能性がある、RETURNING 句を含む INSERT、UPDATE、または DELETE ステートメントの使用は避けてください。追加のウィンドウごとにステートメントが再実行されるため、変更が複数回適用されてしまいます。トランザクションを使用してもこれを防ぐことはできません。
