Counting Documents

The CountDocuments and CountDocumentsAsync methods can be used to count all the documents matching a particular filter.

var count = collection.CountDocuments(new BsonDocument("x", 10));

// or

var count = collection.CountDocuments(x => x.Age > 20);

var count = await collection.CountDocumentsAsync(new BsonDocument("x", 10));

// or

var count = await collection.CountDocumentsAsync(x => x.Age > 20);

Counting all the documents in a collection requires an empty filter:

var count = collection.CountDocuments(new BsonDocument());

var count = await collection.CountDocumentsAsync(new BsonDocument());

Finding Documents

Finding all the documents in a collection is done with an empty filter and the method Find. Once we have a cursor (of type IAsyncCursor<TDocument>), we can iterate it like we manually iterate an IEnumerable<TDocument>.

var filter = new BsonDocument();
using (var cursor = collection.Find(filter).ToCursor())
{
    while (cursor.MoveNext())
    {
        foreach (var doc in cursor.Current)
        {
            // do something with the documents
        }
    }
}

var filter = new BsonDocument();
using (var cursor = await collection.Find(filter).ToCursorAsync())
{
    while (await cursor.MoveNextAsync())
    {
        foreach (var doc in cursor.Current)
        {
            // do something with the documents
        }
    }
}

Some options are available in the optional FindOptions parameter such as setting maxTimeMS, a batch size, or a comment. Others are available as part of the fluent interface such as skip, limit, and sort.

var filter = new BsonDocument();
var options = new FindOptions
{
    MaxTime = TimeSpan.FromMilliseconds(20)
};

using (var cursor = collection.Find(filter, options).Skip(10).Limit(20).ToCursor())
{
    // etc...
}

using (var cursor = await collection.Find(filter, options).Skip(10).Limit(20).ToCursorAsync())
{
    // etc...
}

Iteration

Other methods of iteration besides using a cursor directly are available.

First, the ToList and ToListAsync methods are available. These methods are useful when the list will be small or you simply need them all as a list. If you are returning a large number of documents, then memory should be considered a factor.

var list = collection.Find(filter)
    .Skip(10)
    .ToList();

var list = await collection.Find(filter)
    .Skip(10)
    .ToListAsync();

Second, ForEachAsync is available. This method is useful when you just need to process each document and don’t need to keep them around.

await collection.Find(filter)
    .Skip(10)
    .ForEachAsync(doc => Console.WriteLine(doc));

To avoid blocking while processing each document you can use an async lambda with ForEachAsync:

await collection.Find(filter)
    .Skip(10)
    .ForEachAsync(async (doc) => await Console.WriteLineAsync(doc));

When using the synchronous API you can use the C# foreach statement to iterate over the documents in a cursor.

var cursor = collection.Find(filter)
    .Skip(10)
    .ToCursor();
foreach (var doc in cursor.ToEnumerable())
{
    Console.WriteLine(doc);
}

Single Results

When you only want to find one document, the First, FirstOrDefault, Single, SingleOrDefault methods, and their asynchronous counterparts FirstAsync, FirstOrDefaultAsync, SingleAsync, and SingleOrDefaultAsync are available.

var result = collection.Find(filter)
    .Skip(10)
    .FirstOrDefault();

var result = await collection.Find(filter)
    .Skip(10)
    .FirstOrDefaultAsync();

Aggregation

MongoDB offers the aggregation framework which can be accessed via the Aggregate method. The result type is IAggregateFluent and provides access to a fluent API to build up an aggregation pipeline.

The first example from MongoDB’s documentation is done in a type-safe manner below:

[BsonIgnoreExtraElements]
class ZipEntry
{
    [BsonId]
    public string Zip { get; set; }

    [BsonElement("city")]
    public string City { get; set; }

    [BsonElement("state")]
    public string State { get; set; }

    [BsonElement("pop")]
    public int Population { get; set; }
}

var results = db.GetCollection<ZipEntry>.Aggregate()
    .Group(x => x.State, g => new { State = g.Key, TotalPopulation = g.Sum(x => x.Population) })
    .Match(x => x.TotalPopulation > 20000)
    .ToList();

var results = await db.GetCollection<ZipEntry>.Aggregate()
    .Group(x => x.State, g => new { State = g.Key, TotalPopulation = g.Sum(x => x.Population) })
    .Match(x => x.TotalPopulation > 20000)
    .ToListAsync();

This will result in the following aggregation pipeline getting sent to the server:

[{ group : { _id : '$state', TotalPopulation: { $sum : '$pop' } } },
{ $match : { TotalPopulation : { $gt : 20000 } } }]

More samples are located in the source.

Stage Operators

All the stage operators are supported, however some of them must use the AppendStage method due to lack of support for certain projections in the language.

$project

A $project is defined using the Project method and its overloads. Unlike in Find, an aggregate projection is not executed client-side and must be fully translatable to the server’s supported expressions. See expressions for more detail about the expressions available inside a $project.

Project(x => new { Name = x.FirstName + " " + x.LastName });

{ $project : { Name : { $concat : ['$FirstName', ' ', '$LastName'] } } }

$match

A $match stage is defined using the Match method and its overloads. It follows the same requirements as that of Find.

Match(x => x.Age > 21);

{ $match : { Age : { $gt : 21 } } }

$redact

There is no method defined for a $redact stage. However, it can be added using AppendStage.

$limit

A $limit stage is defined using the Limit method.

Limit(20);

{ $limit : 20 }

$skip

A $skip stage is defined using the Skip method.

Skip(20);

{ $skip : 20 }

$unwind

An $unwind stage is defined using the Unwind method and its overloads. Because $unwind is a type of projection, you must provide a return type, although not specifying one will use the overload that projects into a BsonDocument.

Unwind(x => x.ArrayFieldToUnwind);

{ $unwind : 'ArrayFieldToUnwind' }

$group

A $group stage is defined using the Group method and its overloads. Because $unwind is a type of projection, you must provide a return type. The most useful of the overloads is where two lambda expressions are expressed, the first for the key and the second for the grouping. See expressions for more detail about the expressions available inside a $group.

Group(x => x.Name, g => new { Name = g.Key, AverageAge = g.Average(x = x.Age) });

{ $group : { _id : '$Name', AverageAge : { $avg : '$Age'} } }

As in project, it is required that the result of the grouping be a new type, either anonymous or named. If the Key of the grouping is not used, an _id will still be inserted as this is required by the $group operator.

$sort

A $sort stage is defined using the Sort method. However, SortBy, SortByDescending, ThenBy, and ThenByDescending are also available.

SortBy(x => x.LastName).ThenByDescending(x => x.Age);

{ $sort : { LastName : 1, Age : -1 } }

$geoNear

There is no method defined for a $geoNear stage. However, it can be added using AppendStage.

$out

A $out stage is defined using the Out or OutAsync methods. It must be the final stage and it triggers execution of the operation.

Out("myNewCollection");

await OutAsync("myNewCollection");

{ $out : 'myNewCollection' }

Text Search

Atlas Search makes it easy to build fast, relevance-based search capabilities on top of your MongoDB data. Try it today on MongoDB Atlas, our fully managed database as a service.

The following examples can be used alongside the Atlas Search Tutorial

var collection = client.GetDatabase("sample_mflix").GetCollection<BsonDocument>("movies");

// Simple search example
var searchStage = @"
{
    $search : {
        text : {
            query : 'baseball',
            path : 'plot'
        }
    }
}";
var projection = @"
{
    _id : 0,
    title : 1,
    plot : 1
}";
var pipeline = new EmptyPipelineDefinition<BsonDocument>()
    .AppendStage<BsonDocument, BsonDocument, BsonDocument>(searchStage)
    .Limit(5)
    .Project(projection);
var moviesAboutBaseball = collection.Aggregate(pipeline).ToList();

Console.WriteLine("Movies about baseball:");
foreach (var movie in moviesAboutBaseball)
{
    Console.WriteLine($"  {movie}");
}
Console.WriteLine();

// Complex search example
string complexSearch = @"
{
    $search : {
        compound : {
            must : [ {
                text : {
                    query : ['Hawaii', 'Alaska'],
                    path : 'plot'
                },
            },
            {
                regex : {
                    query : '([0-9]{4})',
                    path : 'plot',
                    allowAnalyzedField : true
                }
            } ],
            mustNot : [ {
                text : {
                    query : ['Comedy', 'Romance'],
                    path : 'genres'
                }
            },
            {
                term : {
                    query : ['Beach', 'Snow'],
                    path : 'title'
                }
            } ]
        }
    }
}";
var projectionWithGenre = @"
{
    title : 1,
    plot : 1,
    genres : 1,
    _id : 0
}";
var complexPipeline = new EmptyPipelineDefinition<BsonDocument>()
    .AppendStage<BsonDocument, BsonDocument, BsonDocument>(complexSearch)
    .Project(projectionWithGenre);
var complexQueryResults = collection.Aggregate<BsonDocument>(complexPipeline).ToList();

Console.WriteLine("Complex query results: ");
foreach (var movie in complexQueryResults)
{
    Console.WriteLine($"  {movie}");
}
Console.WriteLine();

// Search using a multi analyzer
var queryUsingKeywordAnalyzer = @"
{
    $search : {
        text : {
            query : 'The Count of Monte Cristo',
            path : { 'value' : 'title', 'multi' : 'keywordAnalyzer' }
        }
    }
}";
var pipelineUsingKeywordAnalyzer = new EmptyPipelineDefinition<BsonDocument>()
    .AppendStage<BsonDocument, BsonDocument, BsonDocument>(queryUsingKeywordAnalyzer)
    .Project(projection);
var moviesNamedTheCountOfMonteCristo = collection
    .Aggregate<BsonDocument>(pipelineUsingKeywordAnalyzer)
    .ToList();

Console.WriteLine(@"Movies named ""The Count of Monte Cristo"":");
foreach (var movie in moviesNamedTheCountOfMonteCristo)
{
    Console.WriteLine($"  {movie}");
}
Console.WriteLine();

Below is the version which utilizes BsonDocument class.

var collection = client.GetDatabase("sample_mflix").GetCollection<BsonDocument>("movies");

// Simple search example
var searchStage = new BsonDocument
{
    {
        "$search", new BsonDocument
        {
            {
                "text", new BsonDocument
                {
                    { "query", "baseball" },
                    { "path", "plot" }
                }
            }
        }
    }
};
var projection = new BsonDocument
{
    { "_id", 0 },
    { "title", 1 },
    { "plot", 1 }
};
var pipeline = new EmptyPipelineDefinition<BsonDocument>()
    .AppendStage<BsonDocument, BsonDocument, BsonDocument>(searchStage)
    .Limit(5)
    .Project(projection);
var moviesAboutBaseball = collection.Aggregate(pipeline).ToList();

Console.WriteLine("Movies about baseball:");
foreach (var movie in moviesAboutBaseball)
{
    Console.WriteLine($"  {movie}");
}
Console.WriteLine();

// Complex search example
var complexSearch = new BsonDocument
{
    {
        "$search", new BsonDocument
        {
            {
                "compound", new BsonDocument
                {
                    {
                        "must", new BsonArray
                        {
                            new BsonDocument("text", new BsonDocument
                            {
                                { "query", new BsonArray { "Hawaii", "Alaska" } },
                                { "path", "plot" }
                            }),
                            new BsonDocument("regex", new BsonDocument
                            {
                                { "query", "([0-9]{4})" },
                                { "path", "plot" },
                                { "allowAnalyzedField", true }
                            })
                        }
                    },
                    {
                        "mustNot", new BsonArray
                        {
                            new BsonDocument("text", new BsonDocument
                            {
                                { "query", new BsonArray { "Comedy", "Romance" } },
                                { "path", "genres" }
                            }),
                            new BsonDocument("term", new BsonDocument
                            {
                                { "query", new BsonArray { "Beach", "Snow" } },
                                { "path", "title" }
                            })
                        }
                    }
                }
            }
        }
    }
};
var projectionWithGenre = new BsonDocument
{
    { "title", 1 },
    { "plot", 1 },
    { "genres", 1 },
    { "_id", 0 }
};
var complexPipeline = new EmptyPipelineDefinition<BsonDocument>()
    .AppendStage<BsonDocument, BsonDocument, BsonDocument>(complexSearch)
    .Project(projectionWithGenre);
var complexQueryResults = collection.Aggregate<BsonDocument>(complexPipeline).ToList();

Console.WriteLine("Complex query results: ");
foreach (var movie in complexQueryResults)
{
    Console.WriteLine($"  {movie}");
}
Console.WriteLine();

// Search using a multi analyzer
var queryUsingKeywordAnalyzer = new BsonDocument
{
    {
        "$search", new BsonDocument
        {
            {
                "text", new BsonDocument
                {
                    { "query", "The Count of Monte Cristo" },
                    { "path", new BsonDocument { { "value", "title" }, { "multi", "keywordAnalyzer" } } }
                }
            }
        }
    }
};
var pipelineUsingKeywordAnalyzer = new EmptyPipelineDefinition<BsonDocument>()
    .AppendStage<BsonDocument, BsonDocument, BsonDocument>(queryUsingKeywordAnalyzer)
    .Project(projection);
var moviesNamedTheCountOfMonteCristo = collection
    .Aggregate<BsonDocument>(pipelineUsingKeywordAnalyzer)
    .ToList();

Console.WriteLine(@"Movies named ""The Count of Monte Cristo"":");
foreach (var movie in moviesNamedTheCountOfMonteCristo)
{
    Console.WriteLine($"  {movie}");
}
Console.WriteLine();