@@ -20,8 +20,8 @@ Atlas Search Indexes
20
20
Overview
21
21
--------
22
22
23
- The Atlas Search feature enables you to perform full-text searches on
24
- collections hosted on MongoDB Atlas. The indexes specify the behavior of
23
+ :atlas:` Atlas Search </atlas-search>` enables you to perform full-text searches on
24
+ collections hosted on MongoDB Atlas. Atlas Search indexes specify the behavior of
25
25
the search and which fields to index.
26
26
27
27
You can call the following methods on a collection to manage your Atlas Search
@@ -35,10 +35,9 @@ indexes:
35
35
36
36
.. note::
37
37
38
- The Atlas Search Index management methods run asynchronously. The
39
- driver methods can return before confirming that they ran
40
- successfully. To determine the current status of the indexes, call the
41
- ``listSearchIndexes()`` method.
38
+ The Atlas Search index management methods run asynchronously, and might return before
39
+ confirming that they ran successfully. To determine the current status of the indexes,
40
+ call the ``listSearchIndexes()`` method.
42
41
43
42
The following sections provide code examples that demonstrate how to use
44
43
each of the preceding methods.
@@ -50,7 +49,7 @@ Create a Search Index
50
49
51
50
You can use the `createSearchIndex() <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-collection/create-search-index.html>`__
52
51
and the `createSearchIndexes() <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-collection/create-search-indexes.html>`__
53
- methods to create Atlas Search indexes.
52
+ methods to create one or more Atlas Search indexes.
54
53
55
54
The following code example shows how to create a single index:
56
55
@@ -68,16 +67,20 @@ The following code example shows how to create multiple indexes:
68
67
:end-before: end-create-search-indexes
69
68
:dedent:
70
69
70
+ To learn more about the syntax used when defining Atlas Search indexes, see the
71
+ :atlas:`Review Atlas Search Index Syntax </atlas-search/index-definitions>` guide
72
+ in the Atlas manual.
73
+
71
74
.. _kotlin-sync-atlas-search-index-list:
72
75
73
76
List Search Indexes
74
77
-------------------
75
78
76
79
You can use the
77
80
`listSearchIndexes() <{+api+}/mongodb-driver-kotlin-sync/com.mongodb.kotlin.client/-mongo-collection/list-search-indexes.html>`__
78
- method to return the Atlas Search indexes of a collection.
81
+ method to return all Atlas Search indexes in a collection.
79
82
80
- The following code example shows how to print a list of the search indexes of
83
+ The following code example shows how to print a list of the search indexes in
81
84
a collection:
82
85
83
86
.. literalinclude:: /includes/indexes/indexes.kt
0 commit comments