Skip to content

Commit 1e76c20

Browse files
authored
DOCSP-36056 listSearchIndexes Visibility (#6767) (#6848)
* DOCSP-36056 listSearchIndexes Visibility * build errors * atlas-first edit * adjust TOC + better highlight Atlas Search index methods
1 parent 2291e22 commit 1e76c20

File tree

5 files changed

+39
-17
lines changed

5 files changed

+39
-17
lines changed

source/reference/command/listIndexes.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,13 @@ database.
7373
Behavior
7474
--------
7575

76+
Atlas Search Indexes
77+
~~~~~~~~~~~~~~~~~~~~
78+
79+
``listIndexes`` does not return information on :atlas:`{+fts+} indexes
80+
</atlas-search/atlas-search-overview/#fts-indexes>`. Instead, use
81+
:pipeline:`$listSearchIndexes`.
82+
7683
.. |operation| replace:: :dbcommand:`listIndexes`
7784
.. |operations| replace:: :dbcommand:`listIndexes`
7885

source/reference/method.txt

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,24 @@
1616

1717
.. include:: /includes/extracts/methods-toc-explanation.rst
1818

19+
Atlas Search Index Methods
20+
--------------------------
21+
22+
.. include:: /includes/atlas-search-commands/mongosh-method-intro.rst
23+
24+
.. |fts-index| replace:: {+fts+} index
25+
26+
.. |fts-indexes| replace:: {+fts+} indexes
27+
28+
.. include:: /includes/atlas-search-commands/mongosh-method-table.rst
29+
30+
31+
.. toctree::
32+
:titlesonly:
33+
:hidden:
34+
35+
/reference/method/js-atlas-search
36+
1937
Collection
2038
----------
2139

@@ -1272,20 +1290,3 @@ Client-Side Field Level Encryption
12721290
:hidden:
12731291

12741292
/reference/method/js-client-side-field-level-encryption
1275-
1276-
Atlas Search Index Methods
1277-
--------------------------
1278-
1279-
.. include:: /includes/atlas-search-commands/mongosh-method-intro.rst
1280-
1281-
.. |fts-index| replace:: {+fts+} index
1282-
1283-
.. |fts-indexes| replace:: {+fts+} indexes
1284-
1285-
.. include:: /includes/atlas-search-commands/mongosh-method-table.rst
1286-
1287-
.. toctree::
1288-
:titlesonly:
1289-
:hidden:
1290-
1291-
/reference/method/js-atlas-search

source/reference/method/db.collection.getIndexes.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ Definition
3737
Behavior
3838
--------
3939

40+
Atlas Search Indexes
41+
~~~~~~~~~~~~~~~~~~~~
42+
43+
``getIndexes()`` does not return information on :atlas:`{+fts+} indexes
44+
</atlas-search/atlas-search-overview/#fts-indexes>`. For information on Atlas
45+
Search indexes, use :pipeline:`$listSearchIndexes`.
46+
4047
.. |operation| replace:: :method:`db.collection.getIndexes()`
4148
.. |operations| replace:: :dbcommand:`listIndexes`
4249

source/reference/method/js-atlas-search.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _atlas-search-index-methods:
2+
13
==========================
24
Atlas Search Index Methods
35
==========================

source/reference/method/js-collection.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,11 @@ Collection Methods
204204

205205
- Performs diagnostic operations on a collection.
206206

207+
.. seealso::
208+
209+
To manage :atlas:`{+fts+} indexes </atlas-search/atlas-search-overview/#fts-indexes>`,
210+
see :ref:`atlas-search-index-methods`.
211+
207212

208213
.. toctree::
209214
:titlesonly:

0 commit comments

Comments
 (0)