Docs 主页

/ /

Kotlin Coroutine 驱动程序

Docs 主页

客户端库

Kotlin

Kotlin Coroutine 驱动程序

Docs 主页

客户端库

Kotlin

Kotlin Coroutine 驱动程序

事务

Overview

在本指南中，您可以了解如何使用 Kotlin 驱动程序执行事务。事务允许您运行一系列操作，这些操作在提交事务之前不会更改任何数据。如果事务中的任何操作返回错误，驱动程序就会取消事务，并在所有数据更改变得可见之前将其丢弃。

在 MongoDB 中，事务在逻辑会话中运行。会话是一组要按顺序运行的相关读取或写入操作。会话可以实现一组操作的因果一致性，或支持在 ACID 事务中执行操作。MongoDB 保证事务操作中涉及的数据保持一致，即使操作遇到意外错误。

使用Kotlin驱动程序时，您可以从 MongoClient实例创建新会话作为 ClientSession。我们建议您将客户端重复用于多个会话和事务，而不是每次都实例化一个新客户端。

警告

仅应将 ClientSession 与创建它的 MongoClient（或关联的 MongoDatabase 或 MongoCollection）一起使用。将 ClientSession 与其他 MongoClient 一起使用会导致操作错误。

因果一致性(Causal Consistency)

MongoDB在某些客户端会话中实现因果一致性。因果一致性模型ACID 一致性保证在分布式系统中，会话中的操作按因果顺序运行。客户端观察到的结果与因果关系或操作之间的依赖关系一致。示例，如果您执行一系列操作，其中一个操作在逻辑上依赖于另一个操作的结果，则任何后续读取都会反映这种依赖关系。

为了保证因果一致性，客户端端会话必须满足以下要求：

启动会话时，驱动程序必须启用因果一致性选项。该选项默认启用。
操作必须在单个线程的单个会话中运行。否则，会话或线程必须相互传达操作时间和集群时间值。要查看传达这些值的两个会话的示例，请参阅MongoDB服务器手册中的因果一致性示例。
您必须使用 ReadConcern.MAJORITY读关注（read concern）。
您必须使用 WriteConcern.MAJORITY写关注（write concern）。这是默认的写关注（write concern）值。

下表描述了因果一致会话提供的ACID 一致性保证：

保证	说明
读取写入操作	读取操作会反映之前写入操作的结果。
单调读取	读取操作不会返回反映比先前读取操作更早的数据状态的结果。
单调写入	如果写入操作必须先于其他写入操作，则服务器会先运行此写入操作。示例，如果调用 `insertOne()` 插入文档，然后调用 `updateOne()` 修改插入的文档，则服务器首先运行插入操作。
读取后写入	如果写入操作必须在其他读取操作之后执行，服务器会先执行读取操作。示例，如果您调用 `find()` 来检索文档，然后调用 `deleteOne()` 来删除检索到的文档，则服务器会先运行查找操作。

提示

要学习；了解有关本节中提到的概念的更多信息，请参阅以下MongoDB服务器手册条目：

方法

在Client实例上使用startSession()方法创建ClientSession 。然后，您可以使用以下方法修改会话状态：

方法	说明
`startTransaction()`	Starts a new transaction for this session with the default transaction options. You cannot start a transaction if there's already an active transaction on the session. To set transaction options, use `startTransaction(transactionOptions: TransactionOptions)`.
`abortTransaction()`	Ends the active transaction for this session. Returns an error if there is no active transaction for the session or the transaction was previously ended.
`commitTransaction()`	Commits the active transaction for this session. Returns an error if there is no active transaction for the session or if the transaction was ended.

提示

事务超时

您可以在事务中设立操作完成所需的时间限制。要学习；了解更多信息，请参阅《限制服务器执行时间》指南中的事务部分。

ClientSession 还提供检索会话属性和修改可变会话属性的方法。查看API文档以学习；了解有关这些方法的更多信息。

例子

此示例使用以下Kotlin数据类对其文档进行建模：

data class Account(
    val accountId: String,
    val amount: Int
)

以下示例演示了如何创建会话、创建ACID 事务以及提交对现有文档的更改：

使用 startSession() 方法从客户端创建会话。
使用 startTransaction() 方法启动事务。
更新指定文档，如果所有操作都成功，则使用commitTransaction()方法；如果任何操作失败，则使用abortTransaction()方法。

// Set up the session
val session = client.startSession()
try {
    session.startTransaction()
    val savingsColl = database
        .getCollection<Account>("savings_accounts")
    val checkingColl = database
        .getCollection<Account>("checking_accounts")
    savingsColl.findOneAndUpdate(
        session,
        eq(Account::accountId.name, "9876"),
        inc(Account::amount.name, -100),
    )
    checkingColl.findOneAndUpdate(
        session,
        eq(Account::accountId.name, "9876"),
        inc(Account::amount.name, 100)
    )
    // Commit the transaction
    val result = session.commitTransaction()
    println("Transaction committed.")
} catch (error: Exception) {
    println("An error occurred during the transaction: ${error.message}")
    // Abort the transaction
    session.abortTransaction()
}

注意

不支持并行操作

Kotlin驱动程序不支持在单个事务中运行并行操作。

如果您使用的是MongoDB 服务器 v8.0 或更高版本，则可以使用批量写入操作在单个ACID 事务中对多个命名空间执行写入操作。要学习；了解更多信息，请参阅批量操作指南。

Overview

警告

因果一致性(Causal Consistency)

提示

方法

提示

事务超时

例子

注意

不支持并行操作

更多信息

API 文档