Skip to content

Commit 87ba14d

Browse files
jeff-allen-mongojeff-allen-mongo
authored
DOCSP-27853: Atlas search mongosh methods (#3390)
* (DOCSP-29546): db.createSearchIndex method (#3140) * (DOCSP-29546): db.createSearchIndex method * fix build errors * add sub-page for mongosh methods * fix build errors * change page title * add wrapper info * add landing page in snooty.toml * typo * edits * wording * simplify layout * tweak example intro * remove quotes in field names * address review comments * single-source table intro * tweak intro * fix formatting * remove accidentally added file (#3290) * (DOCSP-29548): db.collection.updateSearchIndex method (#3292) * (DOCSP-29548): db.collection.updateSearchIndex method * add method descriptions to tables * add new method page to toc * fix release note wording * first pass at replacements * fix replacements * more replacements * replacement for drop * make example runnable * update replacements * fix example * (DOCSP-29549): dropSearchIndex mongosh method (#3307) * (DOCSP-29549): dropSearchIndex mongosh method * standardize collections in examples * (DOCSP-29881): Add Atlas Search db command outputs (#3139) (#3360) * (DOCSP-29881): Add Atlas Search db command outputs * wording * wording * typo * wording * change admonition language to point to listSearchIndexes * fix stage name * adjust language for updateSearchIndex response * edits * DOCSP-29552: db.collection.getSearchIndexes method page (#3369) * WIP * update toc * final first draft * fix build errors * fix replacement * fix replacement * fix replacement * wording * remove periods * wording * typo * add link * add missing replacement * address review comments * fix build error * fix build error * typo * single source create access control * fix typo * single source access control sections * add name option * typo * wording * wording * fix section titles * standardize casing * DOCSP-29544: $listSearchIndexes aggregation stage (#3382) * WIP * WIP * change file name * first draft * add missing ref * add learn more * fixups * fix id type * remove extra file * fix id mismatch * edit * fix section title * add lead-in to example subsections * edits to BUILDING description per Evan * adjust table widths
1 parent e18af7c commit 87ba14d

32 files changed

+1173
-68
lines changed

‎snooty.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,7 @@ toc_landing_pages = [
127127
"/reference/command/nav-user-management",
128128
"/reference/configuration-options",
129129
"/reference/method",
130+
"/reference/method/js-atlas-search",
130131
"/reference/method/js-bulk",
131132
"/reference/method/js-client-side-field-level-encryption",
132133
"/reference/method/js-collection",

‎source/includes/atlas-search-commands/access-control/create-access-control.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
If your deployment enforces access control, the user running
2+
|method-name| must have the :authaction:`createSearchIndexes` privilege
3+
action on the database or collection:
4+
5+
.. code-block:: javascript
6+
7+
{
8+
resource: {
9+
db : <database>,
10+
collection: <collection>
11+
},
12+
actions: [ "createSearchIndexes" ]
13+
}
14+
15+
The built-in :authrole:`readWrite` role provides the
16+
``createSearchIndexes`` privilege. The following example grants
17+
``accountUser01`` the ``readWrite`` role on the ``products`` database:
18+
19+
.. code-block:: javascript
20+
21+
db.grantRolesToUser(
22+
"accountUser01",
23+
[ { role: "readWrite", db: "products" } ]
24+
)

‎source/includes/atlas-search-commands/access-control/drop-access-control.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
If your deployment enforces access control, the user running
2+
|method-name| must have the :authaction:`dropSearchIndex` privilege
3+
action on the database or collection:
4+
5+
.. code-block:: javascript
6+
7+
{
8+
resource: {
9+
db : <database>,
10+
collection: <collection>
11+
},
12+
actions: [ "dropSearchIndex" ]
13+
}
14+
15+
The built-in :authrole:`dbAdmin` and :authrole:`readWrite` roles provide
16+
the ``dropSearchIndex`` privilege. The following example grants the
17+
``readWrite`` role on the ``qa`` database:
18+
19+
.. code-block:: javascript
20+
21+
db.grantRolesToUser(
22+
"<user>",
23+
[ { role: "readWrite", db: "qa" } ]
24+
)

‎source/includes/atlas-search-commands/access-control/list-access-control.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
If your deployment enforces access control, the user running
2+
|method-name| must have the :authaction:`listSearchIndexes` privilege
3+
action on the database or collection:
4+
5+
.. code-block:: javascript
6+
7+
{
8+
resource: {
9+
db : <database>,
10+
collection: <collection>
11+
},
12+
actions: [ "listSearchIndexes" ]
13+
}
14+
15+
The built-in :authrole:`read` role provides the the
16+
``listSearchIndexes`` privilege. The following example grants the
17+
``read`` role on the ``qa`` database:
18+
19+
.. code-block:: javascript
20+
21+
db.grantRolesToUser(
22+
"<user>",
23+
[ { role: "read", db: "qa" } ]
24+
)

‎source/includes/atlas-search-commands/access-control/update-access-control.rst

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
If your deployment enforces access control, the user running
2+
|method-name| must have the :authaction:`updateSearchIndex` privilege
3+
action on the database or collection:
4+
5+
.. code-block:: javascript
6+
7+
{
8+
resource: {
9+
db : <database>,
10+
collection: <collection>
11+
},
12+
actions: [ "updateSearchIndex" ]
13+
}
14+
15+
The built-in :authrole:`dbAdmin` and :authrole:`restore` roles provide
16+
the ``updateSearchIndex`` privilege. The following example grants the
17+
``restore`` role on the ``admin`` database:
18+
19+
.. code-block:: javascript
20+
21+
db.grantRolesToUser(
22+
"<user>",
23+
[ { role: "restore", db: "admin" } ]
24+
)

‎source/includes/atlas-search-commands/command-descriptions/createSearchIndex-method.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Creates an |fts-index| on a specified collection.

‎source/includes/atlas-search-commands/command-descriptions/createSearchIndexes-description.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
1-
Creates one or more :atlas:`{+fts+} indexes
2-
</atlas-search/atlas-search-overview/#fts-indexes>` on a specified
3-
collection.
1+
Creates one or more |fts-indexes| on a specified collection.

‎source/includes/atlas-search-commands/command-descriptions/dropSearchIndex-description.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
Deletes an existing :atlas:`{+fts+} index
2-
</atlas-search/atlas-search-overview/#fts-indexes>`.
1+
Deletes an existing |fts-index|.

‎source/includes/atlas-search-commands/command-descriptions/getSearchIndexes-description.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Returns information about existing |fts-indexes| on a specified
2+
collection.

‎source/includes/atlas-search-commands/command-descriptions/updateSearchIndex-description.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
Updates an existing :atlas:`{+fts+} index
2-
</atlas-search/atlas-search-overview/#fts-indexes>`.
1+
Updates an existing |fts-index|.

0 commit comments

Comments
 (0)