AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

Retrieve Data

このガイドでは、読み取り操作を使用して MongoDB コレクションからデータを検索する方法を学びます。 読み取り操作は、サーバーからドキュメントを検索するコマンドです。

読み取り操作には次の 2 つのタイプがあります。

  • 検索操作: コレクションからドキュメントを検索できます

  • 集計操作: コレクション内のデータを変換

このガイドには、次のセクションが含まれています。

  • 例のサンプル データ では、読み取り操作の例で使用されるサンプル データが提示されます

  • 検索操作では、ドライバーを使用して検索操作を実行する方法について説明します

  • 「集計操作」では、ドライバーを使用して集計操作を実行する方法について説明します

  • 追加情報では、このガイドで言及されている型とメソッドのリソースとAPIドキュメントへのリンクを提供します

このガイドの例では、次のサンプル ドキュメントを使用します。 各ドキュメントは、店舗の在庫内の商品を表し、その分類と単価に関する情報が含まれています。

let docs = vec! [ Inventory { item: "candle".to_string(), category: "decor".to_string(), unit_price: 2.89, }, Inventory { item: "blender".to_string(), category: "kitchen".to_string(), unit_price: 38.49, }, Inventory { item: "placemat".to_string(), category: "kitchen".to_string(), unit_price: 3.19, }, Inventory { item: "watering can".to_string(), category: "garden".to_string(), unit_price: 11.99, }];

検索操作を使用して、MongoDB からデータを取得します。 find()検索操作は、find_one() メソッドと メソッドで構成されています。

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

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

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

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

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

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

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

FindOptionsインスタンスをパラメータとして渡すことでfind()の動作を変更できます。また、 FindOneOptionsインスタンスを渡すことでfind_one()の動作を変更できます。

各設定でデフォルト値を使用するには、オプション パラメータとして値Noneを指定します。

次の表では、 FindOptionsとFindOneOptionsで指定できる一般的に使用される設定について説明しています。

設定
説明

collation

結果をソートするときに使用する照合。照合について詳しくは、「照合」ガイドを参照してください。

タイプ: Collation
デフォルト: None

hint

操作に使用するインデックス。インデックスの詳細については、サーバー マニュアルの「インデックス」を参照してください。

タイプ: Hint
デフォルト: None

projection

結果を返すときに使用するプロジェクション。

タイプ: Document
デフォルト: None

read_concern

検索操作に使用する読み取り保証 (read concern)。このオプションを設定しない場合、操作はコレクションに設定された読み取り保証 (read concern)を継承します。読み取り保証 (read concern) の詳細については、サーバーマニュアルの「読み取り保証 (read concern)」を参照してください。

タイプ: ReadConcern

skip

結果を返す前にスキップするドキュメントの数。skip() ビルダーメソッドの使用方法の詳細については、「返された結果をスキップする」を参照してください。

タイプ: u64
デフォルト: None

sort

結果を返すときに使用するソート。デフォルトでは、ドライバーはドキュメントを自然な順序、つまりデータベースに表示される順序で返します。詳細については、サーバー マニュアルの用語集にある「自然な順序」を参照してください。sort() ビルダ メソッドの使用方法の詳細については、「結果のソート」を参照してください。

タイプ: Document
デフォルト: None

注意

インスタンス化オプション

Rust ドライバーは、 FindOneOptionsやFindOptionsなどの多数のさまざまなタイプを作成するためのビルダ設計パターンを実装します。 各タイプのbuilder()メソッドを使用して、オプション ビルダー関数を 1 つずつ連鎖させてオプション インスタンスを構築できます。

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

次のセクションには、 find()メソッドとfindOne()メソッドを使用してフィルター条件に一致するサンプル ドキュメントを取得する例が含まれています。

以下の例では、次のパラメータを使用してfind()メソッドを呼び出す方法を示しています。

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

  • 一致したドキュメントをunit_priceで降順に並べ替えるFindOptionsインスタンス

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

以下の例では、次のパラメータを使用してfind_one()メソッドを呼び出す方法を示しています。

  • の値が 以下のドキュメントに一致するクエリフィルターunit_price20.00

  • 最初に一致したドキュメントをスキップするFindOneOptionsインスタンス

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

集計操作 を使用して、コレクションからデータを取得して変換します。 aggregate()メソッドを使用して集計操作を実行できます。

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

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

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

任意のパラメータとしてAggregateOptionsインスタンスを渡すことで、 aggregate()の動作を変更できます。

各設定でデフォルト値を使用するには、オプション パラメータとして値Noneを指定します。

次の表では、 AggregateOptionsで指定できる一般的に使用される設定について説明しています。

設定
説明

allow_disk_use

一時ファイルへの書き込みを有効にします。trueの場合、集計ステージはdbPathディレクトリ内の_tmpサブディレクトリにデータを書き込むことができます。

タイプ: bool
デフォルト: false

batch_size

カーソルバッチごとにサーバーが返すドキュメントの最大数を指定します。このオプションは、カーソルが返すドキュメントの数ではなく、カーソルがメモリに保持するドキュメントの数を設定します。

タイプ: u32
デフォルト: 初期は 101 ドキュメント、以降のバッチは最大 16 MB ドキュメント

collation

結果をソートするときに使用する照合。照合について詳しくは、「照合」ガイドを参照してください。

タイプ: Collation
デフォルト: None

hint

操作に使用するインデックス。インデックスの詳細については、サーバー マニュアルの「インデックス」を参照してください。

タイプ: Hint
デフォルト: None

read_concern

検索操作に使用する読み取り保証 (read concern)。このオプションを設定しない場合、操作はコレクションに設定された読み取り保証 (read concern)を継承します。読み取り保証 (read concern) の詳細については、サーバーマニュアルの「読み取り保証 (read concern)」を参照してください。

タイプ: ReadConcern

write_concern

操作の書込み保証 (write concern)。このオプションを設定しない場合、操作はコレクションに設定された書込み保証 (write concern)を継承します。書込み保証 (write concern) の詳細については、サーバー マニュアルの「書込み保証(write concern) 」を参照してください。

タイプ: WriteConcern

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

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

  • ドキュメントをcategoryフィールドでグループ化し、 categoryによりunit_priceフィールドの平均を計算する$groupステージ

  • $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, None).await?;while let Some(result) = cursor.try_next().await? { println!("{:?}", result);};

検索操作の実行可能な例については、次の使用例を参照してください。

このガイドの操作の詳細については、次のドキュメントを参照してください。

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