Skip to content

Commit c023930

Browse files
author
Sam Kleinman
committed
DOCS-391: fixing errors and tweaks
1 parent a66a3e2 commit c023930

File tree

3 files changed

+20
-24
lines changed

3 files changed

+20
-24
lines changed

source/core/indexes.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,8 @@ indexes:
3232
- When the index covers queries, the database returns results more
3333
quickly than queries that have to scan many individual documents. An
3434
index "covers" a query if the keys of the index stores all the data
35-
that the query must return.
35+
that the query must return. See :ref:`indexes-covered-queries` for
36+
more information.
3637

3738
- Using queries with good index coverage will reduce the number of full
3839
documents that MongoDB needs to store in memory, thus maximizing database
@@ -60,7 +61,7 @@ introduction to their use.
6061
.. index:: _id index
6162
.. index:: _id
6263
.. index:: index; _id
63-
.. index:: index types; primary
64+
.. index:: index types; primary key
6465
.. _index-type-primary:
6566

6667
_id
@@ -103,7 +104,7 @@ is a 12-byte unique identifiers suitable for use as the value of an
103104
Secondary Indexes
104105
~~~~~~~~~~~~~~~~~
105106

106-
All indexes other than the index on the ``_id`` field are
107+
All indexes in MongoDB are
107108
:term:`secondary indexes <secondary index>`. You can create indexes on
108109
any field within any document or sub-document. Additionally, you can
109110
create compound indexes with multiple fields, so that a single query

source/reference/glossary.txt

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -271,22 +271,17 @@ Glossary
271271
prevent other processes from writing or reading.
272272

273273
index
274-
A data structure that optimizes queries.
275-
276-
.. seealso:: The :wiki:`Indexes` wiki page.
277-
278-
.. STUB :doc:`/core/indexing`
274+
A data structure that optimizes queries. See
275+
:doc:`/core/indexes` for more information.
279276

280277
secondary index
281-
An index on any field that isn't the "primary key" for a
282-
collection. In MongoDB the "primary key" is the ``_id`` field.
278+
A database :term:`index` that improves query performance by
279+
minimizing the amount of work that the query engine must perform
280+
to fulfill a query.
283281

284282
compound index
285-
An :term:`index` consisting of two or more keys.
286-
287-
.. seealso:: The :wiki:`Indexes` wiki page.
288-
289-
.. STUB :doc:`/core/indexing`
283+
An :term:`index` consisting of two or more keys. See
284+
:doc:`/core/indexes` for more information.
290285

291286
btree
292287
A data structure used by most database management systems

source/release-notes/1.8.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -238,15 +238,15 @@ aggregation
238238
Sparse and Covered Indexes
239239
~~~~~~~~~~~~~~~~~~~~~~~~~~
240240

241-
:ref:`Sparse Indexes <sparse-index>` are indexes that only include
241+
:ref:`Sparse Indexes <index-type-sparse>` are indexes that only include
242242
documents that contain the fields specified in the index. Documents
243243
missing the field will not appear in the index at all. This can
244-
significantly reduce index size for attributes that are contained in a
244+
significantly reduce index size for indexes of fields that contain only a
245245
subset of documents within a :term:`collection`.
246246

247-
:ref:`Covered Indexes <use-covered-queries>` enable queries to be
248-
answered entirely from the index when the query only requests fields
249-
that are contained in the index.
247+
:ref:`Covered Indexes <covered-queries>` enable MongoDB to answer
248+
queries entirely from the index when the query only selects fields
249+
that the index contains.
250250

251251
Incremental MapReduce Support
252252
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -318,14 +318,14 @@ Additional Changes and Enhancements
318318
- :program:`mongos` routes ``slaveOk`` queries to :term:`secondaries
319319
<secondary>` in :term:`replica sets <replica set>`.
320320

321-
- New :dbcommand:`mapReduce` output options
321+
- New :dbcommand:`mapReduce` output options.
322322

323-
- :ref:`sparse-index`.
323+
- :ref:`index-type-sparse`.
324324

325325
1.7.3
326326
`````
327327

328-
- Initial :ref:`covered index <use-covered-queries>` support
328+
- Initial :ref:`covered index <covered-queries>` support.
329329

330330
- Distinct can use data from indexes when possible.
331331

@@ -338,7 +338,7 @@ Additional Changes and Enhancements
338338
1.7.2
339339
`````
340340

341-
- :operator:`$rename` operator allows renaming of attributes in a document.
341+
- :operator:`$rename` operator allows renaming of fields in a document.
342342

343343
- :method:`db.eval()` not to block.
344344

0 commit comments

Comments
 (0)