From 0808be90f2b58ffc44d39e80d557b8ff28d48e77 Mon Sep 17 00:00:00 2001 From: Bob Grabar Date: Fri, 26 Jul 2013 14:33:32 -0400 Subject: [PATCH] DOCS-1723 glossary edits - part 2 --- source/core/indexes.txt | 2 + source/core/security.txt | 2 + source/core/sharded-cluster-shards.txt | 2 + source/core/sharding-introduction.txt | 2 + source/reference/glossary.txt | 347 +++++++++++------------- source/reference/program/mongo.txt | 5 +- source/reference/program/mongosniff.txt | 2 + source/reference/ulimit.txt | 2 + 8 files changed, 173 insertions(+), 191 deletions(-) diff --git a/source/core/indexes.txt b/source/core/indexes.txt index 0132b8fc74f..ea3702547c7 100644 --- a/source/core/indexes.txt +++ b/source/core/indexes.txt @@ -133,6 +133,8 @@ suitable for use as the value of an ``_id`` field. note: The capped-collection page is now created and in the draft folder. +.. _secondary-index: + Secondary Indexes ~~~~~~~~~~~~~~~~~ diff --git a/source/core/security.txt b/source/core/security.txt index 98c184f70e3..1da7e4de9f8 100644 --- a/source/core/security.txt +++ b/source/core/security.txt @@ -296,6 +296,8 @@ represent an exposure. To disable the HTTP interface, set the :option:`--nohttpinterface ` command line option. +.. _rest-api: + REST API ~~~~~~~~ diff --git a/source/core/sharded-cluster-shards.txt b/source/core/sharded-cluster-shards.txt index 4bf7544ed54..6ac538ae8ec 100644 --- a/source/core/sharded-cluster-shards.txt +++ b/source/core/sharded-cluster-shards.txt @@ -21,6 +21,8 @@ redundancy and high availability for the data in each shard. not guarantee that any two contiguous chunks will reside on a single shard. +.. _primary-shard: + Primary Shard ------------- diff --git a/source/core/sharding-introduction.txt b/source/core/sharding-introduction.txt index c79dff80de3..f86368f2e03 100644 --- a/source/core/sharding-introduction.txt +++ b/source/core/sharding-introduction.txt @@ -86,6 +86,8 @@ clusters have *exactly* 3 config servers. replica set. Do **not** deploy production clusters without 3 config servers. +.. _sharding-data-partitioning: + Data Partitioning ----------------- diff --git a/source/reference/glossary.txt b/source/reference/glossary.txt index 191a530ab80..e7faff3c728 100644 --- a/source/reference/glossary.txt +++ b/source/reference/glossary.txt @@ -22,9 +22,9 @@ Glossary 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." + .. 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 @@ -75,8 +75,8 @@ Glossary The set of types supported by the :term:`BSON` serialization format. - .. TODO When the CRUD docs are migrated, remove the table below and - provide a link to /reference/bson-types. + .. TODO When the CRUD docs are migrated, remove the table below and + provide a link to /reference/bson-types. ======================= ========== **Type** **Number** @@ -153,7 +153,7 @@ Glossary metadata associated with a :term:`sharded cluster`. Applications and administrators should not modify the ``config`` dtabase in the course of normal operation. See - :doc:`/reference/config-database` + :doc:`/reference/config-database`. config server A :program:`mongod` instance that stores all the metadata @@ -168,8 +168,7 @@ Glossary CRUD An acronym for the fundamental operations of a database: Create, - Read, Update, and Delete. See - :doc:`/crud`. + Read, Update, and Delete. See :doc:`/crud`. CSV A text-based data format consisting of comma-separated values. @@ -242,9 +241,9 @@ Glossary :term:`BSON`. See :doc:`/core/document`. dot notation - .. include:: /includes/fact-dot-notation.rst - - See :ref:`document-dot-notation`. + MongoDB uses the dot notation to access the elements of an array + and to access the fields of a subdocument. See + :ref:`document-dot-notation`. draining The process of removing or "shedding" :term:`chunks ` from @@ -285,9 +284,9 @@ Glossary 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." + .. 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." firewall A system level networking filter that restricts access based on, @@ -322,8 +321,8 @@ Glossary 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`. + .. TODO When the CRUD docs are migrated, update the above link to: + See :doc:`/reference/gridfs`. hashed shard key A special type of :term:`shard key` that uses a hash of the value @@ -431,14 +430,14 @@ Glossary phase that selects data and a "reduce" phase that transforms the data. In MongoDB, you can run arbitrary aggregations over data using map-reduce. For map-reduce implementation, see - :doc:`/core/map-reduce`. For another approach to data aggregation, + :doc:`/core/map-reduce`. For all approaches to aggregation, see :doc:`/core/aggregation`. master The database that receives all writes in a conventional master-:term:`slave` replication. In MongoDB, :term:`replica sets ` replace master-slave replication for most use - cases. However, for information on master-slave replication, see + cases. For more information on master-slave replication, see :doc:`/core/master-slave`. md5 @@ -455,88 +454,80 @@ Glossary type to describe a file inserted into :term:`GridFS` storage. mongo - The MongoDB Shell. :program:`mongo` connects to :program:`mongod` - and :program:`mongos` instances, allowing administration, - management, and testing. :program:`mongo` has a JavaScript - interface. See :doc:`/reference/program/mongo` and - :doc:`/reference/method`. + The MongoDB shell. The :program:`mongo` process starts the MongoDB + shell as a daemon connected to either a :program:`mongod` or + :program:`mongos` instance. The shell has a JavaScript interface. + See :doc:`/reference/program/mongo` and :doc:`/reference/method`. mongod - The program implementing the MongoDB database server. This server - typically runs as a :term:`daemon`. See + The MongoDB database server. The :program:`mongod` process starts + the MongoDB server as a daemon. The MongoDB server manages data + requests and formats and manages background operations. See :doc:`/reference/program/mongod`. MongoDB - The document-based database server described in this manual. + An open-source document-based database system. "MongoDB" derives + from the word "humongous" because of the database's ability to + scale up with ease and hold very large amounts of data. MongoDB + stores :term:`documents ` in :term:`collections + ` within databases. mongos The routing and load balancing process that acts an interface between an application and a MongoDB :term:`sharded cluster`. See :doc:`/reference/program/mongos`. - multi-master replication - A :term:`replication` method where multiple database instances - can accept write operations to the same data set at any - time. Multi-master replication exchanges increased concurrency and - availability for a relaxed consistency semantic. MongoDB ensures - consistency and, therefore, does not provide multi-master replication. - namespace The canonical name for a collection or index in MongoDB. The namespace is a combination of the database name and the name of the collection or index, like so: ``[database-name].[collection-or-index-name]``. All documents - belong to a namespace. + belong to a namespace. See :ref:`faq-dev-namespace`. natural order - The order in which a database stores documents on - disk. Typically, the order of documents on disks reflects - insertion order, *except* when documents move internally because - of document growth due to update operations. However, - :term:`Capped collections ` guarantee that - insertion order and natural order are identical. + The order in which a database stores documents on disk. Typically, + the order of documents on disks reflects insertion order, except + when a document moves internally because an update operation + increases its size. :term:`Capped collections `, however, guarantee that insertion order and natural + order are identical. When you execute :method:`find() ` with no parameters, the database returns documents in forward natural order. When you execute :method:`find() ` and include :method:`sort() ` with a parameter of ``$natural:-1``, the database returns documents in reverse natural - order. + order. See :operator:`$natural`. ObjectId A special 12-byte :term:`BSON` type that guarantees uniqueness - within the collection. The ObjectID is generated based on + within the :term:`collection`. The ObjectID is generated based on timestamp, machine ID, process ID, and a process-local incremental counter. MongoDB uses ObjectId values as the default values for :term:`_id` fields. operator - A keyword beginning with a ``$`` used to express a complex - query, update, or data transformation. For example, ``$gt`` - is the query language's "greater than" operator. - - For more information about the available operators, see - :doc:`/reference/operator`. + A keyword beginning with a ``$`` used to express an update, + complex query, or data transformation. For example, ``$gt`` is the + query language's "greater than" operator. For available operators, + see :doc:`/reference/operator`. oplog A :term:`capped collection` that stores an ordered history of logical writes to a MongoDB database. The oplog is the basic mechanism enabling :term:`replication` in MongoDB. - - See :ref:`Oplog Sizes ` and - :doc:`/tutorial/change-oplog-size`. + See :doc:`/core/replica-set-oplog`. ordered query plan - Query plan that returns results in the order consistent with the - :method:`~cursor.sort()` order. - - See :ref:`read-operations-query-optimization`. + A query plan that returns results in the order consistent with the + :method:`~cursor.sort()` order. See + :ref:`read-operations-query-optimization`. padding The extra space allocated to document on the disk to prevent moving a document when it grows as the result of :method:`update() ` - operations. + operations. See :ref:`write-operations-padding-factor`. padding factor An automatically-calibrated constant used to determine how much @@ -544,143 +535,139 @@ Glossary A padding factor of 1 means that MongoDB will allocate only the amount of space needed for the document. A padding factor of 2 means that MongoDB will allocate twice the amount of space - required by the document. + required by the document. See + :ref:`write-operations-padding-factor`. page fault The event that occurs when a process requests stored data (i.e. a page) from memory that the operating system has moved to - disk. - - See :ref:`Storage FAQ: What are page faults? - `. + disk. See :ref:`faq-storage-page-faults`. partition A distributed system architecture that splits data into ranges. - :term:`Sharding` is a kind of partitioning. + :term:`Sharding` uses partitioning. See + :ref:`sharding-data-partitioning`. passive member A member of a :term:`replica set` that cannot become primary - because its :data:`~local.system.replset.members[n].priority` is ``0``. + because its :data:`~local.system.replset.members[n].priority` is + ``0``. See :doc:`/core/replica-set-priority-0-member`. pcap - A packet capture format used by :program:`mongosniff` to record + A packet-capture format used by :program:`mongosniff` to record packets captured from network interfaces and display them as - human-readable MongoDB operations. + human-readable MongoDB operations. See :ref:`mongosniff-options`. PID - A process identifier. On UNIX-like systems, a unique integer PID is assigned to - each running process. You can use a PID to inspect - a running process and send signals to it. + A process identifier. UNIX-like systems assign a unique-integer + PID to each running process. You can use a PID to inspect a + running process and send signals to it. See + :ref:`proc-file-system`. pipe - A communication channel in UNIX-like systems allowing independent processes - to send and receive data. In the UNIX shell, piped operations - allow users to direct the output of one command into the input - of another. + A communication channel in UNIX-like systems allowing independent + processes to send and receive data. In the UNIX shell, piped + operations allow users to direct the output of one command into + the input of another. pipeline - The series of operations in the :term:`aggregation` process. - + 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 point is a single coordinate pair, or "position," as described - in `the GeoJSON Point specification - `_. To use a Point in - MongoDB, see :ref:`geospatial-indexes-store-geojson`. + A single coordinate pair as described in `the GeoJSON Point + specification `_. To + use a Point in MongoDB, see + :ref:`geospatial-indexes-store-geojson`. Polygon - A Polygon is defined by an array of :term:`LinearRing - ` coordinate arrays, as described in `the GeoJSON - Polygon specification + An array of :term:`LinearRing ` coordinate arrays, as + described in `the GeoJSON Polygon specification `_. For Polygons - with multiple rings, the first **must** be the exterior ring and + with multiple rings, the first must be the exterior ring and any others must be interior rings or holes. - MongoDB does not permit the exterior ring to self-intersect, and - interior rings must be fully contained within the outer loop and + MongoDB does not permit the exterior ring to self-intersect. + Interior rings must be fully contained within the outer loop and cannot intersect or overlap with each other. See :ref:`geospatial-indexes-store-geojson`. powerOf2Sizes - A per-:term:`collection` setting that changes and normalizes the - way that MongoDB allocates space for each :term:`document` in an - effort to maximize storage reuse reduce fragmentation. This is - the default for :doc:`TTL Collections `. - - See :dbcommand:`collMod` and :collflag:`usePowerOf2Sizes`. - - .. versionadded:: 2.2 + A per-collection setting that changes and normalizes the way + MongoDB allocates space for each :term:`document`, in an effort to + maximize storage reuse and to reduce fragmentation. This is the + default for :doc:`TTL Collections `. See + :doc:`/reference/command/collMod` and + :collflag:`usePowerOf2Sizes`. pre-splitting - An operation, performed before inserting data that divides the - range of possible shard key values into chunks to facilitate - easy insertion and high write throughput. When deploying a - :term:`sharded cluster`, in some cases pre-splitting will expedite - the initial distribution of documents among shards by manually - dividing the collection into chunks rather than waiting for the - MongoDB :term:`balancer` to create chunks during the course of - normal operation. + An operation performed before inserting data that divides the + range of possible shard key values into chunks to facilitate easy + insertion and high write throughput. In some cases pre-splitting + expedites the initial distribution of documents in :term:`sharded + cluster` by manually dividing the collection rather than waiting + for the MongoDB :term:`balancer` to do so. See + ;ref:`sharding-administration-pre-splitting`. primary In a :term:`replica set`, the primary member is the current :term:`master` instance, which receives all write operations. + See :ref:`replica-set-primary-member`. primary key - A record's unique, immutable identifier. In an :term:`RDBMS`, the primary + A record's unique immutable identifier. In an :term:`RDBMS`, the primary key is typically an integer stored in each row's ``id`` field. In MongoDB, the :term:`_id` field holds a document's primary key which is usually a BSON :term:`ObjectId`. primary shard - For a database where :term:`sharding` is enabled, the primary - shard holds all un-sharded collections. + The :term:`shard` that holds all the un-sharded collections. See + :ref:`primary-shard`. priority - In the context of :term:`replica sets `, priority - is a configurable value that helps determine which members in - a replica set are most likely to become :term:`primary`. - + A configurable value that helps determine which members in + a :term:`replica set` are most likely to become :term:`primary`. See :data:`~local.system.replset.members[n].priority`. projection A document given to a :term:`query` that specifies which fields - MongoDB will return from the documents in the result set. - - For a list of special projection operators, see + MongoDB returns in the result set. See :ref:`projection`. For a + list of projection operators, see :doc:`/reference/operator/projection`. query - A read request. MongoDB queries use a :term:`JSON`-like query - language that includes a variety of :term:`query operators ` - with names that begin with a ``$`` character. In the - :program:`mongo` shell, you can issue queries using the + A read request. MongoDB uses a :term:`JSON`-like query language + that includes a variety of :term:`query operators ` with + names that begin with a ``$`` character. In the :program:`mongo` + shell, you can issue queries using the :method:`db.collection.find()` and - :method:`db.collection.findOne()` methods. + :method:`db.collection.findOne()` methods. See + :ref:`read-operations-queries`. query optimizer - For each query, the MongoDB query optimizer generates a query plan - that matches the query to the index that produces the fastest - results. The optimizer then uses the query plan each time the - :program:`mongod` receives the query. If a collection changes - significantly, the optimizer creates a new query plan. - - See :ref:`read-operations-query-optimization`. + A process that generates query plans. For each query, the + optimizer generates a plan that matches the query to the index + that produces the fastest results. The optimizer reuses the query + plan each time the query runs. If a collection changes + significantly, the optimizer creates a new query plan. See + :ref:`read-operations-query-optimization`. read preference - A setting on the MongoDB :doc:`drivers ` - that determines how the clients direct read - operations. Read preference affects all replica sets including - shards. By default, drivers direct all reads to :term:`primaries ` - for :term:`strict consistency`. However, you may also - direct reads to secondaries for :term:`eventually consistent - ` reads. - - See :doc:`Read Preference `. + A setting that determines how clients direct read operations. Read + preference affects all replica sets, including shards. By default, + MongoDB directs reads to :term:`primaries ` for + :term:`strict consistency`. However, you may also direct reads to + secondaries for :term:`eventually consistent ` reads. See :doc:`Read Preference + `. read-lock - In the context of a reader-writer lock, a lock that while - held allows concurrent readers, but no writers. + In the context of a reader-writer lock, a lock that while held + allows concurrent readers but no writers. See + :ref:`faq-concurrency-locking`. RDBMS Relational Database Management System. A database management @@ -688,7 +675,9 @@ Glossary :term:`SQL` as the query language. record size - The space allocated for a document including the padding. + The space allocated for a document including the padding. For more + information on padding, see :ref:`write-operations-padding-factor` + and :doc:`/reference/command/compact`. recovering A :term:`replica set` member status indicating that a member @@ -703,25 +692,19 @@ Glossary replica set A cluster of MongoDB servers that implements master-slave replication and automated failover. MongoDB's recommended - replication strategy. - - See :doc:`/replication`. + replication strategy. See :doc:`/replication`. replication A feature allowing multiple database servers to share the same data, thereby ensuring redundancy and facilitating load balancing. - MongoDB supports two flavors of replication: master-slave replication - and replica sets. - - See :term:`replica set`, :term:`sharding`, :doc:`/replication`. + See :doc:`/replication`. replication lag - The length of time between the last operation in the primary's - :term:`oplog` last operation applied to a particular - :term:`secondary` or :term:`slave`. In general, you want - to keep replication lag as small as possible. - - See :ref:`Replication Lag `. + The length of time between the last operation in the + :term:`primary's ` :term:`oplog` and the last operation + applied to a particular :term:`secondary`. In general, you want to + keep replication lag as small as possible. See :ref:`Replication + Lag `. resident memory The subset of an application's memory currently stored in @@ -729,67 +712,59 @@ Glossary which includes memory mapped to physical RAM and to disk. REST - An API design pattern centered around the idea of - resources and the :term:`CRUD` operations that apply to them. Typically - implemented over HTTP. MongoDB provides a simple HTTP REST interface - that allows HTTP clients to run commands against the server. + An API design pattern centered around the idea of resources and the + :term:`CRUD` operations that apply to them. Typically REST is + implemented over HTTP. MongoDB provides a simple HTTP REST + interface that allows HTTP clients to run commands against the + server. See :ref:`rest-interface` and :ref:`rest-api`. rollback - A process that, in certain replica set situations, reverts - writes operations to ensure the consistency of all replica set - members. + A process that reverts writes operations to ensure the consistency + of all replica set members. See :ref:`replica-set-rollback`. secondary - In a :term:`replica set`, the ``secondary`` members are the current - :term:`slave` instances that replicate the contents of the - master database. Secondary members may handle read requests, but only the - :term:`primary` members can handle write operations. + A :term:`replica set` member that replicates the contents of the + master database. Secondary members may handle read requests, but + only the :term:`primary` members can handle write operations. See + :ref:`replica-set-secondary-members`. secondary index A database :term:`index` that improves query performance by minimizing the amount of work that the query engine must perform - to fulfill a query. + to fulfill a query. See :ref:`secondary-index`. set name - In the context of a :term:`replica set`, the ``set name`` refers to - an arbitrary name given to a replica set when it's first configured. - All members of a replica set must have the same name specified - with the :setting:`replSet` setting (or :option:`--replSet - ` option for :program:`mongod`.) - - See :term:`replication`, :doc:`/replication`. + The arbitrary name given to a replica set. All members of a + replica set must have the same name specified with the + :setting:`replSet` setting or the :option:`--replSet ` option. shard - A single :program:`mongod` instance or a :term:`replica set` - that stores some portion of a sharded cluster's - total data set. In production, all shards should be replica sets. - - See :doc:`/sharding`. + A single :program:`mongod` instance or :term:`replica set` that + stores some portion of a :term:`sharded cluster's ` total data set. In production, all shards should be + replica sets. See :doc:`/core/sharded-cluster-shards`. shard key - In a sharded collection, a shard key is the field that MongoDB - uses to distribute documents among members of the + The field MongoDB uses to distribute documents among members of a :term:`sharded cluster`. See :ref:`shard-key`. sharded cluster - The set of nodes comprising a :term:`sharded ` MongoDB deployment. A sharded cluster - consists of three config processes, one or more replica sets, and one or more - :program:`mongos` routing processes. - - See :doc:`/sharding`. + The set of nodes comprising a :term:`sharded ` MongoDB + deployment. A sharded cluster consists of three config processes, + one or more replica sets, and one or more :program:`mongos` + routing processes. See :doc:`/core/sharded-cluster-components`. sharding - A database architecture that enable horizontal scaling by splitting - data into key ranges among two or more replica sets. This architecture - is also known as "range-based partitioning." See :term:`shard`. - - See :doc:`/sharding`. + A database architecture that enables horizontal scaling by + splitting data into key ranges among two or more replica sets. + This architecture is also known as "range-based partitioning." See + :doc:`/sharding`. shell helper A number of :doc:`database commands ` have "helper" methods in the ``mongo`` shell that provide a more concise syntax and improve the general interactive experience. - See :doc:`/reference/program/mongo` and :doc:`/reference/method`. single-master replication @@ -842,7 +817,7 @@ Glossary sync The :term:`replica set` operation where members replicate data - from the :term:`primary`. Replica sets synchronize data at two + from the :term:`primary`. Replica sets synchronize data at two different points: - :term:`Initial sync` occurs when MongoDB creates new databases on a @@ -880,7 +855,6 @@ Glossary unordered query plan Query plan that returns results in an order inconsistent with the :method:`~cursor.sort()` order. - See :ref:`read-operations-query-optimization`. upsert @@ -909,7 +883,6 @@ Glossary :program:`mongod` instances. For :term:`replica sets `, you can configure write concern to confirm replication to a specified number of members. - See :ref:`Write Concern `, :doc:`/core/write-operations`, and :doc:`Write Concern for Replica Sets `. diff --git a/source/reference/program/mongo.txt b/source/reference/program/mongo.txt index a7d37f77e93..a2d77d98b1e 100644 --- a/source/reference/program/mongo.txt +++ b/source/reference/program/mongo.txt @@ -29,10 +29,7 @@ and an overview of its usage. .. only:: (not man) - .. seealso:: - - In addition to this page, consider :doc:`/mongo` section of - the manual. + .. seealso:: :doc:`/mongo` Interface --------- diff --git a/source/reference/program/mongosniff.txt b/source/reference/program/mongosniff.txt index 30b1f390ee1..cefe2f1b025 100644 --- a/source/reference/program/mongosniff.txt +++ b/source/reference/program/mongosniff.txt @@ -37,6 +37,8 @@ As an alternative to :program:`mongosniff`, Wireshark, a popular network sniffing tool is capable of inspecting and parsing the MongoDB wire protocol. +.. _mongosniff-options: + Options ------- diff --git a/source/reference/ulimit.txt b/source/reference/ulimit.txt index cc4038954ae..9d0ade864a8 100644 --- a/source/reference/ulimit.txt +++ b/source/reference/ulimit.txt @@ -134,6 +134,8 @@ system limits on running systems. system a system restart. Check your distribution and operating system documentation for more information. +.. _proc-file-system: + ``/proc`` File System ~~~~~~~~~~~~~~~~~~~~~