如何在C# MongoDB.Driver中实现返回$$SEARCH_META的Facet搜索

要实现$facet中meta阶段的{$replaceWith: "$$SEARCH_META"}，核心是处理MongoDB的系统变量$$SEARCH_META——它不属于实体类的属性，无法通过强类型表达式直接引用，需要用BsonDocument或显式聚合表达式来定义该阶段。以下是具体实现方案：

方案1：直接用BsonDocument构建完整聚合管道 #

这种方式完全匹配MongoDB原生聚合语法，实现简单直接：

// 假设集合实例为IMongoCollection<Book> collection
var pipeline = new BsonDocument[]
{
    // $search阶段
    new BsonDocument("$search", new BsonDocument
    {
        ["text"] = new BsonDocument
        {
            ["query"] = "mongodb",
            ["path"] = "title"
        }
    }),
    // $project阶段
    new BsonDocument("$project", new BsonDocument
    {
        ["title"] = 1,
        ["_id"] = 0
    }),
    // $facet阶段，包含books和meta分面
    new BsonDocument("$facet", new BsonDocument
    {
        ["books"] = new BsonArray
        {
            new BsonDocument("$limit", 10)
        },
        ["meta"] = new BsonArray
        {
            // 核心：指定$replaceWith为$$SEARCH_META系统变量
            new BsonDocument("$replaceWith", "$$SEARCH_META")
        }
    })
};

// 执行聚合查询
var result = await collection.AggregateAsync<BsonDocument>(pipeline);
var facetResult = await result.FirstOrDefaultAsync();

// 解析结果
var books = facetResult["books"].AsBsonArray.Select(b => b.AsBsonDocument.ToObject<Book>());
var searchMeta = facetResult["meta"].AsBsonArray.First().AsBsonDocument;

方案2：结合强类型API与显式聚合阶段 #

如果你更倾向于使用MongoDB.Driver的强类型构建器，可以通过PipelineStageDefinitionBuilder定义$replaceWith阶段：

步骤1：定义meta分面的管道 #

// 定义返回$$SEARCH_META的阶段，输出类型为BsonDocument（或自定义实体）
var replaceWithMetaStage = PipelineStageDefinitionBuilder.ReplaceWith<Book, BsonDocument>(
    new BsonDocument("$replaceWith", "$$SEARCH_META")
);

var metaFacetPipeline = new PipelineStageDefinition<Book, BsonDocument>[] { replaceWithMetaStage };

步骤2：构建$facet阶段 #

// books分面的管道（示例仅包含$limit）
var booksFacetPipeline = new PipelineStageDefinition<Book, Book>[]
{
    PipelineStageDefinitionBuilder.Limit<Book>(10)
};

// 组装完整$facet阶段
var facetStage = PipelineStageDefinitionBuilder.Facet(
    new FacetPipelineDefinition<Book, Book>("books", booksFacetPipeline),
    new FacetPipelineDefinition<Book, BsonDocument>("meta", metaFacetPipeline)
);

步骤3：组装并执行整个聚合管道 #

// 构建$search和$project阶段
var searchStage = new BsonDocument("$search", new BsonDocument
{
    ["text"] = new BsonDocument { ["query"] = "mongodb", ["path"] = "title" }
});
var projectStage = Builders<Book>.Projection.Include(b => b.Title).Exclude(b => b.Id);
var projectPipeline = PipelineStageDefinitionBuilder.Project<Book, Book>(projectStage);

// 组装完整管道
var fullPipeline = new PipelineDefinition<Book, BsonDocument>[]
{
    searchStage,
    projectPipeline,
    facetStage
};

// 执行查询并解析结果
var result = await collection.AggregateAsync(fullPipeline);
var facetResult = await result.FirstOrDefaultAsync();

可选：自定义SearchMeta实体类 #

如果想将$$SEARCH_META结果映射到强类型对象，可以定义对应的实体类：

public class SearchMeta
{
    [BsonElement("score")]
    public double Score { get; set; }
    
    [BsonElement("facets")]
    public Dictionary<string, object> Facets { get; set; }
    
    // 根据你的Atlas Search配置添加其他字段，比如counts等
}

将meta阶段的输出类型改为SearchMeta即可实现强类型映射：

var replaceWithMetaStage = PipelineStageDefinitionBuilder.ReplaceWith<Book, SearchMeta>(
    new BsonDocument("$replaceWith", "$$SEARCH_META")
);
var metaFacetPipeline = new PipelineStageDefinition<Book, SearchMeta>[] { replaceWithMetaStage };

解析结果时直接映射：

var searchMeta = facetResult["meta"].AsBsonArray.First().AsBsonDocument.ToObject<SearchMeta>();

内容的提问来源于stack exchange，提问作者O'Neil Tomlinson