[SERVER-84935] Review MongoDB Manual Page /manual/core/index-types/ Created: 31/Jan/14  Updated: 12/Jan/24  Resolved: 10/Mar/14

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Kay Kim (Inactive) Assignee: David Storch
Resolution: Done Votes: 0
Labels: audit-2014, audit-content, audit-nav
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:

 Description   

Hello,

To ensure that the documentation remains accurate and up to date, we're asking a group of engineers and solutions architects to review content from the MongoDB Manual to ensure that the content is accurate, addresses the core consideration of potential users, and presents sensible recommendations.

This issue addresses the single page:

http://docs.mongodb.org/manual/core/index-types/

As you review the documentation, consider four major dimensions:

1. The correctness and completeness of the content.

2. The utility of the content for new users of MongoDB.

3. The utility of the content for expert users of MongoDB.

4. The organization of the page and its focus on the important aspects of the content.

When you complete your review of the page please fill out the documentation audit survey.

If you have additional questions or would like to make additional changes, please create a DOCS ticket or leave a comment on this ticket.

Thank you for your time and effort, and for your help in improving the documentation.

Regards,

the docs team



 Comments   
Comment by David Storch [ 25/Feb/14 ]

samk, not sure why this ticket is reassigned to me. Has it been updated yet per my comments from the initial audit?

Comment by David Storch [ 31/Jan/14 ]

See below for my comments on the page:

Nevertheless, MongoDB may also traverse the index in either directions.

Change to "Nevertheless, MongoDB may traverse the index in either direction."

A single query can only use one index, except for queries that use the $or operator that can use a different index for each clause.

It is still true that $or queries can use a different index for each clause. However, in general multiple indices can now be used due to index intersection being enabled in 2.5.5. The current implementation of index intersection allows a given query to use at most two indices. For the query {a: "x", b: "y"}, the query optimizer might choose a query plan that uses both indices {a: 1} and {b: 1}.

A multikey index references an array and records a match if a query includes any value in the array.

This seems a bit unclear to me. An alternative suggestion: "It is possible to build an index over a field that contains one or more arrays as values. In this case, the index is called 'multikey' because an index key will be generated for each value of the array. For example, if we index field 'x' then inserting a document {x: [1, 2, 3]} will cause three entries to be added to the index."

Hashed indexes maintain entries with hashes of the values of the indexed field.

Can we add, "They are used primarily in sharded clusters to support hashed shard keys."

Generated at Thu Feb 08 06:56:23 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.