ドキュメントの検索

一致するドキュメントのすべての検索

条件に一致するすべてのドキュメントを検索するには、 find()メソッドを使用します。 このメソッドは、クエリフィルターをパラメーターとして受け取ります。 クエリフィルターは、一致するドキュメントの基準を形成するフィールドと値で構成されます。

メソッドは、フィルタ条件に一致するドキュメントを検索するために反復処理できるCursorタイプを返します。

このメソッドを使用してデータを検索する例については、 find() の例 を参照してください。

クエリの指定の詳細については、「 クエリの指定 」ガイドを参照してください。

1 つのドキュメントの検索

条件に一致する最初のドキュメントを検索するには、 find_one()メソッドを使用します。 このメソッドは、クエリフィルターをパラメーターとして受け取ります。 クエリフィルターは、一致するドキュメントの基準を形成するフィールドと値で構成されます。

ドキュメントがフィルタ条件に一致する場合、メソッドはSomeの値を持つResult<Option<T>>型を返します。 フィルタ条件に一致するドキュメントがない場合、 find_one()はNoneの値を持つResult<Option<T>>型を返します。

このメソッドを使用してデータを検索する例については、 find_one() の例 を参照してください。

検索動作の変更

FindOptionsオプション ビルダー メソッドをfind()に連鎖させることで、 find()メソッドの動作を変更できます。また、 FindOneOptionsオプション ビルダー メソッドをfind_one()に連鎖させることで、 find_one()メソッドの動作を変更できます。

次の表では、対応するビルダFindOptions FindOneOptionsメソッドを呼び出して設定できる一般的に使用される フィールドと フィールドについて説明しています。

各タイプに指定できる設定の完全なリストについては、 FindOptions および FindOneOptions のAPIドキュメントを参照してください。

find() の例

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

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

• find()の値がunit_price 12.00未満で、かつ でないドキュメントに一致するクエリフィルターを に渡しますcategory"kitchen"

• sort()メソッドをfind()に連鎖させ、一致したドキュメントをunit_priceで降順に並べ替えます

let mut cursor = my_coll
    .find(doc! { "$and": vec!
    [
        doc! { "unit_price": doc! { "$lt": 12.00 } },
        doc! { "category": doc! { "$ne": "kitchen" } }
    ] })
    .sort(doc! { "unit_price": -1 })
    .await?;
while let Some(result) = cursor.try_next().await? {
    println!("{:?}", result);
}

Inventory { item: "watering can", category: "garden", unit_price: 11.99 }
Inventory { item: "candle", category: "decor", unit_price: 2.89 }

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

この例では、 sample_restaurantsデータベース内のrestaurantsコレクションからクエリフィルターに一致するドキュメントを検索します。 find() メソッドは、cuisineフィールドの値が "French" であるすべてのドキュメントを返します。

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

• <Document>:コレクションドキュメントをBSONドキュメントとして検索して出力します

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

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

use mongodb::{ 
    bson::doc,
    Client,
    Collection
};
use futures::TryStreamExt;
use serde::{ Deserialize, Serialize };
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    cuisine: 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 mut cursor = my_coll.find(
        doc! { "cuisine": "French" }
    ).await?;
    while let Some(doc) = cursor.try_next().await? {
        println!("{:#?}", doc);
    }
    Ok(())
}

use mongodb::{
    bson::doc,
    sync::{Client, Collection}
};
use serde::{ Deserialize, Serialize };
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    cuisine: 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 mut cursor = my_coll.find(
        doc! { "cuisine": "French" }
    ).run()?;
    
    for result in cursor {
        println!("{:#?}", result?);
      }
    Ok(())
}

...
Some(
   Document({
      "_id": ObjectId(
            "...",
      ),
      ...
      "name": String(
            "Cafe Un Deux Trois",
      ),
      ...
   }),
),
Some(
   Document({
      "_id": ObjectId(
            "...",
      ),
      ...
      "name": String(
            "Calliope",
      ),
      ...
   }),
)
...

...
Restaurant {
   name: "Cafe Un Deux Trois",
   cuisine: "French",
}
Restaurant {
   name: "Calliope",
   cuisine: "French",
}
...

ファイルからクエリを読み込む例

クエリフィルターをJSONファイルに保存し、実行時に読み込むことができます。このアプローチにより、 RustアプリケーションとMongoDB Shell（mongosh）などの外部ツールとの間でクエリ定義を共有できます。

cargo add serde_json

まず、クエリフィルターを含むJSONファイルを作成します。次のサンプルquery.jsonファイルには、categoryフィールド値が "kitchen" であるドキュメントに一致する比較クエリフィルターが含まれています。

{ "category": "kitchen" }

このファイルをRustアプリケーションにロードするには、std::fs::read_to_string() メソッドを使用してファイルを読み取ります。次に、serde_json::from_str() を呼び出してJSON string を Documentインスタンスに解析します。Document は serde::Deserialize 機能を実装しているため、 JSON string から直接逆直列化できます。

次の例では、 query.jsonファイルからクエリフィルターを読み取り、それを find() メソッドに渡します。

let json = std::fs::read_to_string("query.json")
    .expect("failed to read query.json");
let filter: Document = serde_json::from_str(&json)
    .expect("query.json contains invalid JSON");
let mut cursor = my_coll.find(filter).await?;
while let Some(doc) = cursor.try_next().await? {
    println!("{:?}", doc);
}

Inventory { item: "blender", category: "kitchen", unit_price: 38.49 }
Inventory { item: "placemat", category: "kitchen", unit_price: 3.19 }

find_one() の例

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

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

• unit_priceの値が20.00以下のドキュメントに一致するクエリフィルターをfind_one()に渡します

• 最初に一致したドキュメントをスキップするには、 skip()メソッドをfind_one()にチェーンします。

let result = my_coll
    .find_one(doc! { "unit_price": doc! { "$lte": 20.00 } })
    .skip(2)
    .await?;
println!("{:#?}", result);

Some(
    Inventory {
        item: "watering can",
        category: "garden",
        unit_price: 11.99,
    },
)

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

この例では、 sample_restaurantsデータベース内の restaurantsコレクションからクエリフィルターに一致するドキュメントを検索します。 find_one() メソッドは、nameフィールドの値が "Tompkins Square Bagels" である最初のドキュメントを返します。

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

• <Document>:コレクションドキュメントをBSONドキュメントとして検索して出力します

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

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

use mongodb::{ 
    bson::doc,
    Client,
    Collection
};
use serde::{ Deserialize, Serialize };
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    cuisine: 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 result = my_coll.find_one(
        doc! { "name": "Tompkins Square Bagels" }
    ).await?;
    println!("{:#?}", result);
    Ok(())
}

use mongodb::{
    bson::doc,
    sync::{Client, Collection}
};
use serde::{ Deserialize, Serialize };
#[derive(Serialize, Deserialize, Debug)]
struct Restaurant {
    name: String,
    cuisine: 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 result = my_coll.find_one(
        doc! { "name": "Tompkins Square Bagels" }
    ).run()?;
    println!("{:#?}", result);
    Ok(())
}

Some(
   Document({
      "_id": ObjectId(
            "...",
      ),
      ...
      "name": String(
            "Tompkins Square Bagels",
      ),
      ...
   }),
)

Some(
   Restaurant {
      name: "Tompkins Square Bagels",
      cuisine: "American",
   },
)

ドキュメント データの集計

aggregate()メソッドは、集計パイプラインをパラメーターとして受け取ります。 集計パイプラインには、データの変換方法を指定する 1 つ以上のステージが含まれます。 ステージには、集計演算子（プレフィックスとして$ ）と、その演算子に必要なパラメータが含まれます。

集計の詳細と集計の例については、集計ガイドを参照してください。

このメソッドでは、 Cursorタイプの結果ドキュメントが返されます。 集計パイプラインに$matchステージが含まれていない場合、パイプラインはコレクション内のすべてのドキュメントを処理します。

集計動作を変更する

AggregateOptionsオプション ビルダー メソッドをaggregate()に連鎖させることで、 aggregate()メソッドの動作を変更できます。

次の表では、対応するビルダ メソッドを呼び出して設定できる一般的に使用されるAggregateOptionsフィールドについて説明しています。

設定の完全なリストについては、AggregateOptions のAPIドキュメントを参照してください。

例

この例では、次のステージを含むパイプラインでaggregate()メソッドを呼び出す方法を示しています。

• $group ステージ: categoryフィールドの各値について unit_priceフィールドの平均を計算

• $sort ステージ: 結果を avg_price で昇順に並べ替える

let pipeline = vec![
    doc! { "$group": doc! { "_id" : doc! {"category": "$category"} ,
    "avg_price" : doc! { "$avg" : "$unit_price" } } },
    doc! { "$sort": { "_id.avg_price" : 1 } },
];
let mut cursor = my_coll.aggregate(pipeline).await?;
while let Some(result) = cursor.try_next().await? {
    println!("{:?}", result);
}

Document({"_id": Document({"category": String("decor")}), "avg_price": Double(2.890000104904175)})
Document({"_id": Document({"category": String("kitchen")}), "avg_price": Double(20.840000867843628)})
Document({"_id": Document({"category": String("garden")}), "avg_price": Double(11.989999771118164)})

API ドキュメント

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

• find_one()

• find()

• FindOptions

• FindOneOptions

• Cursor

• Aggregate()

• AggregateOptions