DOCSP-46230: atlas search index mgmt

rustagir · rustagir · commit 034c6e85791d · 2025-02-11T10:38:04.000-05:00
diff --git a/docs/eloquent-models/schema-builder.txt b/docs/eloquent-models/schema-builder.txt
@@ -399,4 +399,99 @@ from the ``flights`` collection:
    :start-after: begin drop index
    :end-before: end drop index
 
+.. _laravel-schema-builder-atlas-idx:
 
+Manage Atlas Search and Vector Search Indexes
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In MongoDB, :atlas:`Atlas Search indexes
+</atlas-search/manage-indexes/>` support your full-text queries.
+:atlas:`Atlas Vector Search indexes
+</atlas-vector-search/vector-search-type/>` support similarity
+searches that compare query vectors to vector embeddings in your
+documents.
+
+View the following guides to learn more about the Atlas Search and
+Vector Search features:
+
+- :ref:`laravel-atlas-search` guide
+- :ref:`laravel-vector-search` guide
+
+Atlas Search
+````````````
+
+To create Atlas Search indexes, call the ``create()`` method on the
+``Schema`` facade in your migration file. Pass ``create()`` the
+collection name and a callback method with a
+``MongoDB\Laravel\Schema\Blueprint`` parameter. Pass the Atlas index
+creation details to the ``searchIndex()`` method on the ``Blueprint``
+instance.
+
+This example migration creates the following Atlas Search indexes on the
+``galaxies`` collection:
+
+- ``dynamic_index``: Creates dynamic mappings
+- ``auto_index``: Supports autocomplete queries on the ``name`` field
+
+Click the :guilabel:`{+code-output-label+}` button to see the Search
+indexes created by running the migration:
+
+.. io-code-block::
+   .. input:: /includes/schema-builder/galaxies_migration.php
+      :language: php
+      :dedent:
+      :start-after: begin-create-search-indexes
+      :end-before: end-create-search-indexes
+
+   .. output::
+      :language: json
+      :visible: false
+
+      WIP
+
+Vector Search
+`````````````
+
+To create Vector Search indexes, call the ``create()`` method on the
+``Schema`` facade in your migration file. Pass ``create()`` the
+collection name and a callback method with a
+``MongoDB\Laravel\Schema\Blueprint`` parameter. Pass the Atlas index
+creation details to the ``vectorSearchIndex()`` method on the ``Blueprint``
+instance.
+
+The following example migration creates a Vector Search index called
+``vs_index`` on the ``galaxies`` collection.
+
+Click the :guilabel:`{+code-output-label+}` button to see the Search
+indexes created by running the migration:
+
+.. io-code-block::
+   .. input:: /includes/schema-builder/galaxies_migration.php
+      :language: php
+      :dedent:
+      :start-after: begin-create-vs-index
+      :end-before: end-create-vs-index
+
+   .. output::
+      :language: json
+      :visible: false
+
+      WIP
+
+Drop a Search Index
+```````````````````
+
+To drop an Atlas Search or Vector Search index from a collection, call
+the ``table()`` method on the ``Schema`` facade in your migration file.
+Pass it the collection name and a callback method with a
+``MongoDB\Laravel\Schema\Blueprint`` parameter. Call the ``dropSearchIndex()``
+method with the Search index name on the ``Blueprint`` instance. 
+
+The following example migration drops an index called ``auto_index``
+from the ``galaxies`` collection:
+
+.. literalinclude:: /includes/schema-builder/galaxies_migration.php
+   :language: php
+   :dedent:
+   :start-after: begin-drop-search-index
+   :end-before: end-drop-search-index
diff --git a/docs/fundamentals/atlas-search.txt b/docs/fundamentals/atlas-search.txt
@@ -56,7 +56,25 @@ documentation.
 Create an Atlas Search Index
 ----------------------------
 
-.. TODO in DOCSP-46230
+You can create an Atlas Search index in either of the following ways:
+
+- Call the ``create()`` method on the ``Schema`` facade and pass the
+  ``searchIndex()`` helper method with index creation details. To learn
+  more about this strategy, see the
+  :ref:`laravel-schema-builder-atlas-idx` section of the Schema Builder guide.
+  
+- Access a collection, then call the
+  :phpmethod:`MongoDB\Collection::createSearchIndex()` from the
+  {+php-library+}, as shown in the following code:
+  
+  .. code-block:: php
+	 
+	 $collection = DB::connection('mongodb')->getCollection('movies');
+	 
+	 $collection->createSearchIndex(
+		 ['mappings' => ['dynamic' => true]], 
+		 ['name' => 'search_index']
+     );
 
 Perform Queries
 ---------------
@@ -93,23 +111,23 @@ model's ``title`` field for the term ``'dream'``:
    :copyable: true
 
    .. input:: /includes/fundamentals/as-avs/AtlasSearchTest.php
-      :language: php
-      :dedent:
-      :start-after: start-search-query
-      :end-before: end-search-query
+	  :language: php
+	  :dedent:
+	  :start-after: start-search-query
+	  :end-before: end-search-query
 
    .. output::
-      :language: json
-      :visible: false
-
-      [
-         { "title": "Dreaming of Jakarta",
-           "year": 1990
-         },
-         { "title": "See You in My Dreams",
-           "year": 1996
-         }
-      ]
+	  :language: json
+	  :visible: false
+
+	  [
+		 { "title": "Dreaming of Jakarta",
+		   "year": 1990
+		 },
+		 { "title": "See You in My Dreams",
+		   "year": 1996
+		 }
+	  ]
 
 You can use the ``search()`` method to perform many types of Atlas
 Search queries. Depending on your desired query, you can pass the
@@ -119,55 +137,55 @@ following optional parameters to ``search()``:
    :header-rows: 1
 
    * - Optional Parameter
-     - Type
-     - Description
+	 - Type
+	 - Description
 
    * - ``index``
-     - ``string``
-     - Provides the name of the Atlas Search index to use
+	 - ``string``
+	 - Provides the name of the Atlas Search index to use
 
    * - ``highlight``
-     - ``array``
-     - Specifies highlighting options for displaying search terms in their
-       original context
+	 - ``array``
+	 - Specifies highlighting options for displaying search terms in their
+	   original context
 
    * - ``concurrent``
-     - ``bool``
-     - Parallelizes search query across segments on dedicated search nodes
+	 - ``bool``
+	 - Parallelizes search query across segments on dedicated search nodes
 
    * - ``count``
-     - ``string``
-     - Specifies the count options for retrieving a count of the results
+	 - ``string``
+	 - Specifies the count options for retrieving a count of the results
 
    * - ``searchAfter``
-     - ``string``
-     - Specifies a reference point for returning documents starting
-       immediately following that point
+	 - ``string``
+	 - Specifies a reference point for returning documents starting
+	   immediately following that point
    
    * - ``searchBefore``
-     - ``string``
-     - Specifies a reference point for returning documents starting
-       immediately preceding that point
+	 - ``string``
+	 - Specifies a reference point for returning documents starting
+	   immediately preceding that point
 
    * - ``scoreDetails``
-     - ``bool``
-     - Specifies whether to retrieve a detailed breakdown of the score
-       for results
+	 - ``bool``
+	 - Specifies whether to retrieve a detailed breakdown of the score
+	   for results
    
    * - ``sort``
-     - ``array``
-     - Specifies the fields on which to sort the results
+	 - ``array``
+	 - Specifies the fields on which to sort the results
    
    * - ``returnStoredSource``
-     - ``bool``
-     - Specifies whether to perform a full document lookup on the
-       backend database or return only stored source fields directly
-       from Atlas Search
+	 - ``bool``
+	 - Specifies whether to perform a full document lookup on the
+	   backend database or return only stored source fields directly
+	   from Atlas Search
    
    * - ``tracking``
-     - ``array``
-     - Specifies the tracking option to retrieve analytics information
-       on the search terms
+	 - ``array``
+	 - Specifies the tracking option to retrieve analytics information
+	   on the search terms
 
 To learn more about these parameters, see the :atlas:`Fields
 </atlas-search/aggregation-stages/search/#fields>` section of the
@@ -200,20 +218,20 @@ string ``"jak"`` on the ``title`` field:
    :copyable: true
 
    .. input:: /includes/fundamentals/as-avs/AtlasSearchTest.php
-      :language: php
-      :dedent:
-      :start-after: start-auto-query
-      :end-before: end-auto-query
+	  :language: php
+	  :dedent:
+	  :start-after: start-auto-query
+	  :end-before: end-auto-query
 
    .. output::
-      :language: json
-      :visible: false
+	  :language: json
+	  :visible: false
 
-      [
-         "Dreaming of Jakarta",
-         "Jakob the Liar",
-         "Emily Calling Jake"
-      ]
+	  [
+		 "Dreaming of Jakarta",
+		 "Jakob the Liar",
+		 "Emily Calling Jake"
+	  ]
 
 You can also pass the following optional parameters to the ``autocomplete()``
 method to customize the query:
@@ -222,19 +240,19 @@ method to customize the query:
    :header-rows: 1
 
    * - Optional Parameter
-     - Type
-     - Description
-     - Default Value
+	 - Type
+	 - Description
+	 - Default Value
 
    * - ``fuzzy``
-     - ``bool`` or ``array``
-     - Enables fuzzy search and fuzzy search options
-     - ``false``
+	 - ``bool`` or ``array``
+	 - Enables fuzzy search and fuzzy search options
+	 - ``false``
 
    * - ``tokenOrder``
-     - ``string``
-     - Specifies order in which to search for tokens
-     - ``'any'``
+	 - ``string``
+	 - Specifies order in which to search for tokens
+	 - ``'any'``
 
 To learn more about these parameters, see the :atlas:`Options
 </atlas-search/autocomplete/#options>` section of the
diff --git a/docs/fundamentals/vector-search.txt b/docs/fundamentals/vector-search.txt
@@ -56,7 +56,32 @@ documentation.
 Create an Atlas Vector Search Index
 -----------------------------------
 
-.. TODO in DOCSP-46230
+You can create an Atlas Search index in either of the following ways:
+
+- Call the ``create()`` method on the ``Schema`` facade and pass the
+  ``vectorSearchIndex()`` helper method with index creation details. To learn
+  more about this strategy, see the
+  :ref:`laravel-schema-builder-atlas-idx` section of the Schema Builder guide.
+  
+- Access a collection, then call the
+  :phpmethod:`MongoDB\Collection::createSearchIndex()` from the
+  {+php-library+}. You must specify the ``type`` option as
+  ``'vectorSearch'``, as shown in the following code:
+  
+  .. code-block:: php
+     
+     $collection = DB::connection('mongodb')->getCollection('movies');
+     
+     $collection->createSearchIndex([
+         'fields' => [
+             [
+                 'type' => 'vector',
+                 'numDimensions' => 4,
+                 'path' => 'embeddings',
+                 'similarity' => 'cosine'
+             ],
+         ],
+     ], ['name' => 'vector_index', 'type' => 'vectorSearch']);
 
 Perform Queries
 ---------------
diff --git a/docs/includes/schema-builder/galaxies_migration.php b/docs/includes/schema-builder/galaxies_migration.php
