Skip to content

Commit ed64278

Browse files
(DOCSP-29553): Add Atlas Search index methods to shell docs (#269)
* (DOCSP-29553): Add Atlas Search index methods to shell docs * update snooty.toml to include master branch * typo * update snooty.toml again * use upcoming only for Atlas Search methods
1 parent ba3be60 commit ed64278

File tree

2 files changed

+49
-1
lines changed

2 files changed

+49
-1
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "mongodb-shell"
22
title = "MongoDB Shell"
33

4-
intersphinx = ["https://www.mongodb.com/docs/manual/objects.inv"]
4+
intersphinx = [ "https://www.mongodb.com/docs/manual/objects.inv" ]
55

66
toc_landing_pages = ["/run-commands",
77
"/crud",

source/reference/methods.txt

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,54 @@ Administration Methods
5656
- Allows writes to continue on a database locked with
5757
:method:`db.fsyncLock()`.
5858

59+
.. _mongosh-methods-atlas-search:
60+
61+
Atlas Search Index Methods
62+
--------------------------
63+
64+
:atlas:`Atlas Search indexes
65+
</atlas-search/atlas-search-overview/#fts-indexes>` let you query data
66+
in :atlas:`Atlas Search </atlas-search>`. Atlas Search indexes enable
67+
performant text search queries by mapping search terms to the documents
68+
that contain those terms.
69+
70+
Use the following methods to manage Atlas Search indexes.
71+
72+
.. important::
73+
74+
The following methods can only be run on deployments hosted on
75+
:atlas:`MongoDB Atlas </>`.
76+
77+
.. list-table::
78+
:widths: 30 70
79+
:header-rows: 1
80+
81+
* - Name
82+
83+
- Description
84+
85+
* - :upcoming:`db.collection.createSearchIndex()
86+
</reference/method/db.collection.createSearchIndex>`
87+
88+
- Creates one or more Atlas Search indexes on a specified
89+
collection.
90+
91+
* - :upcoming:`db.collection.dropSearchIndex()
92+
</reference/method/db.collection.dropSearchIndex>`
93+
94+
- Deletes an existing Atlas Search index.
95+
96+
* - :upcoming:`db.collection.getSearchIndexes()
97+
</reference/method/db.collection.getSearchIndexes>`
98+
99+
- Returns information about existing Atlas Search indexes on a specified
100+
collection.
101+
102+
* - :upcoming:`db.collection.updateSearchIndex()
103+
</reference/method/db.collection.updateSearchIndex>`
104+
105+
- Updates an existing Atlas Search index.
106+
59107
Bulk Operation Methods
60108
----------------------
61109

0 commit comments

Comments
 (0)