Delete Documents

サンプル データ

restaurantssample_restaurantsこのガイドの例では、Atlasサンプルデータセット の データベースの コレクションを使用します。Scalaアプリケーションからこのコレクションにアクセスするには、Atlas クラスターに接続する MongoClient を作成し、database 変数と collection 変数に次の値を割り当てます。

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

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

単一ドキュメントの削除

次の例では、 deleteOne()メソッドを使用して、 nameフィールドの値が"Happy Garden"であるドキュメントを削除します。

val filter = equal("name", "Happy Garden")
val observable: Observable[DeleteResult] = collection.deleteOne(filter)
observable.subscribe(new Observer[DeleteResult] {
  override def onNext(result: DeleteResult): Unit = println(s"Deleted document count: ${result.getDeletedCount}")
  override def onError(e: Throwable): Unit = println(s"Error: $e")
  override def onComplete(): Unit = println("Completed")
})

Deleted document count: 1
Completed

複数のドキュメントの削除

次の例では、 deleteMany()メソッドを使用して、 boroughフィールドの値が"Brooklyn"で、かつnameフィールドの値が"Starbucks"であるすべてのドキュメントを削除します。

val filter = and(
  equal("borough", "Brooklyn"),
  equal("name", "Starbucks")
)
val observable: Observable[DeleteResult] = collection.deleteMany(filter)
observable.subscribe(new Observer[DeleteResult] {
  override def onNext(result: DeleteResult): Unit = println(s"Deleted document count: ${result.getDeletedCount}")
  override def onError(e: Throwable): Unit = println(s"Error: $e")
  override def onComplete(): Unit = println("Completed")
})

Deleted document count: 3
Completed

削除操作をカスタマイズする

deleteOne()メソッドとdeleteMany()メソッドはオプションで、削除操作を構成するために使用できるオプションを表すDeleteOptionsパラメータを受け入れます。 オプションを指定しない場合、ドライバーはデフォルト設定で削除操作を実行します。

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

val filter = regex("name", "Red")
val opts = DeleteOptions().comment("sample comment")
val observable = collection.deleteMany(filter, opts)
observable.subscribe(new Observer[DeleteResult] {
  override def onNext(result: DeleteResult): Unit = println(s"Deleted document count: ${result.getDeletedCount}")
  override def onError(e: Throwable): Unit = println(s"Error: $e")
  override def onComplete(): Unit = println("Completed")
})

Deleted document count: 124
Completed

戻り値

deleteOne()メソッドとdeleteMany()メソッドはそれぞれDeleteResultインスタンスを返します。 DeleteResultインスタンスから次の情報にアクセスできます。

• deletedCountは、削除されたドキュメントの数を示します

• wasAcknowledged()は、サーバーが結果を確認した場合にtrueを返します。

クエリフィルターがどのドキュメントにも一致しない場合、ドライバーはドキュメントを削除せず、deletedCount の値は 0 です。

API ドキュメント

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

• deleteOne()

• deleteMany()

• DeleteResult