CSHARP-4440: Incorporate MongoDB.Labs.Search library

Author: BorisDog

src/MongoDB.Driver/AggregateFluent.cs

@@ -240,13 +240,21 @@ public override IAggregateFluent<TNewResult> ReplaceWith<TNewResult>(AggregateEx
         }
 
         public override IAggregateFluent<TResult> Search(
-            SearchDefinition<TResult> query,
+            SearchDefinition<TResult> searchDefinition,
             HighlightOptions<TResult> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
             bool returnStoredSource = false)
         {
-            return WithPipeline(_pipeline.Search(query, highlight, indexName, count, returnStoredSource));
+            return WithPipeline(_pipeline.Search(searchDefinition, highlight, indexName, count, returnStoredSource));
+        }
+
+        public override IAggregateFluent<SearchMetaResult> SearchMeta(
+            SearchDefinition<TResult> searchDefinition,
+            string indexName = null,
+            SearchCountOptions count = null)
+        {
+            return WithPipeline(_pipeline.SearchMeta(searchDefinition, indexName, count));
         }
 
         public override IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(

src/MongoDB.Driver/AggregateFluentBase.cs

@@ -227,6 +227,15 @@ public virtual IAggregateFluent<TResult> Search(
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
+        public virtual IAggregateFluent<SearchMetaResult> SearchMeta(
+            SearchDefinition<TResult> searchDefinition,
+            string indexName = null,
+            SearchCountOptions count = null)
+        {
+            throw new NotImplementedException();
+        }
+
         /// <inheritdoc />
         public virtual IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output)

src/MongoDB.Driver/Builders.cs

@@ -39,13 +39,22 @@ public static class Builders<TDocument>
         public static UpdateDefinitionBuilder<TDocument> Update { get; } = new UpdateDefinitionBuilder<TDocument>();
 
         // Search builders
+        /// <summary>Gets a <see cref="SearchFacetBuilder{TDocument}"/>.</summary>
+        public static SearchFacetBuilder<TDocument> Facet { get; } = new SearchFacetBuilder<TDocument>();
+
         /// <summary>Gets a <see cref="PathDefinition{TDocument}"/>.</summary>
         public static PathDefinitionBuilder<TDocument> Path { get; } = new PathDefinitionBuilder<TDocument>();
 
         /// <summary>Gets a <see cref="ScoreDefinitionBuilder{TDocument}"/>.</summary>
         public static ScoreDefinitionBuilder<TDocument> Score { get; } = new ScoreDefinitionBuilder<TDocument>();
 
+        /// <summary>Gets a <see cref="ScoreFunctionBuilder{TDocument}"/>.</summary>
+        public static ScoreFunctionBuilder<TDocument> ScoreFunction { get; } = new ScoreFunctionBuilder<TDocument>();
+
         /// <summary>Gets a <see cref="SearchDefinitionBuilder{TDocument}"/>.</summary>
         public static SearchDefinitionBuilder<TDocument> Search { get; } = new SearchDefinitionBuilder<TDocument>();
+
+        /// <summary> Gets a <see cref="SpanDefinitionBuilder{TDocument}"/>.</summary>
+        public static SpanDefinitionBuilder<TDocument> Span { get; } = new SpanDefinitionBuilder<TDocument>();
     }
 }

src/MongoDB.Driver/IAggregateFluent.cs

@@ -357,7 +357,7 @@ IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
         /// <summary>
         /// Appends a $search stage to the pipeline.
         /// </summary>
-        /// <param name="query">The search definition.</param>
+        /// <param name="searchDefinition">The search definition.</param>
         /// <param name="highlight">The highlight options.</param>
         /// <param name="indexName">The index name.</param>
         /// <param name="count">The count options.</param>
@@ -367,12 +367,24 @@ IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
         /// </param>
         /// <returns>The fluent aggregate interface.</returns>
         IAggregateFluent<TResult> Search(
-            SearchDefinition<TResult> query,
+            SearchDefinition<TResult> searchDefinition,
             HighlightOptions<TResult> highlight = null,
             string indexName = null,
             SearchCountOptions count = null,
             bool returnStoredSource = false);
 
+        /// <summary>
+        /// Appends a $searchMeta stage to the pipeline.
+        /// </summary>
+        /// <param name="searchDefinition">The search definition.</param>
+        /// <param name="indexName">The index name.</param>
+        /// <param name="count">The count options.</param>
+        /// <returns>The fluent aggregate interface.</returns>
+        IAggregateFluent<SearchMetaResult> SearchMeta(
+            SearchDefinition<TResult> searchDefinition,
+            string indexName = null,
+            SearchCountOptions count = null);
+
         /// <summary>
         /// Appends a $setWindowFields to the pipeline.
         /// </summary>

src/MongoDB.Driver/PipelineDefinitionBuilder.cs

@@ -1192,6 +1192,28 @@ public static PipelineDefinition<TInput, TOutput> Search<TInput, TOutput>(
             return pipeline.AppendStage(PipelineStageDefinitionBuilder.Search(searchDefinition, highlight, indexName, count, returnStoredSource));
         }
 
+        /// <summary>
+        /// Appends a $searchMeta stage to the pipeline.
+        /// </summary>
+        /// <typeparam name="TInput">The type of the input documents.</typeparam>
+        /// <typeparam name="TOutput">The type of the output documents.</typeparam>
+        /// <param name="pipeline">The pipeline.</param>
+        /// <param name="query">The search definition.</param>
+        /// <param name="indexName">The index name.</param>
+        /// <param name="count">The count options.</param>
+        /// <returns>
+        /// A new pipeline with an additional stage.
+        /// </returns>
+        public static PipelineDefinition<TInput, SearchMetaResult> SearchMeta<TInput, TOutput>(
+            this PipelineDefinition<TInput, TOutput> pipeline,
+            SearchDefinition<TOutput> query,
+            string indexName = null,
+            SearchCountOptions count = null)
+        {
+            Ensure.IsNotNull(pipeline, nameof(pipeline));
+            return pipeline.AppendStage(PipelineStageDefinitionBuilder.SearchMeta(query, indexName, count));
+        }
+
         /// <summary>
         /// Create a $setWindowFields stage.
         /// </summary>

src/MongoDB.Driver/PipelineStageDefinitionBuilder.cs

@@ -1349,6 +1349,40 @@ public static PipelineStageDefinition<TInput, TInput> Search<TInput>(
             return stage;
         }
 
+        /// <summary>
+        /// Creates a $searchMeta stage.
+        /// </summary>
+        /// <typeparam name="TInput">The type of the input documents.</typeparam>
+        /// <param name="searchDefinition">The search definition.</param>
+        /// <param name="indexName">The index name.</param>
+        /// <param name="count">The count options.</param>
+        /// <returns>The stage.</returns>
+        public static PipelineStageDefinition<TInput, SearchMetaResult> SearchMeta<TInput>(
+            SearchDefinition<TInput> searchDefinition,
+            string indexName = null,
+            SearchCountOptions count = null)
+        {
+            Ensure.IsNotNull(searchDefinition, nameof(searchDefinition));
+
+            const string operatorName = "$searchMeta";
+            var stage = new DelegatedPipelineStageDefinition<TInput, SearchMetaResult>(
+                operatorName,
+                (s, sr, linqProvider) =>
+                {
+                    var renderedSearchDefinition = searchDefinition.Render(s, sr);
+                    renderedSearchDefinition.Add("count", () => count.Render(), count != null);
+                    renderedSearchDefinition.Add("index", indexName, indexName != null);
+
+                    var document = new BsonDocument(operatorName, renderedSearchDefinition);
+                    return new RenderedPipelineStageDefinition<SearchMetaResult>(
+                        operatorName,
+                        document,
+                        sr.GetSerializer<SearchMetaResult>());
+                });
+
+            return stage;
+        }
+
         /// <summary>
         /// Creates a $replaceRoot stage.
         /// </summary>

src/MongoDB.Driver/ProjectionDefinitionBuilder.cs

@@ -156,6 +156,40 @@ public static ProjectionDefinition<TDocument> Meta<TDocument>(this ProjectionDef
             return builder.Combine(projection, builder.Meta(field, metaFieldName));
         }
 
+        /// <summary>
+        /// Combines an existing projection with a search highlights projection.
+        /// </summary>
+        /// <typeparam name="TDocument">The type of the document.</typeparam>
+        /// <param name="projection">The projection.</param>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A combined projection.
+        /// </returns>
+        public static ProjectionDefinition<TDocument> MetaSearchHighlights<TDocument>(
+            this ProjectionDefinition<TDocument> projection,
+            string field)
+        {
+            var builder = Builders<TDocument>.Projection;
+            return builder.Combine(projection, builder.MetaSearchHighlights(field));
+        }
+
+        /// <summary>
+        /// Combines an existing projection with a search score projection.
+        /// </summary>
+        /// <typeparam name="TDocument">The type of the document.</typeparam>
+        /// <param name="projection">The projection.</param>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A combined projection.
+        /// </returns>
+        public static ProjectionDefinition<TDocument> MetaSearchScore<TDocument>(
+            this ProjectionDefinition<TDocument> projection,
+            string field)
+        {
+            var builder = Builders<TDocument>.Projection;
+            return builder.Combine(projection, builder.MetaSearchScore(field));
+        }
+
         /// <summary>
         /// Combines an existing projection with a text score projection.
         /// </summary>
@@ -171,6 +205,40 @@ public static ProjectionDefinition<TDocument> MetaTextScore<TDocument>(this Proj
             return builder.Combine(projection, builder.MetaTextScore(field));
         }
 
+        /// <summary>
+        /// Combines an existing projection with a search metadata projection.
+        /// </summary>
+        /// <typeparam name="TDocument">The type of the document.</typeparam>
+        /// <param name="projection">The projection.</param>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A combined projection.
+        /// </returns>
+        public static ProjectionDefinition<TDocument> SearchMeta<TDocument>(
+            this ProjectionDefinition<TDocument> projection,
+            FieldDefinition<TDocument> field)
+        {
+            var builder = Builders<TDocument>.Projection;
+            return builder.Combine(projection, builder.SearchMeta(field));
+        }
+
+        /// <summary>
+        /// Combines an existing projection with a search metadata projection.
+        /// </summary>
+        /// <typeparam name="TDocument">The type of the document.</typeparam>
+        /// <param name="projection">The projection.</param>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A combined projection.
+        /// </returns>
+        public static ProjectionDefinition<TDocument> SearchMeta<TDocument>(
+            this ProjectionDefinition<TDocument> projection,
+            Expression<Func<TDocument, object>> field)
+        {
+            var builder = Builders<TDocument>.Projection;
+            return builder.Combine(projection, builder.SearchMeta(field));
+        }
+
         /// <summary>
         /// Combines an existing projection with an array slice projection.
         /// </summary>
@@ -363,6 +431,30 @@ public ProjectionDefinition<TSource> Meta(string field, string metaFieldName)
             return new SingleFieldProjectionDefinition<TSource>(field, new BsonDocument("$meta", metaFieldName));
         }
 
+        /// <summary>
+        /// Creates a search highlights projection.
+        /// </summary>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A search highlights projection.
+        /// </returns>
+        public ProjectionDefinition<TSource> MetaSearchHighlights(string field)
+        {
+            return Meta(field, "searchHighlights");
+        }
+
+        /// <summary>
+        /// Creates a search score projection.
+        /// </summary>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A search score projection.
+        /// </returns>
+        public ProjectionDefinition<TSource> MetaSearchScore(string field)
+        {
+            return Meta(field, "searchScore");
+        }
+
         /// <summary>
         /// Creates a text score projection.
         /// </summary>
@@ -375,6 +467,30 @@ public ProjectionDefinition<TSource> MetaTextScore(string field)
             return Meta(field, "textScore");
         }
 
+        /// <summary>
+        /// Creates a search metadata projection.
+        /// </summary>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A search metadata projection.
+        /// </returns>
+        public ProjectionDefinition<TSource> SearchMeta(FieldDefinition<TSource> field)
+        {
+            return new SingleFieldProjectionDefinition<TSource>(field, new BsonString("$$SEARCH_META"));
+        }
+
+        /// <summary>
+        /// Creates a search metadata projection.
+        /// </summary>
+        /// <param name="field">The field.</param>
+        /// <returns>
+        /// A search metadata projection.
+        /// </returns>
+        public ProjectionDefinition<TSource> SearchMeta(Expression<Func<TSource, object>> field)
+        {
+            return SearchMeta(new ExpressionFieldDefinition<TSource>(field));
+        }
+
         /// <summary>
         /// Creates an array slice projection.
         /// </summary>

src/MongoDB.Driver/Search/AutocompleteTokenOrder.cs

@@ -0,0 +1,33 @@
+// Copyright 2010-present MongoDB Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+namespace MongoDB.Driver.Search
+{
+    /// <summary>
+    /// The order in which to search for tokens in an autocomplete search definition.
+    /// </summary>
+    public enum AutocompleteTokenOrder
+    {
+        /// <summary>
+        /// Indicates that tokens in the query can appear in any order in the documents.
+        /// </summary>
+        Any,
+        
+        /// <summary>
+        /// Indicates that tokens in the query must appear adjacent to each other or in the order
+        /// specified in the query in the documents.
+        /// </summary>
+        Sequential
+    }
+}