一括書き込み操作

サンプル データ

The examples in this section use the restaurants collection in the sample_restaurants database from the Atlas sample datasets. To access this collection from your Scala application, create a MongoClient that connects to an Atlas cluster and assign the following values to your database and collection variables:

val database: MongoDatabase = mongoClient.getDatabase("sample_restaurants")
val collection: MongoCollection[Document] = database.getCollection("restaurants")

MongoDB Atlasクラスターを無料で作成して、サンプルデータセットをロードする方法については、MongoDBを使い始めるガイドを参照してください。

挿入操作

挿入操作を実行するには、 InsertOneModelインスタンスを作成し、挿入するドキュメントを指定します。

次の例では、 InsertOneModelのインスタンスを作成しています。

val insertOneModel = InsertOneModel(
    Document("name" -> "Blue Moon Grill",
             "borough" -> "Brooklyn",
             "cuisine" -> "American")
)

複数のドキュメントを挿入するには、ドキュメントごとにInsertOneModelのインスタンスを作成します。

アップデート操作

ドキュメントを更新するには、 UpdateOneModelのインスタンスを作成し、次の引数を渡します。

• コレクション内のドキュメントをマッチングするために使用される基準を指定するクエリフィルター。

• Update operation that you want to perform. To learn more about update operations, see the Field Update Operators guide in the MongoDB Server manual.

次の例では、 UpdateOneModelのインスタンスを作成しています。

val updateOneFilter = equal("name", "White Horse Tavern")
val updateOneDoc = set("borough", "Queens")
val updateOneModel = UpdateOneModel(updateOneFilter, updateOneDoc)

複数のドキュメントが UpdateOneModelインスタンスで指定されたクエリフィルターに一致する場合、この操作最初の結果が更新されます。 次のコードに示すように、ドライバーが 更新操作 を実行する前に、一致したドキュメントに順序を適用するために、UpdateOptionsインスタンスで並べ替えを指定できます。

val options = UpdateOptions.sort(ascending("name"))

複数のドキュメントを更新するには、UpdateManyModel のインスタンスを作成し、UpdateOneModel と同じ引数を渡します。UpdateManyModelクラスは、クエリフィルターに一致するすべてのドキュメントのアップデートを指定します。

次の例では、 UpdateManyModelのインスタンスを作成しています。

val updateManyFilter = equal("name", "Wendy's")
val updateManyDoc = set("cuisine", "Fast food")
val updateManyModel = UpdateManyModel(updateManyFilter, updateManyDoc)

置換操作

置換操作、指定されたドキュメントのすべてのフィールドと値が削除され、指定した新しいフィールドと値に置き換えられます。 置換操作 を実行するには、ReplaceOneModel のインスタンスを作成し、次の引数を渡します。

• コレクション内のドキュメントをマッチングするために使用される基準を指定するクエリフィルター

• 挿入する新しいフィールドと値を指定する置換ドキュメント

次の例では、 ReplaceOneModelのインスタンスを作成しています。

val replaceFilter = equal("name", "Cooper Town Diner")
val replaceDoc = Document("name" -> "Smith Town Diner",
                          "borough" -> "Brooklyn",
                          "cuisine" -> "American")
val replaceOneModel = ReplaceOneModel(replaceFilter, replaceDoc)

複数のドキュメントが ReplaceOneModelインスタンスで指定されたクエリフィルターに一致する場合、その操作は最初の結果を置き換えます。 次のコードに示すように、ドライバーが置換操作を実行する前に、一致したドキュメントに順序を適用するために、ReplaceOptionsインスタンスで並べ替えを指定できます。

val options = ReplaceOptions.sort(ascending("name"))

削除操作

ドキュメントを削除するには、 DeleteOneModelのインスタンスを作成し、削除するドキュメントを指定するクエリフィルターを渡します。 DeleteOneModelインスタンスには、クエリフィルターに一致する最初のドキュメントのみを削除するための手順が記載されています。

次の例では、 DeleteOneModelのインスタンスを作成しています。

val deleteOneModel = DeleteOneModel(equal("name", "Morris Park Bake Shop"))

複数のドキュメントを削除するには、 DeleteManyModelのインスタンスを作成し、削除するドキュメントを指定してクエリフィルターを渡します。 DeleteManyModelのインスタンスには、クエリフィルターに一致するすべてのドキュメントを削除するための手順が表示されます。

次の例では、 DeleteManyModelのインスタンスを作成しています。

val deleteManyModel = DeleteManyModel(equal("cuisine", "Experimental"))

一括操作の実行

実行する操作ごとにモデルインスタンスを定義した後、それらのモデルを含む SeqインスタンスをMongoCollection.bulkWrite() メソッドに渡します。デフォルトでは 、メソッドはモデルのリストで指定された順序で操作を実行します。

次の例では、 bulkWrite()メソッドを使用して複数の書込み操作を実行します。

val insertOneModel = InsertOneModel(
    Document("name" -> "Red's Pizza",
             "borough" -> "Brooklyn",
             "cuisine" -> "Pizzeria")
)
val updateOneModel = UpdateOneModel(equal("name", "Moonlit Tavern"), set("borough", "Queens"))
val deleteManyModel = DeleteManyModel(equal("name", "Crepe"))
val writes = Seq(insertOneModel, updateOneModel, deleteManyModel)
val observable = collection.bulkWrite(writes)
observable.subscribe(
  (result: BulkWriteResult) => println(s"Success: $result"),
  (error: Throwable) => println(s"Error: ${error.getMessage}"),
  () => println("Completed")
)

Success: AcknowledgedBulkWriteResult{insertedCount=1, matchedCount=1, removedCount=1,
modifiedCount=1, upserts=[], inserts=[BulkWriteInsert{index=0, id=BsonObjectId{value=...}}]}
Completed

いずれかの書き込み操作が失敗した場合、 Scalaドライバーは BulkWriteError を発生させ、それ以上の操作を実行しません。 BulkWriteError は、失敗した操作と例外に関する詳細を含む details アイテムを提供します。

一括書き込みをカスタマイズする

オプションで、MongoCollection.bulkWrite() メソッドは BulkWriteOptions パラメータを受け入れます。このパラメータは、 一括書込み操作を構成するために使用できるオプションを指定します。オプションを指定しない場合、ドライバーはデフォルト設定で一括操作を実行します。書込み操作の動作を変更するには、クラスインスタンスをbulkWrite() メソッドの最後の引数として渡します。

次の表では、 BulkWriteOptionsインスタンスを構成するために使用できる setter メソッドについて説明します。

次のコードでは、オプションを作成し、ordered オプションを false に設定して、順序なしの一括書き込みを指定します。 次に、この例ではbulkWrite() メソッドを使用して 一括操作 を実行します。

val options = BulkWriteOptions().ordered(false)
val observable = collection.bulkWrite(writes, options)

順序付けなし一括書き込み 内のいずれかの書き込み操作が失敗した場合、 Scalaドライバーはすべての操作を試行した後にのみエラーを報告します。

戻り値

bulkWrite() メソッドは、BulkWriteResult を含む SingleObservableオブジェクトを返します。 Observable にサブスクライブし、次の方法を使用することで、BulkWriteResultインスタンスからの情報にアクセスできます。

挿入操作

この例では、 2 つのドキュメントを挿入する指示を含むモデルを作成する方法を示しています。 1 つのドキュメントはdb.peopleコレクションに挿入され、もう 1 つのドキュメントはdb.thingsコレクションに挿入されます。 MongoNamespaceインスタンスは、各書込み操作が適用されるターゲットデータベースとコレクションを定義します。

val personToInsert = ClientNamespacedWriteModel.insertOne(
  MongoNamespace("db", "people"),
  Document("name" -> "Julia Smith")
)
val thingToInsert = ClientNamespacedWriteModel.insertOne(
  MongoNamespace("db", "things"),
  Document("object" -> "washing machine")
);

アップデート操作

次の例は、bulkWrite() メソッドを使用して、db.people コレクションと db.things コレクション内の既存のドキュメントを更新する方法を示しています。

val personUpdate = ClientNamespacedWriteModel.updateOne(
  MongoNamespace("db", "people"),
  equal("name", "Freya Polk"),
  inc("age", 1)
)
val thingUpdate = ClientNamespacedWriteModel.updateMany(
  MongoNamespace("db", "things"),
  equal("category", "electronic"),
  set("manufacturer", "Premium Technologies")
)

この例では、peopleコレクションで name 値が "Freya Polk" であるドキュメントで、ageフィールドの値を 1 ずつ増加させます。また、thingsコレクション内で category 値が "electronic" であるすべてのドキュメントの manufacturerフィールドの値を "Premium Technologies" に設定します。

複数のドキュメントが ClientNamespacedUpdateOneModelインスタンスで指定されたクエリフィルターに一致する場合、この操作最初の結果が更新されます。次のコードに示すように、 ClientUpdateOneOptionsインスタンスでソート順序を指定して、ドライバーが 更新操作 を実行する前に一致したドキュメントに順序を適用できます。

val options = ClientUpdateOneOptions
  .clientUpdateOneOptions()
  .sort(ascending("_id"))

置換操作

次の例は、 db.people コレクションと db.things コレクション内の既存のドキュメントを置き換えるためのモデルを作成する方法を示しています。

val personReplacement = ClientNamespacedWriteModel.replaceOne(
  MongoNamespace("db", "people"),
  equal("_id", 1),
  Document("name" -> "Frederic Hilbert")
)
val thingReplacement = ClientNamespacedWriteModel.replaceOne(
  MongoNamespace("db", "things"),
  equal("_id", 1),
  Document("object" -> "potato")
)

上記のコード例では、次のドキュメントを新しいドキュメントに置き換えます。

• _id 値が 1 である peopleコレクション内のドキュメント

• _id 値が 1 である thingsコレクション内のドキュメント

複数のドキュメントが ClientNamespacedReplaceOneModelインスタンスで指定されたクエリフィルターに一致する場合、その操作は最初の結果を置き換えます。次のコードに示すように、ClientReplaceOneOptionsインスタンスでソート順序を指定して、ドライバーが置換操作を実行する前に一致したドキュメントに順序を適用できます。

val options = ClientReplaceOneOptions
  .clientReplaceOneOptions()
  .sort(ascending("_id"))

一括操作の実行

実行する操作ごとに ClientNamespacedWriteModelインスタンスを定義した後、これらのインスタンスのリストをクライアントの bulkWrite() メソッドに渡します。デフォルトでは 、メソッドは指定された順序で操作を実行します。

次の例では、 bulkWrite()メソッドを使用して複数の書込み操作を実行します。

val peopleNamespace = MongoNamespace("db", "people")
val thingsNamespace = MongoNamespace("db", "things")
val writeModels = List(
  ClientNamespacedWriteModel.insertOne(
    peopleNamespace,
    Document("name" -> "Corey Kopper")
  ),
  ClientNamespacedWriteModel.replaceOne(
    thingsNamespace,
    equal("_id", 1),
    Document("object" -> "potato")
  )
)
val observable = mongoClient.bulkWrite(writeModels)
observable.subscribe(
  (result: ClientBulkWriteResult) => println(result.toString),
  (error: Throwable) => println(s"Error: ${error.getMessage}"),
  () => println("Completed")
)

AcknowledgedSummaryClientBulkWriteResult{insertedCount=1, matchedCount=1, ...}

書き込み操作のいずれかが失敗した場合、ドライバーは ClientBulkWriteException を発生させ、それ以上の個々の操作を実行しません。ClientBulkWriteException には、障害に関する情報を提供する ClientBulkWriteException.getWriteErrors() メソッドを使用してアクセスできる BulkWriteError が含まれています。

一括書き込みをカスタマイズする

ClientBulkWriteOptions のインスタンスをbulkWrite() メソッドに渡して、ドライバーが 一括書込み操作を実行する方法をカスタマイズできます。

val namespace = MongoNamespace("db", "people")
val options = ClientBulkWriteOptions.clientBulkWriteOptions().ordered(false)
val writeModels = List(
  ClientNamespacedWriteModel.insertOne(namespace, Document("_id" -> 1, "name" -> "Rudra Suraj")),
  // Causes a duplicate key error
  ClientNamespacedWriteModel.insertOne(namespace, Document("_id" -> 1, "name" -> "Mario Bianchi")),
  ClientNamespacedWriteModel.insertOne(namespace, Document("name" -> "Wendy Zhang"))
)
val observable = mongoClient.bulkWrite(writeModels, options)

API ドキュメント

このガイドで説明したメソッドや型の詳細については、次の API ドキュメントを参照してください。

• コレクションの一括書込み (write)

  • bulkWrite()

  • InsertOneModel

  • UpdateOneModel

  • UpdateManyModel

  • ReplaceOneModel

  • DeleteOneModel

  • DeleteManyModel

  • BulkWriteOptions

  • BulkWriteResult

• クライアント一括書込み (write)

  • bulkWrite()

  • ClientNamespacedWriteModel

  • MongoNamespace

  • ClientBulkWriteOptions

  • ClientBulkWriteResult