DOCSP-33429: atlas search idx mgmt #144

rustagir · 2024-01-12T18:40:04Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-33429
Staging:
https://preview-mongodbrustagir.gatsbyjs.io/kotlin/DOCSP-33429-atlas-search-idx-mgmt/fundamentals/indexes/#atlas-search-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?
Are the facets and meta keywords accurate?

mongoKart

awesome + clear work. a couple of very small issues and suggestions

mongoKart · 2024-01-12T18:47:20Z

source/fundamentals/indexes.txt


 Indexes support the efficient execution of queries in MongoDB. Without indexes, MongoDB must scan *every* document in a
 collection (a **collection scan**) to find the documents that match each query. These collection scans are slow and can
 negatively affect the performance of your application. If an appropriate index exists for a query, MongoDB can use the
-index to limit the number of documents it must inspect.
+index to limit the documents it must inspect.


S: clarity

Suggested change

index to limit the documents it must inspect.

index to limit the documents the query must inspect.

source/fundamentals/indexes.txt

mongoKart · 2024-01-12T18:52:55Z

source/fundamentals/indexes.txt

- Options that affect the query's execution (e.g. read concern)
- Projection criteria to specify the fields MongoDB should return (optional)
- Sort criteria to specify the order documents will be returned from MongoDB (optional)
+- Options that affect the query's execution, such as read concern


Suggested change

- Options that affect the query's execution, such as read concern

- Options that affect the query's execution, such as the read concern

mongoKart · 2024-01-12T18:54:27Z

source/fundamentals/indexes.txt

@@ -57,24 +67,26 @@ from the index, also called a **covered query**.

      name_1_age_-1

-   MongoDB would use this index when you sort your data by either:
+   MongoDB uses this index when you sort your data by either:


I: avoid fragments to introduce lists

S:

Suggested change

MongoDB uses this index when you sort your data by either:

MongoDB uses this index when you sort your data in one of the following ways:

mongoKart · 2024-01-12T19:08:05Z

source/fundamentals/indexes.txt

+To improve query performance, build indexes on fields that appear often in
+your application's queries and operations that return sorted results. Each
+index that you add consumes disk space and memory when active, so we recommend
+that you track index memory and disk usage for capacity planning. In addition,
+when a write operation updates an indexed field, MongoDB updates the related
+index.


S: i have trouble connecting the reasons and recommendations here. what about something like this:

Suggested change

To improve query performance, build indexes on fields that appear often in

your application's queries and operations that return sorted results. Each

index that you add consumes disk space and memory when active, so we recommend

that you track index memory and disk usage for capacity planning. In addition,

when a write operation updates an indexed field, MongoDB updates the related

index.

You can optimize your application's use of indexes by following these guidelines:

- Track index memory and disk usage for capacity planning. Each index that you add consumes disk space and memory when active.

- To improve query performance, build indexes on fields that appear often in

your application's queries and operations that return sorted results.

- Avoid adding indexes to rarely used fields. When a write operation updates an indexed field, MongoDB also updates the related index.

Edit as you like!

mongoKart · 2024-01-12T19:11:53Z

source/fundamentals/indexes.txt

+collections hosted on MongoDB Atlas. The indexes specify the behavior of
+the search and which fields to index.


I: This sentence doesn't make sense to me--how indexes specify which fields to index. Can you clarify?

mongoKart · 2024-01-12T19:13:12Z

source/fundamentals/indexes.txt

+
+.. note::
+
+   The Atlas Search Index management methods run asynchronously. The


S: Guessing "Atlas Search Index" isn't a proper noun phrase? Would lowercase + hyphenate the compound modifier

Suggested change

The Atlas Search Index management methods run asynchronously. The

The Atlas Search index-management methods run asynchronously. The

mongoKart · 2024-01-12T19:17:19Z

source/fundamentals/indexes.txt

+You can use the `createSearchIndex() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-search-index.html>`__
+and the
+`createSearchIndexes() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-search-indexes.html>`__


S: ditch the first "the" if you're using "method" just once

Suggested change

You can use the `createSearchIndex() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-search-index.html>`__

and the

`createSearchIndexes() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-search-indexes.html>`__

You can use the `createSearchIndex() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-search-index.html>`__

and

`createSearchIndexes() <{+api+}/apidocs/mongodb-driver-kotlin-coroutine/mongodb-driver-kotlin-coroutine/com.mongodb.kotlin.client.coroutine/-mongo-collection/create-search-indexes.html>`__

mongoKart · 2024-01-12T19:18:19Z

source/fundamentals/indexes.txt

+method to return the Atlas Search indexes of a collection.
+
+The following code example shows how to print a list of the search indexes of
+a collection:


S: "indexes of a collection" vs. "indexes for a collection"?

mentioning here, but i trust your judgment!

mongoKart · 2024-01-12T19:19:33Z

source/fundamentals/indexes.txt

-in the preceding code snippet:
+.. important::
+
+   Attempting to create a geospatial index on a field that is covered by a geospatial index results in an error.


S: Clearer to include "already"? I assume that's what this means

Suggested change

Attempting to create a geospatial index on a field that is covered by a geospatial index results in an error.

Attempting to create a geospatial index on a field that is already covered by a geospatial index results in an error.

mongoKart

lookin real good. couple small suggestions but LGTM

mongoKart · 2024-01-16T18:10:46Z

source/fundamentals/indexes.txt

+The following guidelines describe how you can optimize the way
+application uses indexes:


Suggested change

The following guidelines describe how you can optimize the way

application uses indexes:

The following guidelines describe how you can optimize the way

your application uses indexes:

mongoKart · 2024-01-16T18:13:21Z

source/fundamentals/indexes.txt

+   <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Indexes.html>`__
+   class to create and manage indexes. This class includes static
+   factory methods to create index specification documents for different
+   MongoDB Index key types.


Q: lower case?

Suggested change

MongoDB Index key types.

MongoDB index key types.

mongoKart · 2024-01-16T18:16:45Z

source/fundamentals/indexes.txt

+The following code example shows how to print a list of the search indexes of
+a collection:


Based on your comment, I thought you were changing from "of" to "on" (just making sure you didn't intend to make this change)

AH, changed in one place but not the other.

mongoKart · 2024-01-16T18:17:29Z

source/fundamentals/indexes.txt

-type, see the MongoDB server manual page on :manual:`GeoJSON objects </reference/geojson>`.
+To create a ``2dsphere`` index, you must specify a field that contains
+only **GeoJSON objects**. To learn more about this
+type, see the :manual:`GeoJSON objects reference </reference/geojson>`


Suggested change

type, see the :manual:`GeoJSON objects reference </reference/geojson>`

type, see :manual:`GeoJSON objects</reference/geojson>`

docs-builder-bot · 2024-01-16T18:37:27Z

✨ Staging URL: https://preview-mongodbmongodb.gatsbyjs.io/kotlin/master/

🪵 Logs

job log: 1784061e5a90eecd89f1380b070a012d739ef875

* DOCSP-33429: (wip) atlas search idx mgmt * DOCSP-33429: atlas search idx mgmt * fixes * MW PR fixes 1 * MW PR Small fixes (cherry picked from commit 1784061)

* DOCSP-33429: (wip) atlas search idx mgmt * DOCSP-33429: atlas search idx mgmt * fixes * MW PR fixes 1 * MW PR Small fixes

rustagir added 3 commits January 11, 2024 08:55

DOCSP-33429: (wip) atlas search idx mgmt

f474093

DOCSP-33429: atlas search idx mgmt

fba8137

fixes

4ab8842

mongoKart requested changes Jan 12, 2024

View reviewed changes

MW PR fixes 1

4e448c0

rustagir requested a review from mongoKart January 16, 2024 15:44

mongoKart approved these changes Jan 16, 2024

View reviewed changes

MW PR Small fixes

e2f402c

rustagir merged commit 1784061 into mongodb:master Jan 16, 2024
5 checks passed

rustagir added a commit that referenced this pull request Jan 16, 2024

DOCSP-33429: atlas search idx mgmt (#144)

969d2bc

* DOCSP-33429: (wip) atlas search idx mgmt * DOCSP-33429: atlas search idx mgmt * fixes * MW PR fixes 1 * MW PR Small fixes (cherry picked from commit 1784061)

ccho-mongodb pushed a commit to ccho-mongodb/docs-kotlin that referenced this pull request Feb 14, 2024

DOCSP-33429: atlas search idx mgmt (mongodb#144)

bfc5575

* DOCSP-33429: (wip) atlas search idx mgmt * DOCSP-33429: atlas search idx mgmt * fixes * MW PR fixes 1 * MW PR Small fixes

ccho-mongodb pushed a commit to ccho-mongodb/docs-kotlin that referenced this pull request Feb 14, 2024

DOCSP-33429: atlas search idx mgmt (mongodb#144)

2c3a153

* DOCSP-33429: (wip) atlas search idx mgmt * DOCSP-33429: atlas search idx mgmt * fixes * MW PR fixes 1 * MW PR Small fixes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOCSP-33429: atlas search idx mgmt #144

DOCSP-33429: atlas search idx mgmt #144

rustagir commented Jan 12, 2024

mongoKart left a comment

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

mongoKart Jan 12, 2024

rustagir Jan 16, 2024

mongoKart Jan 12, 2024

mongoKart left a comment

mongoKart Jan 16, 2024

mongoKart Jan 16, 2024

mongoKart Jan 16, 2024

rustagir Jan 16, 2024 •

edited

Loading

mongoKart Jan 16, 2024

docs-builder-bot commented Jan 16, 2024

	index to limit the documents it must inspect.
	index to limit the documents the query must inspect.

	- Options that affect the query's execution, such as read concern
	- Options that affect the query's execution, such as the read concern

	MongoDB uses this index when you sort your data by either:
	MongoDB uses this index when you sort your data in one of the following ways:

		collections hosted on MongoDB Atlas. The indexes specify the behavior of
		the search and which fields to index.


		.. note::

		The Atlas Search Index management methods run asynchronously. The

	The Atlas Search Index management methods run asynchronously. The
	The Atlas Search index-management methods run asynchronously. The

	Attempting to create a geospatial index on a field that is covered by a geospatial index results in an error.
	Attempting to create a geospatial index on a field that is already covered by a geospatial index results in an error.

		The following guidelines describe how you can optimize the way
		application uses indexes:

		The following code example shows how to print a list of the search indexes of
		a collection:

	type, see the :manual:`GeoJSON objects reference </reference/geojson>`
	type, see :manual:`GeoJSON objects</reference/geojson>`

DOCSP-33429: atlas search idx mgmt #144

DOCSP-33429: atlas search idx mgmt #144

Conversation

rustagir commented Jan 12, 2024

Pull Request Info

Self-Review Checklist

mongoKart 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

mongoKart 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

rustagir Jan 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

docs-builder-bot commented Jan 16, 2024

🪵 Logs

rustagir Jan 16, 2024 •

edited

Loading