DOCSP-30756: add list search indexes to cursor page #704

nickldp · 2023-06-28T14:19:26Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-30756
Staging -
Cursor page
Indexes

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?

davidhou17 · 2023-06-28T17:25:02Z

Hey @nickldp, I originally reported this ticket, and the change is actually much smaller than what you have drafted, so apologies if this wasn't defined clearly! We only need to add the Collection.listSearchIndexes() function to the following list on the cursor page:

The function itself isn't a cursor paradigm, just a function that returns a cursor. Cursor paradigms allow you to retrieve data from the cursor. Let me know if you have any questions!

rustagir

good start! I suggested moving content and requested some other changes. let me know if you want to talk about any comments.

rustagir · 2023-06-28T17:16:26Z

source/fundamentals/crud/read-operations/cursor.txt

+Return Search Indexes of Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()


Suggested change

When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()

When connecting to {+mdb-server+} version 7.0 or later, you can use the new `listSearchIndex()

rustagir · 2023-06-28T17:17:03Z

source/fundamentals/crud/read-operations/cursor.txt

@@ -114,6 +114,24 @@ through results rather than returning all documents at once.
   :start-after: start fetchAll cursor example
   :end-before: end fetchAll cursor example

+Return Search Indexes of Collection


Suggested change

Return Search Indexes of Collection

List Search Indexes

rustagir · 2023-06-28T17:20:29Z

source/fundamentals/crud/read-operations/cursor.txt

@@ -114,6 +114,24 @@ through results rather than returning all documents at once.
   :start-after: start fetchAll cursor example
   :end-before: end fetchAll cursor example

+Return Search Indexes of Collection


I: I'm not sure that this content belongs on this page. This page is about different ways to access data from a cursor, not about methods that return cursors. I think that you could add a section instead to the Indexes fundamentals page that covers this new method and the existing listIndexes() method.

S: Move this section to Indexes and add information also about using listIndexes(). On this page, the only change that should be made is adding this method the list at the top of the page under "The following functions directly return cursors:"

rustagir · 2023-06-28T17:21:23Z

source/fundamentals/crud/read-operations/cursor.txt

+When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()
+<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__
+to return a cursor with all the search indexes for the current
+collection. ``listSearchIndex()`` has an optional string parameter, ``name``, to


Suggested change

When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()

<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__

to return a cursor with all the search indexes for the current

collection. ``listSearchIndex()`` has an optional string parameter, ``name``, to

When using a v7.0 and later {+mdb-server+} cluster, you can use the `listSearchIndex()

<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__ method

to return a cursor that contains the search indexes for a

collection. ``listSearchIndex()`` has an optional string parameter, ``name``, to

rustagir · 2023-06-28T17:21:56Z

source/fundamentals/crud/read-operations/cursor.txt

+When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()
+<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__
+to return a cursor with all the search indexes for the current
+collection. ``listSearchIndex()`` has an optional string parameter, ``name``, to


S: Don't start sentences with monospace text if possible. Introduce methods as The ... method or types as the ... type

rustagir · 2023-06-28T17:22:28Z

source/fundamentals/crud/read-operations/cursor.txt

+Return Search Indexes of Collection
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()


Suggested change

When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()

When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndexes()

rustagir · 2023-06-28T17:22:57Z

source/fundamentals/crud/read-operations/cursor.txt

+<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__
+to return a cursor with all the search indexes for the current
+collection. ``listSearchIndex()`` has an optional string parameter, ``name``, to
+return only the indexes with matching index names. It also has an


Suggested change

return only the indexes with matching index names. It also has an

return only the indexes with matching index names. It also takes an

rustagir · 2023-06-28T17:23:34Z

source/fundamentals/crud/read-operations/cursor.txt

+optional ``aggregateOptions`` parameter. For more information, visit the
+`API Documentation 
+<https://mongodb.github.io/node-mongodb-native/Next/interfaces/AggregateOptions.html>`__. 


S link the API documentation for aggregateOptions from that word and omit this sentence

rustagir · 2023-06-28T17:24:25Z

source/code-snippets/crud/cursor.js

@@ -60,6 +60,16 @@ async function rewind(myColl) {
  // end rewind cursor example
 }

+async function listIndexSearch(myColl){
+  // start listIndexSearch example
+  const cursor = myColl.listIndexSearch();


I: Isn't this the wrong method name?

Suggested change

const cursor = myColl.listIndexSearch();

const cursor = myColl.listSearchIndexes();

rustagir · 2023-06-28T17:26:59Z

source/code-snippets/crud/cursor.js

@@ -60,6 +60,16 @@ async function rewind(myColl) {
  // end rewind cursor example
 }

+async function listIndexSearch(myColl){


See example code here

Also, if you move the content from the Cursor page to the indexes page, you will have to move this code to a different file as well.

rustagir

a few more things -- good work responding to comments!

rustagir · 2023-06-28T19:21:41Z

source/fundamentals/indexes.txt

+The ``listIndexes()`` method allows you to list all the indexes'
+information in the collection. The ``listIndexes()`` method takes an


Suggested change

The ``listIndexes()`` method allows you to list all the indexes'

information in the collection. The ``listIndexes()`` method takes an

You can use the ``listIndexes()`` method to list all of the indexes

for a collection. The ``listIndexes()`` method takes an

rustagir · 2023-06-28T19:22:04Z

source/fundamentals/indexes.txt

+optional parameter, `ListIndexesOptions
+<{+api+}/interfaces/ListIndexesOptions.html>`__, to set optional


Suggested change

optional parameter, `ListIndexesOptions

<{+api+}/interfaces/ListIndexesOptions.html>`__, to set optional

optional `ListIndexesOptions <{+api+}/interfaces/ListIndexesOptions.html>`__ parameter to set optional

rustagir · 2023-06-28T19:22:20Z

source/fundamentals/indexes.txt

+optional parameter, `ListIndexesOptions
+<{+api+}/interfaces/ListIndexesOptions.html>`__, to set optional


S; remove this clause of the sentence

rustagir · 2023-06-28T19:23:31Z

source/fundamentals/indexes.txt

+The following example uses the ``listIndexes()`` method to list all the
+indexes' information in the collection.


S: change wording to match above suggestion from the first sentence

rustagir · 2023-06-28T19:24:02Z

source/fundamentals/indexes.txt

@@ -312,3 +312,42 @@ the following:
   E11000 duplicate key error index

 To learn more, see :manual:`Unique Indexes </core/index-unique>`.
+
+List Indexes
+~~~~~~~~~~~~


S: make this a header one level up, as the section is not an index type

source/fundamentals/indexes.txt

rustagir · 2023-06-28T19:24:59Z

source/fundamentals/indexes.txt

+method to return a cursor that contains the search indexes for the current
+collection. The ``listSearchIndexes()`` method takes an optional string parameter, ``name``, to


Q: What does current mean in this context? Can't you just call the method on whatever collection you want?

Good point, thank you!

nickldp · 2023-06-28T19:44:31Z

Hey @nickldp, I originally reported this ticket, and the change is actually much smaller than what you have drafted, so apologies if this wasn't defined clearly! We only need to add the Collection.listSearchIndexes() function to the following list on the cursor page:

The function itself isn't a cursor paradigm, just a function that returns a cursor. Cursor paradigms allow you to retrieve data from the cursor. Let me know if you have any questions!

Hi @davidhou17! Thanks for letting me know and for the helpful information! Thankfully we found a new home for what I had drafted so it wasn't a waste. Thanks for reaching out! Also, wanted to let you know you have some very clean PRs and I have definitely been trying to take some of that style :)

rustagir

approving but please resolve the last few things

rustagir · 2023-06-28T19:53:36Z

source/code-snippets/indexes/listIndexes.js

+    const result = await collection.listIndexes().toArray();
+    console.log("The indexes in the collection are: ");
+    for(const doc in result){
+    console.log(doc);


S: this line should be indented. Maybe re-run the formatter on your code? Also applies to other snippet

rustagir · 2023-06-28T19:56:52Z

source/fundamentals/indexes.txt

+List Indexes
+------------
+
+You can use the ``listIndexes()`` method to list all of the indexes


S: link to API docs for listIndexes() somewhere. same for below

rustagir · 2023-06-28T20:01:32Z

source/fundamentals/indexes.txt

+~~~~~~~~~~~~~~~~~~~
+
+When connecting to {+mdb-server+} version 7.0 or later, you can use the new `listSearchIndexes()
+<https://mongodb.github.io/node-mongodb-native/Next/classes/Collection.html#listSearchIndexes>`__


Investigating why the 5.6 docs don't cover this method

rustagir · 2023-06-28T20:02:33Z

source/fundamentals/indexes.txt

+The following example uses the ``listIndexes()`` method to list all the
+indexes in a collection.


Suggested change

The following example uses the ``listIndexes()`` method to list all the

indexes in a collection.

The following code uses the ``listIndexes()`` method to list all the

indexes in a collection:

rustagir · 2023-06-28T20:02:43Z

source/fundamentals/indexes.txt

+The following example uses the ``listSearchIndexes()`` method to list all
+the search indexes in the collection.


Suggested change

The following example uses the ``listSearchIndexes()`` method to list all

the search indexes in the collection.

The following code uses the ``listSearchIndexes()`` method to list all

the search indexes in the collection:

rustagir · 2023-06-28T20:03:02Z

source/fundamentals/indexes.txt

+the search indexes in the collection.
+
+.. literalinclude:: /code-snippets/indexes/listSearchIndexes.js
+   :language: javascript


add :dedent:

rustagir · 2023-06-28T20:04:48Z

source/code-snippets/indexes/listIndexes.js

+  try {
+    // start listIndexes example
+    const result = await collection.listIndexes().toArray();
+    console.log("The indexes in the collection are: ");


S: Per the style guide, we do not introduce lists with fragment sentences. (also applies to other file)

Perhaps something like this would be better:

Suggested change

console.log("The indexes in the collection are: ");

console.log("Existing indexes:\n");

* first draft * first draft * first draft * first draft * first draft * first draft v1.1 * big fixes * big fixes * review fixes (cherry picked from commit 966fe9f)

* first draft * first draft * first draft * first draft * first draft * first draft v1.1 * big fixes * big fixes * review fixes

nickldp added 6 commits June 27, 2023 16:36

first draft

c2a5560

first draft

6f16227

first draft

cd551bd

first draft

93e332e

first draft

b3bcf76

first draft v1.1

9363c6c

rustagir requested changes Jun 28, 2023

View reviewed changes

big fixes

314d3c0

nickldp requested a review from rustagir June 28, 2023 18:43

big fixes

c4e33d5

rustagir requested changes Jun 28, 2023

View reviewed changes

review fixes

0173472

nickldp requested a review from rustagir June 28, 2023 19:40

rustagir approved these changes Jun 28, 2023

View reviewed changes

final

7c177b8

nickldp merged commit 966fe9f into mongodb:master Jun 28, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-30756: add list search indexes to cursor page #704

DOCSP-30756: add list search indexes to cursor page #704

nickldp commented Jun 28, 2023 •

edited by rustagir

Loading

davidhou17 commented Jun 28, 2023

rustagir left a comment

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir left a comment

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

nickldp Jun 28, 2023

nickldp commented Jun 28, 2023 •

edited

Loading

rustagir left a comment

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

rustagir Jun 28, 2023

	When using a v7.0 and later {+mdb-server+} cluster, you can use the new `listSearchIndex()
	When connecting to {+mdb-server+} version 7.0 or later, you can use the new `listSearchIndex()

	return only the indexes with matching index names. It also has an
	return only the indexes with matching index names. It also takes an

	const cursor = myColl.listIndexSearch();
	const cursor = myColl.listSearchIndexes();

		The ``listIndexes()`` method allows you to list all the indexes'
		information in the collection. The ``listIndexes()`` method takes an

		optional parameter, `ListIndexesOptions
		<{+api+}/interfaces/ListIndexesOptions.html>`__, to set optional

	optional parameter, `ListIndexesOptions
	<{+api+}/interfaces/ListIndexesOptions.html>`__, to set optional
	optional `ListIndexesOptions <{+api+}/interfaces/ListIndexesOptions.html>`__ parameter to set optional

		The following example uses the ``listIndexes()`` method to list all the
		indexes' information in the collection.

		method to return a cursor that contains the search indexes for the current
		collection. The ``listSearchIndexes()`` method takes an optional string parameter, ``name``, to

		The following example uses the ``listIndexes()`` method to list all the
		indexes in a collection.

		The following example uses the ``listSearchIndexes()`` method to list all
		the search indexes in the collection.

	console.log("The indexes in the collection are: ");
	console.log("Existing indexes:\n");

DOCSP-30756: add list search indexes to cursor page #704

DOCSP-30756: add list search indexes to cursor page #704

Conversation

nickldp commented Jun 28, 2023 • edited by rustagir Loading

Pull Request Info

Self-Review Checklist

davidhou17 commented Jun 28, 2023

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickldp commented Jun 28, 2023 • edited Loading

rustagir left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nickldp commented Jun 28, 2023 •

edited by rustagir

Loading

nickldp commented Jun 28, 2023 •

edited

Loading