- Search text operator

Author: BorisDog

src/MongoDB.Driver.Core/Core/Misc/Ensure.cs

@@ -83,16 +83,18 @@ public static T IsGreaterThanOrEqualTo<T>(T value, T comparand, string paramName
         }
 
         /// <summary>
-        /// Ensures that the value of a parameter is greater than or equal to zero.
+        /// Ensures that the value of a parameter is greater than a comparand.
         /// </summary>
+        /// <typeparam name="T">Type type of the value.</typeparam>
         /// <param name="value">The value of the parameter.</param>
+        /// <param name="comparand">The comparand.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static int IsGreaterThanOrEqualToZero(int value, string paramName)
+        public static T IsGreaterThan<T>(T value, T comparand, string paramName) where T : IComparable<T>
         {
-            if (value < 0)
+            if (value.CompareTo(comparand) <= 0)
             {
-                var message = string.Format("Value is not greater than or equal to 0: {0}.", value);
+                var message = $"Value is not greater than {comparand}: {value}.";
                 throw new ArgumentOutOfRangeException(paramName, message);
             }
             return value;
@@ -104,79 +106,62 @@ public static int IsGreaterThanOrEqualToZero(int value, string paramName)
         /// <param name="value">The value of the parameter.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static long IsGreaterThanOrEqualToZero(long value, string paramName)
-        {
-            if (value < 0)
-            {
-                var message = string.Format("Value is not greater than or equal to 0: {0}.", value);
-                throw new ArgumentOutOfRangeException(paramName, message);
-            }
-            return value;
-        }
+        public static int IsGreaterThanOrEqualToZero(int value, string paramName) =>
+            IsGreaterThanOrEqualTo(value, 0, paramName);
 
         /// <summary>
         /// Ensures that the value of a parameter is greater than or equal to zero.
         /// </summary>
         /// <param name="value">The value of the parameter.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static TimeSpan IsGreaterThanOrEqualToZero(TimeSpan value, string paramName)
-        {
-            if (value < TimeSpan.Zero)
-            {
-                var message = string.Format("Value is not greater than or equal to zero: {0}.", TimeSpanParser.ToString(value));
-                throw new ArgumentOutOfRangeException(paramName, message);
-            }
-            return value;
-        }
+        public static long IsGreaterThanOrEqualToZero(long value, string paramName) =>
+            IsGreaterThanOrEqualTo(value, 0, paramName);
+
+        /// <summary>
+        /// Ensures that the value of a parameter is greater than or equal to zero.
+        /// </summary>
+        /// <param name="value">The value of the parameter.</param>
+        /// <param name="paramName">The name of the parameter.</param>
+        /// <returns>The value of the parameter.</returns>
+        public static TimeSpan IsGreaterThanOrEqualToZero(TimeSpan value, string paramName) =>
+            IsGreaterThanOrEqualTo(value, TimeSpan.Zero, paramName);
 
         /// <summary>
         /// Ensures that the value of a parameter is greater than zero.
         /// </summary>
         /// <param name="value">The value of the parameter.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static int IsGreaterThanZero(int value, string paramName)
-        {
-            if (value <= 0)
-            {
-                var message = string.Format("Value is not greater than zero: {0}.", value);
-                throw new ArgumentOutOfRangeException(paramName, message);
-            }
-            return value;
-        }
+        public static int IsGreaterThanZero(int value, string paramName) =>
+            IsGreaterThan(value, 0, paramName);
 
         /// <summary>
         /// Ensures that the value of a parameter is greater than zero.
         /// </summary>
         /// <param name="value">The value of the parameter.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static long IsGreaterThanZero(long value, string paramName)
-        {
-            if (value <= 0)
-            {
-                var message = string.Format("Value is not greater than zero: {0}.", value);
-                throw new ArgumentOutOfRangeException(paramName, message);
-            }
-            return value;
-        }
+        public static long IsGreaterThanZero(long value, string paramName) =>
+            IsGreaterThan(value, 0, paramName);
 
         /// <summary>
         /// Ensures that the value of a parameter is greater than zero.
         /// </summary>
         /// <param name="value">The value of the parameter.</param>
         /// <param name="paramName">The name of the parameter.</param>
         /// <returns>The value of the parameter.</returns>
-        public static TimeSpan IsGreaterThanZero(TimeSpan value, string paramName)
-        {
-            if (value <= TimeSpan.Zero)
-            {
-                var message = string.Format("Value is not greater than zero: {0}.", value);
-                throw new ArgumentOutOfRangeException(paramName, message);
-            }
-            return value;
-        }
+        public static double IsGreaterThanZero(double value, string paramName) =>
+            IsGreaterThan(value, 0, paramName);
+
+        /// <summary>
+        /// Ensures that the value of a parameter is greater than zero.
+        /// </summary>
+        /// <param name="value">The value of the parameter.</param>
+        /// <param name="paramName">The name of the parameter.</param>
+        /// <returns>The value of the parameter.</returns>
+        public static TimeSpan IsGreaterThanZero(TimeSpan value, string paramName) =>
+            IsGreaterThan(value, TimeSpan.Zero, paramName);
 
         /// <summary>
         /// Ensures that the value of a parameter is infinite or greater than or equal to zero.
@@ -298,6 +283,24 @@ public static T IsNull<T>(T value, string paramName) where T : class
             return value;
         }
 
+        /// <summary>
+        /// Ensures that the value of a parameter is null or is between a minimum and a maximum value.
+        /// </summary>
+        /// <typeparam name="T">Type type of the value.</typeparam>
+        /// <param name="value">The value of the parameter.</param>
+        /// <param name="min">The minimum value.</param>
+        /// <param name="max">The maximum value.</param>
+        /// <param name="paramName">The name of the parameter.</param>
+        /// <returns>The value of the parameter.</returns>
+        public static T? IsNullOrBetween<T>(T? value, T min, T max, string paramName) where T : struct, IComparable<T>
+        {
+            if (value != null)
+            {
+                IsBetween(value.Value, min, max, paramName);
+            }
+            return value;
+        }
+
         /// <summary>
         /// Ensures that the value of a parameter is null or greater than or equal to zero.
         /// </summary>

src/MongoDB.Driver/AggregateFluent.cs

@@ -13,13 +13,14 @@
 * limitations under the License.
 */
 
-using MongoDB.Bson;
-using MongoDB.Bson.Serialization;
-using MongoDB.Driver.Core.Misc;
 using System.Collections.Generic;
 using System.Linq;
 using System.Threading;
 using System.Threading.Tasks;
+using MongoDB.Bson;
+using MongoDB.Bson.Serialization;
+using MongoDB.Driver.Core.Misc;
+using MongoDB.Driver.Search;
 
 namespace MongoDB.Driver
 {
@@ -238,6 +239,16 @@ public override IAggregateFluent<TNewResult> ReplaceWith<TNewResult>(AggregateEx
             return WithPipeline(_pipeline.ReplaceWith(newRoot));
         }
 
+        public override IAggregateFluent<TResult> Search(
+            SearchDefinition<TResult> query,
+            HighlightOptions<TResult> highlight = null,
+            string indexName = null,
+            SearchCountOptions count = null,
+            bool returnStoredSource = false)
+        {
+            return WithPipeline(_pipeline.Search(query, highlight, indexName, count, returnStoredSource));
+        }
+
         public override IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output)
         {

src/MongoDB.Driver/AggregateFluentBase.cs

@@ -19,6 +19,7 @@
 using System.Threading.Tasks;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization;
+using MongoDB.Driver.Search;
 
 namespace MongoDB.Driver
 {
@@ -215,6 +216,17 @@ public virtual IAggregateFluent<TNewResult> ReplaceWith<TNewResult>(AggregateExp
             throw new NotImplementedException();
         }
 
+        /// <inheritdoc />
+        public virtual IAggregateFluent<TResult> Search(
+            SearchDefinition<TResult> query,
+            HighlightOptions<TResult> highlight = null,
+            string indexName = null,
+            SearchCountOptions count = null,
+            bool returnStoredSource = false)
+        {
+            throw new NotImplementedException();
+        }
+
         /// <inheritdoc />
         public virtual IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output)

src/MongoDB.Driver/Builders.cs

@@ -13,6 +13,8 @@
 * limitations under the License.
 */
 
+using MongoDB.Driver.Search;
+
 namespace MongoDB.Driver
 {
     /// <summary>
@@ -21,50 +23,29 @@ namespace MongoDB.Driver
     /// <typeparam name="TDocument">The type of the document.</typeparam>
     public static class Builders<TDocument>
     {
-        private static FilterDefinitionBuilder<TDocument> __filter = new FilterDefinitionBuilder<TDocument>();
-        private static IndexKeysDefinitionBuilder<TDocument> __index = new IndexKeysDefinitionBuilder<TDocument>();
-        private static ProjectionDefinitionBuilder<TDocument> __projection = new ProjectionDefinitionBuilder<TDocument>();
-        private static SortDefinitionBuilder<TDocument> __sort = new SortDefinitionBuilder<TDocument>();
-        private static UpdateDefinitionBuilder<TDocument> __update = new UpdateDefinitionBuilder<TDocument>();
+        /// <summary>Gets a <see cref="FilterDefinitionBuilder{TDocument}"/>.</summary>
+        public static FilterDefinitionBuilder<TDocument> Filter { get; } = new FilterDefinitionBuilder<TDocument>();
+
+        /// <summary>Gets an <see cref="IndexKeysDefinitionBuilder{TDocument}"/>.</summary>
+        public static IndexKeysDefinitionBuilder<TDocument> IndexKeys { get; } = new IndexKeysDefinitionBuilder<TDocument>();
+
+        /// <summary>Gets a <see cref="ProjectionDefinitionBuilder{TDocument}"/>.</summary>
+        public static ProjectionDefinitionBuilder<TDocument> Projection { get; } = new ProjectionDefinitionBuilder<TDocument>();
 
-        /// <summary>
-        /// Gets a <see cref="FilterDefinitionBuilder{TDocument}"/>.
-        /// </summary>
-        public static FilterDefinitionBuilder<TDocument> Filter
-        {
-            get { return __filter; }
-        }
+        /// <summary>Gets a <see cref="SortDefinitionBuilder{TDocument}"/>.</summary>
+        public static SortDefinitionBuilder<TDocument> Sort { get; } = new SortDefinitionBuilder<TDocument>();
 
-        /// <summary>
-        /// Gets an <see cref="IndexKeysDefinitionBuilder{TDocument}"/>.
-        /// </summary>
-        public static IndexKeysDefinitionBuilder<TDocument> IndexKeys
-        {
-            get { return __index; }
-        }
+        /// <summary>Gets an <see cref="UpdateDefinitionBuilder{TDocument}"/>.</summary>
+        public static UpdateDefinitionBuilder<TDocument> Update { get; } = new UpdateDefinitionBuilder<TDocument>();
 
-        /// <summary>
-        /// Gets a <see cref="ProjectionDefinitionBuilder{TDocument}"/>.
-        /// </summary>
-        public static ProjectionDefinitionBuilder<TDocument> Projection
-        {
-            get { return __projection; }
-        }
+        // Search builders
+        /// <summary>Gets a <see cref="PathDefinition{TDocument}"/>.</summary>
+        public static PathDefinitionBuilder<TDocument> Path { get; } = new PathDefinitionBuilder<TDocument>();
 
-        /// <summary>
-        /// Gets a <see cref="SortDefinitionBuilder{TDocument}"/>.
-        /// </summary>
-        public static SortDefinitionBuilder<TDocument> Sort
-        {
-            get { return __sort; }
-        }
+        /// <summary>Gets a <see cref="ScoreDefinitionBuilder{TDocument}"/>.</summary>
+        public static ScoreDefinitionBuilder<TDocument> Score { get; } = new ScoreDefinitionBuilder<TDocument>();
 
-        /// <summary>
-        /// Gets an <see cref="UpdateDefinitionBuilder{TDocument}"/>.
-        /// </summary>
-        public static UpdateDefinitionBuilder<TDocument> Update
-        {
-            get { return __update; }
-        }
+        /// <summary>Gets a <see cref="SearchDefinitionBuilder{TDocument}"/>.</summary>
+        public static SearchDefinitionBuilder<TDocument> Search { get; } = new SearchDefinitionBuilder<TDocument>();
     }
 }

src/MongoDB.Driver/IAggregateFluent.cs

@@ -19,6 +19,7 @@
 using System.Threading.Tasks;
 using MongoDB.Bson;
 using MongoDB.Bson.Serialization;
+using MongoDB.Driver.Search;
 
 namespace MongoDB.Driver
 {
@@ -353,6 +354,25 @@ IAggregateFluent<TNewResult> Lookup<TForeignDocument, TAsElement, TAs, TNewResul
         IAggregateFluent<BsonDocument> SetWindowFields<TWindowFields>(
             AggregateExpressionDefinition<ISetWindowFieldsPartition<TResult>, TWindowFields> output);
 
+        /// <summary>
+        /// Appends a $search stage to the pipeline.
+        /// </summary>
+        /// <param name="query">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>
+        /// <param name="returnStoredSource">
+        /// Flag that specifies whether to perform a full document lookup on the backend database
+        /// or return only stored source fields directly from Atlas Search.
+        /// </param>
+        /// <returns>The fluent aggregate interface.</returns>
+        IAggregateFluent<TResult> Search(
+            SearchDefinition<TResult> query,
+            HighlightOptions<TResult> highlight = null,
+            string indexName = null,
+            SearchCountOptions count = null,
+            bool returnStoredSource = false);
+
         /// <summary>
         /// Appends a $setWindowFields to the pipeline.
         /// </summary>

src/MongoDB.Driver/Linq/MongoQueryable.cs

@@ -21,6 +21,7 @@
 using System.Threading;
 using System.Threading.Tasks;
 using MongoDB.Bson.Serialization;
+using MongoDB.Driver.Search;
 
 namespace MongoDB.Driver.Linq
 {
@@ -923,6 +924,33 @@ public static IMongoQueryable<TSource> Sample<TSource>(this IMongoQueryable<TSou
                     Expression.Constant(count)));
         }
 
+        /// <summary>
+        /// Appends a $search stage to the LINQ pipeline
+        /// </summary>
+        /// <typeparam name="TSource">The type of the elements of <paramref name="source" />.</typeparam>
+        /// <param name="source">A sequence of values.</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>
+        /// <param name="returnStoredSource">
+        /// Flag that specifies whether to perform a full document lookup on the backend database
+        /// or return only stored source fields directly from Atlas Search.
+        /// </param>
+        /// <returns>The fluent aggregate interface.</returns>
+        public static IMongoQueryable<TSource> Search<TSource>(
+            this IMongoQueryable<TSource> source,
+            SearchDefinition<TSource> searchDefinition,
+            HighlightOptions<TSource> highlight = null,
+            string indexName = null,
+            SearchCountOptions count = null,
+            bool returnStoredSource = false)
+        {
+            return AppendStage(
+                source,
+                PipelineStageDefinitionBuilder.Search(searchDefinition, highlight, indexName, count, returnStoredSource));
+        }
+
         /// <summary>
         /// Projects each element of a sequence into a new form by incorporating the
         /// element's index.

src/MongoDB.Driver/MongoUtils.cs

@@ -14,8 +14,6 @@
 */
 
 using System;
-using System.Runtime.InteropServices;
-using System.Security;
 using System.Security.Cryptography;
 using System.Text;
 using MongoDB.Bson;
@@ -61,5 +59,8 @@ public static string ToCamelCase(string value)
         {
             return value.Length == 0 ? "" : value.Substring(0, 1).ToLower() + value.Substring(1);
         }
+
+        internal static string ToCamelCase<TEnum>(this TEnum @enum) where TEnum : Enum =>
+           ToCamelCase(@enum.ToString());
     }
 }