EF-281: Support building "Atlas" search indexes

Fluent API for building search indexes.

Author: ajcvickers

README.md

@@ -90,6 +90,8 @@ Entity Framework Core and MongoDB have a wide variety of features. This provider
 - `CamelCaseElementNameConvention` for helping map Pascal-cased C# properties to camel-cased BSON elements
 - Type discriminators including `OfType<T>` and `Where(e => e is T)`
 - Support for EF shadow properties and EF.Proxy for navigation traversal
+- MongoDB full text search
+- MongoDB vector search
 - [Client Side Field Level Encryption](https://www.mongodb.com/docs/manual/core/csfle/quick-start/) and [Queryable Encryption](https://www.mongodb.com/docs/manual/core/queryable-encryption/) compatibility
 
 ## Limitations
@@ -103,7 +105,6 @@ in the mean-time consider using the existing [MongoDB C# Driver's](https://githu
 - GroupBy operations
 - Includes/joins
 - Geospatial
-- Atlas search
 - ExecuteUpdate & ExecuteDelete bulk operations (EF 9 only)
 
 ### Not supported, out-of-scope features
@@ -119,7 +120,7 @@ in the mean-time consider using the existing [MongoDB C# Driver's](https://githu
 ## Breaking changes
 
 This project's version-numbers are aligned with Entity Framework Core and as-such we can not use the semver convention of constraining breaking changes solely to major version numbers. Please keep an eye on our [Breaking Changes](/BREAKING-CHANGES.md) document before upgrading to a new version of this provider.
- 
+
 ## Documentation
 
 - [MongoDB](https://www.mongodb.com/docs)

src/MongoDB.EntityFrameworkCore/Diagnostics/MongoEventId.cs

@@ -50,6 +50,7 @@ private enum Id
         VectorSearchNeedsIndex,
         VectorSearchReturnedZeroResults,
         WaitingForVectorIndex,
+        WaitingForSearchIndex,
     }
 
     private static EventId MakeDatabaseCommandId(Id id)
@@ -226,4 +227,13 @@ private static EventId MakeDatabaseId(Id id)
     ///     <para>This event uses the <see cref="TimeSpanEventData" /> payload when used with a <see cref="DiagnosticSource" />.</para>
     /// </remarks>
     public static readonly EventId WaitingForVectorIndex = MakeDatabaseId(Id.WaitingForVectorIndex);
+
+    /// <summary>
+    /// EF Core is waiting for search indexes to be ready.
+    /// </summary>
+    /// <remarks>
+    ///     <para>This event is in the <see cref="DbLoggerCategory.Database" /> category.</para>
+    ///     <para>This event uses the <see cref="TimeSpanEventData" /> payload when used with a <see cref="DiagnosticSource" />.</para>
+    /// </remarks>
+    public static readonly EventId WaitingForSearchIndex = MakeDatabaseId(Id.WaitingForSearchIndex);
 }

src/MongoDB.EntityFrameworkCore/Diagnostics/MongoLoggerExtensions.cs

@@ -376,7 +376,6 @@ private static EventDefinition<string, string, string> LogVectorSearchReturnedZe
         "'DbContext.Database.WaitForVectorIndexes'.";
 
 
-
     public static void WaitingForVectorIndex(
         this IDiagnosticsLogger<DbLoggerCategory.Database> diagnostics,
         TimeSpan remainingBeforeTimeout)
@@ -424,4 +423,53 @@ private static EventDefinition<string> LogWaitingForVectorIndex(IDiagnosticsLogg
     private const string WaitingForVectorIndexString =
         "EF Core is waiting for vector indexes to be ready. The time remaining before failing with a timeout is " +
         "{secondsRemaining} seconds.";
+
+
+    public static void WaitingForSearchIndex(
+        this IDiagnosticsLogger<DbLoggerCategory.Database> diagnostics,
+        TimeSpan remainingBeforeTimeout)
+    {
+        var definition = LogWaitingForSearchIndex(diagnostics);
+
+        if (diagnostics.ShouldLog(definition))
+        {
+            definition.Log(diagnostics, remainingBeforeTimeout.TotalSeconds.ToString(CultureInfo.InvariantCulture));
+        }
+
+        if (diagnostics.NeedsEventData(definition, out var diagnosticSourceEnabled, out var simpleLogEnabled))
+        {
+            var eventData = new TimeSpanEventData(
+                definition,
+                (d, p) => ((EventDefinition<string>)d).GenerateMessage(
+                    ((TimeSpanEventData)p).TimeSpan.TotalSeconds.ToString(CultureInfo.InvariantCulture)),
+                    remainingBeforeTimeout);
+            diagnostics.DispatchEventData(definition, eventData, diagnosticSourceEnabled, simpleLogEnabled);
+        }
+    }
+
+    private static EventDefinition<string> LogWaitingForSearchIndex(IDiagnosticsLogger logger)
+    {
+        var definition = ((MongoLoggingDefinitions)logger.Definitions).LogWaitingForSearchIndex;
+        if (definition == null)
+        {
+            definition = NonCapturingLazyInitializer.EnsureInitialized(
+                ref ((MongoLoggingDefinitions)logger.Definitions).LogWaitingForSearchIndex,
+                logger,
+                static logger => new EventDefinition<string>(
+                    logger.Options,
+                    MongoEventId.WaitingForSearchIndex,
+                    LogLevel.Information,
+                    "MongoEventId.WaitingForSearchIndex",
+                    level => LoggerMessage.Define<string>(
+                        level,
+                        MongoEventId.WaitingForSearchIndex,
+                        WaitingForSearchIndexString)));
+        }
+
+        return (EventDefinition<string>)definition;
+    }
+
+    private const string WaitingForSearchIndexString =
+        "EF Core is waiting for search indexes to be ready. The time remaining before failing with a timeout is " +
+        "{secondsRemaining} seconds.";
 }

src/MongoDB.EntityFrameworkCore/Diagnostics/MongoLoggingDefinitions.cs

@@ -47,4 +47,5 @@ internal class MongoLoggingDefinitions : LoggingDefinitions
     public EventDefinitionBase? LogVectorSearchReturnedZeroResults;
 
     public EventDefinitionBase? LogWaitingForVectorIndex;
+    public EventDefinitionBase? LogWaitingForSearchIndex;
 }

src/MongoDB.EntityFrameworkCore/Extensions/MongoDatabaseFacadeExtensions.cs

@@ -21,6 +21,8 @@
 using Microsoft.EntityFrameworkCore.Storage;
 using MongoDB.Driver;
 using MongoDB.EntityFrameworkCore.Metadata;
+using MongoDB.EntityFrameworkCore.Metadata.Search;
+using MongoDB.EntityFrameworkCore.Metadata.Search.Definitions;
 using MongoDB.EntityFrameworkCore.Storage;
 
 // ReSharper disable once CheckNamespace
@@ -34,7 +36,8 @@ public static class MongoDatabaseFacadeExtensions
 {
     /// <summary>
     /// Creates an index in MongoDB based on the EF Core <see cref="IIndex"/> definition. No attempt is made to check that the index
-    /// does not already exist and can therefore be created. The index may be an Atlas index or a normal MongoDB index.
+    /// does not already exist and can therefore be created. The index may be a MongoDB search index, MongoDB vector search index,
+    /// or a normal MongoDB index.
     /// </summary>
     /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
     /// <param name="index">The <see cref="IIndex"/> definition.</param>
@@ -47,7 +50,8 @@ public static void CreateIndex(this DatabaseFacade databaseFacade, IIndex index)
 
     /// <summary>
     /// Creates an index in MongoDB based on the EF Core <see cref="IIndex"/> definition. No attempt is made to check that the index
-    /// does not already exist and can therefore be created. The index may be an Atlas index or a normal MongoDB index.
+    /// does not already exist and can therefore be created. The index may be a MongoDB search index, MongoDB vector index, or a
+    /// normal MongoDB index.
     /// </summary>
     /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
     /// <param name="index">The <see cref="IIndex"/> definition.</param>
@@ -62,14 +66,14 @@ public static Task CreateIndexAsync(this DatabaseFacade databaseFacade, IIndex i
 
     /// <summary>
     /// Creates indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for which there
-    /// is not already an index in the database. This method only creates regular, non-Atlas indexes.
+    /// is not already an index in the database. This method only creates regular, non-search and non-vector search indexes.
     /// </summary>
     /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
     public static void CreateMissingIndexes(this DatabaseFacade databaseFacade)
         => GetDatabaseCreator(databaseFacade).CreateMissingIndexes();
 
     /// <summary>
-    /// Creates missing Atlas vector indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for
+    /// Creates missing MongoDB vector indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for
     /// which there is not already an index in the database.
     /// </summary>
     /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
@@ -78,7 +82,7 @@ public static void CreateMissingVectorIndexes(this DatabaseFacade databaseFacade
 
     /// <summary>
     /// Creates indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for which there
-    /// is not already an index in the database. This method only creates regular, non-Atlas indexes.
+    /// is not already an index in the database. This method only creates regular, non-search and non-vector search indexes.
     /// </summary>
     /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
     /// <param name="cancellationToken">A <see cref="CancellationToken"/> that can be used to cancel this asynchronous request.</param>
@@ -87,7 +91,7 @@ public static Task CreateMissingIndexesAsync(this DatabaseFacade databaseFacade,
         => GetDatabaseCreator(databaseFacade).CreateMissingIndexesAsync(cancellationToken);
 
     /// <summary>
-    /// Creates missing Atlas vector indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for
+    /// Creates missing MongoDB vector indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for
     /// which there is not already an index in the database.
     /// </summary>
     /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
@@ -118,6 +122,46 @@ public static void WaitForVectorIndexes(this DatabaseFacade databaseFacade, Time
     public static Task WaitForVectorIndexesAsync(this DatabaseFacade databaseFacade, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
         => GetDatabaseCreator(databaseFacade).WaitForVectorIndexesAsync(timeout, cancellationToken);
 
+    /// <summary>
+    /// Creates missing MongoDB search indexes in the MongoDB database for all <see cref="IIndex"/> definitions in the EF Core model for
+    /// which there is not already an index in the database.
+    /// </summary>
+    /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
+    public static void CreateMissingSearchIndexes(this DatabaseFacade databaseFacade)
+        => GetDatabaseCreator(databaseFacade).CreateMissingSearchIndexes();
+
+    /// <summary>
+    /// Creates missing MongoDB search indexes in the MongoDB database for all <see cref="SearchIndexDefinition"/> definitions in
+    /// the EF Core model for which there is not already an index in the database.
+    /// </summary>
+    /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/> that can be used to cancel this asynchronous request.</param>
+    /// <returns>A <see cref="Task"/> to track this async operation.</returns>
+    public static Task CreateMissingSearchIndexesAsync(this DatabaseFacade databaseFacade, CancellationToken cancellationToken = default)
+        => GetDatabaseCreator(databaseFacade).CreateMissingSearchIndexesAsync(cancellationToken);
+
+    /// <summary>
+    /// Blocks until all search indexes in the mapped collections are reporting the 'READY' state.
+    /// </summary>
+    /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
+    /// <param name="timeout">The minimum amount of time to wait for all indexes to be 'READY' before aborting.
+    /// The default is 60 seconds. Zero seconds means no timeout.</param>
+    /// <exception cref="InvalidOperationException">if the timeout expires before all indexes are 'READY'.</exception>
+    public static void WaitForSearchIndexes(this DatabaseFacade databaseFacade, TimeSpan? timeout = null)
+        => GetDatabaseCreator(databaseFacade).WaitForSearchIndexes(timeout);
+
+    /// <summary>
+    /// Blocks until all search indexes in the mapped collections are reporting the 'READY' state.
+    /// </summary>
+    /// <param name="databaseFacade">The <see cref="DatabaseFacade"/> from the EF Core <see cref="Microsoft.EntityFrameworkCore.DbContext"/>.</param>
+    /// <param name="timeout">The minimum amount of time to wait for all indexes to be 'READY' before aborting.
+    /// The default is 60 seconds. Zero seconds means no timeout.</param>
+    /// <param name="cancellationToken">A <see cref="CancellationToken"/> that can be used to cancel this asynchronous request.</param>
+    /// <returns>A <see cref="Task"/> to track this async operation.</returns>
+    /// <exception cref="InvalidOperationException">if the timeout expires before all indexes are 'READY'.</exception>
+    public static Task WaitForSearchIndexesAsync(this DatabaseFacade databaseFacade, TimeSpan? timeout = null, CancellationToken cancellationToken = default)
+        => GetDatabaseCreator(databaseFacade).WaitForSearchIndexesAsync(timeout, cancellationToken);
+
     /// <summary>
     /// Ensures that the database for the context exists. If it exists, no action is taken. If it does not
     /// exist then the MongoDB database is created using the <see cref="MongoDatabaseCreationOptions"/> to determine what