Skip to content

glossary edits #1593

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

glossary edits #1593

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions source/core/document.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ The :program:`mongo` JavaScript shell and the :doc:`MongoDB language
drivers </applications/drivers>` translate between BSON and the
language-specific document representation.

.. _document-structure:

Document Structure
------------------

Expand Down Expand Up @@ -128,6 +130,8 @@ Document Field Order
.. include:: /includes/fact-update-field-order.rst
:start-after: order-of-document-fields

.. _document-id-field:

The ``_id`` Field
-----------------

Expand Down
37 changes: 12 additions & 25 deletions source/reference/glossary.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
Glossary
========

.. NOTE: Several TODO's in this document.
.. Link to other glossary terms when possible.
Reserve the "See" text at the end of the entry to link to topics in the manual.

.. default-domain:: mongodb

Expand All @@ -15,17 +16,13 @@ Glossary
To use database commands, see :ref:`issue-commands`.

_id
A field required in every MongoDB :term:`document`. The ``_id``
field must have a unique value. You can
A field required in every MongoDB :term:`document`. The
:ref:`_id <document-id-field>` field must have a unique value. You can
think of the ``_id`` field as the document's :term:`primary key`.
If you create a new document without an ``_id`` field, MongoDB
automatically creates the field and assigns a unique
BSON :term:`ObjectId`.

.. TODO When the CRUD docs are migrated, add to the above entry a link
to the "The _id Field" section in /source/core/document.txt.
Also, add the link anchor to "The _id Field."

accumulator
An :term:`expression` in the :term:`aggregation framework` that
maintains state between documents in the aggregation
Expand Down Expand Up @@ -63,13 +60,12 @@ Glossary
:ref:`sharding-balancing`.

BSON
A serialization format used to store documents and make remote
procedure calls in MongoDB. "BSON" is a portmanteau of the words
A serialization format used to store :term:`documents <document>` and make
remote procedure calls in MongoDB. "BSON" is a portmanteau of the words
"binary" and "JSON". Think of BSON as a binary representation
of JSON (JavaScript Object Notation) documents.

.. seealso:: :doc:`/core/document`, :doc:`/reference/bson-types` and
:ref:`bson-json-type-conversion-fidelity`
of JSON (JavaScript Object Notation) documents. See
:doc:`/reference/bson-types` and
:ref:`bson-json-type-conversion-fidelity`.

BSON types
The set of types supported by the :term:`BSON` serialization
Expand Down Expand Up @@ -252,11 +248,7 @@ Glossary
field
A name-value pair in a :term:`document <document>`. A document has
zero or more fields. Fields are analogous to columns in relational
databases.

.. TODO When the CRUD docs are migrated, add to the above entry a link
to the "Document Structure" section in /source/core/document.txt.
Also, add the link anchor to "Document Structure."
databases. See :ref:`document-structure`.

firewall
A system level networking filter that restricts access based on,
Expand Down Expand Up @@ -289,10 +281,8 @@ Glossary
GridFS
A convention for storing large files in a MongoDB database. All of
the official MongoDB drivers support this convention, as does the
:program:`mongofiles` program. See :doc:`/core/gridfs`.

.. TODO When the CRUD docs are migrated, update the above link to:
See :doc:`/reference/gridfs`.
:program:`mongofiles` program. See :doc:`/core/gridfs` and
:doc:`/reference/gridfs`.

hashed shard key
A special type of :term:`shard key` that uses a hash of the value
Expand Down Expand Up @@ -559,9 +549,6 @@ Glossary
A series of operations in an :term:`aggregation` process.
See :doc:`/core/aggregation`.

.. TODO When the Aggregation docs are migrated, double-check the
accuracy of the above link.

Point
A single coordinate pair as described in the GeoJSON Point
specification: `<http://geojson.org/geojson-spec.html#point>`_. To
Expand Down