Struct MongoPipelineBuilder 

pub struct MongoPipelineBuilder {
    pub allow_disk_use: bool,
    pub batch_size: Option<u32>,
    pub max_time_ms: Option<u64>,
    pub comment: Option<String>,
    /* private fields */
}

A builder for combining multiple MongoDB operations into a single pipeline.

This reduces round-trips by batching related operations.

Example

use prax_query::db_optimize::MongoPipelineBuilder;

let pipeline = MongoPipelineBuilder::new()
    .match_stage(doc! { "status": "active" })
    .lookup("orders", "user_id", "_id", "user_orders")
    .unwind("$user_orders")
    .group("$user_id", doc! { "total": { "$sum": "$amount" } })
    .sort(doc! { "total": -1 })
    .limit(10)
    .build();

Fields

allow_disk_use: bool

Whether to allow disk use for large operations.

batch_size: Option<u32>

Batch size for cursor.

max_time_ms: Option<u64>

Maximum time for operation in milliseconds.

comment: Option<String>

Comment for profiling.

Implementations

impl MongoPipelineBuilder

pub fn new() -> Self

Create a new empty pipeline builder.

pub fn match_stage(self, filter: impl Into<String>) -> Self

Add a $match stage.

pub fn project(self, projection: impl Into<String>) -> Self

Add a $project stage.

pub fn group( self, id: impl Into<String>, accumulators: impl Into<String>, ) -> Self

Add a $group stage.

pub fn sort(self, sort: impl Into<String>) -> Self

Add a $sort stage.

pub fn limit(self, n: u64) -> Self

Add a $limit stage.

pub fn skip(self, n: u64) -> Self

Add a $skip stage.

pub fn unwind(self, path: impl Into<String>) -> Self

Add a $unwind stage.

pub fn unwind_preserve_null(self, path: impl Into<String>) -> Self

Add a $unwind stage with null preservation.

pub fn lookup( self, from: impl Into<String>, local_field: impl Into<String>, foreign_field: impl Into<String>, as: impl Into<String>, ) -> Self

Add a $lookup stage.

pub fn add_fields(self, fields: impl Into<String>) -> Self

Add a $addFields stage.

pub fn set(self, fields: impl Into<String>) -> Self

Add a $set stage.

pub fn unset<I, S>(self, fields: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Add a $unset stage.

pub fn replace_root(self, new_root: impl Into<String>) -> Self

Add a $replaceRoot stage.

pub fn count(self, field: impl Into<String>) -> Self

Add a $count stage.

pub fn sample(self, size: u64) -> Self

Add a $sample stage.

pub fn merge_into(self, collection: impl Into<String>) -> Self

Add a $merge output stage.

pub fn merge( self, into: impl Into<String>, on: Option<String>, when_matched: Option<String>, when_not_matched: Option<String>, ) -> Self

Add a $merge output stage with options.

pub fn out(self, collection: impl Into<String>) -> Self

Add a $out stage.

pub fn raw(self, stage: impl Into<String>) -> Self

Add a raw BSON stage.

pub fn with_disk_use(self) -> Self

Enable disk use for large operations.

pub fn with_batch_size(self, size: u32) -> Self

Set cursor batch size.

pub fn with_max_time(self, ms: u64) -> Self

Set maximum execution time.

pub fn with_comment(self, comment: impl Into<String>) -> Self

Add a comment for profiling.

pub fn stage_count(&self) -> usize

Get the number of stages.

pub fn build(&self) -> String

Build the pipeline as a JSON array string.

pub fn stages(&self) -> &[PipelineStage]

Get the stages.

Trait Implementations

impl Clone for MongoPipelineBuilder

fn clone(&self) -> MongoPipelineBuilder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MongoPipelineBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MongoPipelineBuilder

fn default() -> MongoPipelineBuilder

Returns the “default value” for a type.