Delete Documents

パラメーター

delete_one()メソッドとdelete_many()メソッドは、クエリフィルターをパラメーターとして受け取ります。 クエリフィルターは、一致するドキュメントの基準を形成するフィールドと値で構成されます。

オプション

オプション ビルダー メソッドをdelete_one()とdelete_many()に連鎖させることで、削除操作メソッドの動作を変更できます。 これらのオプション メソッドはDeleteOptions構造体フィールドを設定します。

次の表では、 DeleteOptionsで利用できるオプションについて説明しています。

次のコードは、 comment()メソッドをdelete_one()メソッドに連結してcommentフィールドを設定する方法を示しています。

let res = my_coll
    .delete_one(filter)
    .comment(bson!("hello!"))
    .await?;

戻り値

delete_one()メソッドとdelete_many()メソッドはDeleteResult型を返します。 このタイプには、削除されたドキュメント数を示すdeleted_countプロパティが含まれています。 指定したクエリフィルターに一致するドキュメントがない場合、削除操作によってドキュメントは削除されず、 deleted_countの値は0になります。

削除の例 1 つ

次の例では、 delete_one() メソッドを使用して、item の値が "placemat" であるドキュメントを削除します。

let filter = doc! { "item": "placemat" };
let res = my_coll.delete_one(filter).await?;
println!("Deleted documents: {}", res.deleted_count);

Deleted documents: 1

完全なファイルの例: ドキュメントの削除

この例では、 sample_restaurantsデータベース内のrestaurantsコレクションからクエリフィルターに一致するドキュメントを削除します。 delete_one() メソッドは、nameフィールドの値が "Haagen-Dazs" であり、かつ boroughフィールドの値が "Brooklyn" である最初のドキュメントを削除します。

restaurantsコレクション内のドキュメントには、Document 型またはカスタムデータ型のインスタンスとしてアクセスできます。 コレクションのデータを表すデータ型を指定するには、強調表示された行の <T> 型パラメータを次のいずれかの値に置き換えます。

• <Document>:コレクションドキュメントはBSONドキュメントとしてアクセスします

• <Restaurant>: コードの上部で定義された Restaurant 構造体のインスタンスとしてコレクションドキュメントにアクセスします

各実行時に対応するコードを表示するには、 AsynchronousタブまたはSynchronousタブを選択します。

use mongodb::{ 
    bson::{ Document, doc }, 
    Client, 
    Collection 
};
use serde::{ Deserialize, Serialize };
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    borough: String,
}
#[tokio::main]
async fn main() -> mongodb::error::Result<()> {
    let uri = "<connection string>";
    let client = Client::with_uri_str(uri).await?;
    // Replace <T> with the <Document> or <Restaurant> type parameter
    let my_coll: Collection<T> = client
        .database("sample_restaurants")
        .collection("restaurants");
    let filter =
        doc! { "$and": [
           doc! { "name": "Haagen-Dazs" },
           doc! { "borough": "Brooklyn" }
       ]
    };
    let result = my_coll.delete_one(filter).await?;
    println!("Deleted documents: {}", result.deleted_count);
    Ok(())
}

Deleted documents: 1

use mongodb::{ 
    bson::{ Document, doc }, 
    sync::{ Client, Collection } 
};
use serde::{ Deserialize, Serialize };
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    borough: String,
}
fn main() -> mongodb::error::Result<()> {
    let uri = "<connection string>";
    let client = Client::with_uri_str(uri)?;
    // Replace <T> with the <Document> or <Restaurant> type parameter
    let my_coll: Collection<T> = client
        .database("sample_restaurants")
        .collection("restaurants");
    let filter =
        doc! { "$and": [
           doc! { "name": "Haagen-Dazs" },
           doc! { "borough": "Brooklyn" }
       ]
    };
    let result = my_coll.delete_one(filter).run()?;
    println!("Deleted documents: {}", result.deleted_count);
    Ok(())
}

Deleted documents: 1

削除の例

この例では、次のアクションを実行します。

• delete_many()メソッドを呼び出します

• categoryの値が"garden"であるドキュメントに一致するクエリフィルターをdelete_many()に渡します

• hint()メソッドをdelete_many()にチェーンして、 _id_インデックスを削除操作のヒントとして使用します

let filter = doc! { "category": "garden" };
let hint = Hint::Name("_id_".to_string());
let res = my_coll
    .delete_many(filter)
    .hint(hint)
    .await?;
println!("Deleted documents: {}", res.deleted_count);

Deleted documents: 2

完全なファイルの例: 複数のドキュメントを削除する

この例では、 sample_restaurantsデータベース内の restaurantsコレクションからクエリフィルターに一致するすべてのドキュメントを削除します。 delete_many() メソッドは、boroughフィールドの値が "Manhattan" で、かつ address.streetフィールドの値が "Broadway" であるドキュメントを削除します。

restaurantsコレクション内のドキュメントには、Document 型またはカスタムデータ型のインスタンスとしてアクセスできます。 コレクションのデータを表すデータ型を指定するには、強調表示された行の <T> 型パラメータを次のいずれかの値に置き換えます。

• <Document>:コレクションドキュメントはBSONドキュメントとしてアクセスします

• <Restaurant>: コードの上部で定義された Restaurant 構造体のインスタンスとしてコレクションドキュメントにアクセスします

各実行時に対応するコードを表示するには、 AsynchronousタブまたはSynchronousタブを選択します。

use mongodb::{
    bson::{ Document, doc },
    Client,
    Collection
};
use serde::{ Deserialize, Serialize };
#[derive(Debug, Serialize, Deserialize)]
struct Address {
    street: String,
    city: String,
}
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    borough: String,
    address: Address,
}
#[tokio::main]
async fn main() -> mongodb::error::Result<()> {
    let uri = "<connection string>";
    let client = Client::with_uri_str(uri).await?;
    // Replace <T> with the <Document> or <Restaurant> type parameter
    let my_coll: Collection<T> = client
        .database("sample_restaurants")
        .collection("restaurants");
    let filter =
        doc! { "$and": [
           doc! { "borough": "Manhattan" },
           doc! { "address.street": "Broadway" }
       ]
    };
    let result = my_coll.delete_many(filter).await?;
    println!("Deleted documents: {}", result.deleted_count);
    Ok(())
}

// Your values might differ
Deleted documents: 615

use mongodb::{ 
    bson::{ Document, doc }, 
    sync::{ Client, Collection } 
};
use serde::{ Deserialize, Serialize };
#[derive(Debug, Serialize, Deserialize)]
struct Address {
    street: String,
    city: String,
}
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    borough: String,
    address: Address,
}
fn main() -> mongodb::error::Result<()> {
    let uri = "<connection string>";
    let client = Client::with_uri_str(uri)?;
    // Replace <T> with the <Document> or <Restaurant> type parameter
    let my_coll: Collection<T> = client
        .database("sample_restaurants")
        .collection("restaurants");
    let filter =
        doc! { "$and": [
           doc! { "borough": "Manhattan" },
           doc! { "address.street": "Broadway" }
       ]
    };
    let result = my_coll.delete_many(filter).run()?;
    println!("Deleted documents: {}", result.deleted_count);
    Ok(())
}

// Your values might differ
Deleted documents: 615

API ドキュメント

このガイドで言及されているメソッドとタイプの詳細については、次のAPIドキュメントを参照してください。

• delete_one()

• delete_many()

• DeleteOptions

• Hint

• DeleteResult