カーソルを使用したデータへのアクセス

Overview

このガイドでは、Rust ドライバーを使用して、カーソルを使用して読み取り操作または集計から返されたデータにアクセスする方法を学習します。 カーソルは、特定の時点でメモリ内にドキュメントのサブセットのみを保持しながら、複数のドキュメントを反復処理できるメカニズムです。

ドライバーは、カーソルからドキュメントを検索するためのCursorタイプを提供します。 たとえば、複数のドキュメントを返すことができる検索操作を実行すると、ドライバーはCursorインスタンスを返し、そこから一致したドキュメントにアクセスできます。

読み取り操作または集計を実行すると、返されるCursorインスタンスに操作結果の最初のバッチが含まれます。 カーソルを反復処理すると、サーバーはより個別の結果を返します。 結果のバッチの末尾に到達した後に一致するドキュメントがさらにある場合、すべての結果が返されるまで、 Cursorインスタンスは次のドキュメントのバッチを取得します。

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

• 例のサンプル データは、カーソルの例で使用されるサンプル データを示します

• ドキュメントの取得 では、反復処理またはストリームを使用して一度に 1 つずつ結果にアクセスする方法が個別に説明されます

• 配列としてのドキュメントを取得では、返されたカーソル結果を収集して、すべての結果を単一の配列としてアクセスする方法について説明します。

• 未加工ドキュメントバッチの検索 では、BSONデータに直接アクセスしてゼロコピー ドキュメント プロセシングを行うための未加工バッチするカーソルAPIの使用方法について説明します。

• カーソルの動作を指定するでは、メソッドが返すカーソルを構成する方法について説明します。

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

サンプルデータの例

このガイドの例では、 構造体に保存されている次のデータを使用します。

let docs = vec! [
    Fruit { 
        name: "strawberry".to_string(), 
        color: "red".to_string() 
    },
    Fruit { 
        name: "banana".to_string(), 
        color: "yellow".to_string() 
    },
    Fruit { 
        name: "pomegranate".to_string(), 
        color: "red".to_string() 
    },
    Fruit { 
        name: "pineapple".to_string(), 
        color: "yellow".to_string() 
    }
];

ドキュメントを個別に検索する

このドライバーは、 Cursorインスタンスによって返されたドキュメントを反復処理するための次のアクセス パターンを提供します。

• 組み込みパターン: カーソルを進み、現在のドキュメントを検索して逆直列化します

• ストリーム実装パターン: カーソルを反復処理し、 Streamが提供するメソッドを呼び出して、単一または複数のドキュメントを処理

次のセクションでは、これらのアクセス パターンと対応するメソッドについて詳しく説明します。

let mut cursor = my_coll.find(doc! { "color": "red" }).await?;
while cursor.advance().await? {
    println!("{:?}", cursor.deserialize_current()?);
}

Fruit { name: "strawberry", color: "red" }
Fruit { name: "pomegranate", color: "red" }

let mut cursor = my_coll.find(doc! { "color": "red" }).await?;
println!("Output from next() iteration:");
while let Some(doc) = cursor.next().await {
    println!("{:?}", doc?);
}
println!();
let mut cursor = my_coll.find(doc! { "color": "yellow" }).await?;
println!("Output from try_next() iteration:");
while let Some(doc) = cursor.try_next().await? {
    println!("{:?}", doc);
}

Output from next() iteration:
Fruit { name: "strawberry", color: "red" }
Fruit { name: "pomegranate", color: "red" }
Output from try_next() iteration:
Fruit { name: "banana", color: "yellow" }
Fruit { name: "pineapple", color: "yellow" }

ドキュメントを配列として取得

Cursor型はStream特権を実装しているため、カーソルからの結果を配列に収集できます。

ドキュメントを配列として取得するには、次のメソッドを使用します。

• collect(): カーソルからの結果をVec<Result<T>>型に収集します

• try_collect(): カーソルからの結果をResult<Vec<T>>型に収集します

let cursor = my_coll.find(doc! { "color": "red" }).await?;
println!("Output from collect():");
let v: Vec<Result<Fruit>> = cursor.collect().await;
println!("{:?}", v);
println!();
let cursor = my_coll.find(doc! { "color": "yellow" }).await?;
println!("Output from try_collect():");
let v: Vec<Fruit> = cursor.try_collect().await?;
println!("{:?}", v);

Output from collect():
[Ok(Fruit { name: "strawberry", color: "red" }), Ok(Fruit { name: "pomegranate", color: "red" })]
Output from try_collect():
[Fruit { name: "banana", color: "yellow" }, Fruit { name: "pineapple", color: "yellow" }]

Raw バッチするカーソルの使用

find() などのカーソルを返す操作で batch() メソッドを呼び出して RawBatchCursor を返すことができます。これにより、シリアル化された個々の値ではなく、サーバーによって返された未加工BSONドキュメントをバッチする単位で反復処理できます。このモジュールは、サーバー応答バッチへの直接アクセスが必要な場合にドキュメントを処理する高パフォーマンスの方法を提供します。高スループットを持つパフォーマンスを重視したカーソル アプリケーションには、rawバッチするモードを使用します。

let mut cursor = my_coll.find(doc! { "color": "red" }).batch().await?;
while let Some(batch) = cursor.next().await {
    let batch = batch?;
    let doc_slices = batch.doc_slices()?;
    let count = doc_slices.into_iter().count();
    println!("Processing batch with {} documents", count);
    for doc_result in batch.doc_slices()? {
        let doc = doc_result?;
        if let mongodb::bson::RawBsonRef::Document(raw_doc) = doc {
            println!("Raw document size: {} bytes", raw_doc.as_bytes().len());
        }
    }
}

Processing batch with 4 documents
Raw document size: 58 bytes
Raw document size: 59 bytes
Raw document size: 58 bytes
Raw document size: 59 bytes

カーソルの動作を指定する

操作によって返されるカーソルを変更するには、 Cursorインスタンスを返すメソッドにオプション ビルダ メソッドを連結します。 たとえば、カーソル関連のオプション ビルダのメソッドをfind()メソッドに連鎖させることができます。

次の表では、対応するビルダ メソッドを呼び出して設定できるカーソル関連のオプションについて説明します。

次のコードは、オプション ビルダー メソッドをfind()メソッドに連鎖させて、カーソル関連の設定を指定する方法を示しています。

let mut cursor = my_coll.find(doc! { "color": "red" })
    .batch_size(5)
    .cursor_type(CursorType::Tailable)
    .no_cursor_timeout(true)
    .await?;

詳細情報

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

• ドキュメントの検索ガイド

• クエリ ガイドを指定する

Rust 型と BSON の変換の詳細については、「データ モデリングと直列化 」に関するガイドを参照してください。