From 4d7b52f670dd7828b429ed8117e76b437c64b2cf Mon Sep 17 00:00:00 2001 From: Bob Grabar Date: Thu, 20 Mar 2014 14:30:19 -0400 Subject: [PATCH] DOCS-2736 parallelCollectionScan command --- source/includes/ref-toc-command-crud.yaml | 4 +++ .../command/parallelCollectionScan-field.yaml | 24 ++++++++++++++++ .../command/parallelCollectionScan.txt | 28 +++++++++++++++++++ 3 files changed, 56 insertions(+) create mode 100644 source/reference/command/parallelCollectionScan-field.yaml create mode 100644 source/reference/command/parallelCollectionScan.txt diff --git a/source/includes/ref-toc-command-crud.yaml b/source/includes/ref-toc-command-crud.yaml index 4397da183e1..9025758a7cc 100644 --- a/source/includes/ref-toc-command-crud.yaml +++ b/source/includes/ref-toc-command-crud.yaml @@ -33,4 +33,8 @@ description: "Resets the last error status." name: ":dbcommand:`eval`" file: /reference/command/eval description: "Runs a JavaScript function on the database server." +--- +name: ":dbcommand:`parallelCollectionScan`" +file: /reference/command/parallelCollectionScan +description: "Lets applications use multiple parallel cursors when reading documents from a collection." ... diff --git a/source/reference/command/parallelCollectionScan-field.yaml b/source/reference/command/parallelCollectionScan-field.yaml new file mode 100644 index 00000000000..b7cb9ce1e59 --- /dev/null +++ b/source/reference/command/parallelCollectionScan-field.yaml @@ -0,0 +1,24 @@ +object: + name: parallelCollectionScan + type: dbcommand +field: + optional: false + type: field +name: parallelCollectionScan +type: string +position: 1 +description: | + The name of the collection. +--- +object: + name: parallelCollectionScan + type: dbcommand +field: + optional: false + type: field +name: numCursors +type: integer +position: 1 +description: | + The number of cursors, not to exceed 1,000. +... diff --git a/source/reference/command/parallelCollectionScan.txt b/source/reference/command/parallelCollectionScan.txt new file mode 100644 index 00000000000..3f19ea43bc0 --- /dev/null +++ b/source/reference/command/parallelCollectionScan.txt @@ -0,0 +1,28 @@ +====================== +parallelCollectionScan +====================== + +.. default-domain:: mongodb + +.. dbcommand:: parallelCollectionScan + + .. versionadded:: 2.6 + + Lets applications use multiple parallel cursors when reading all the + documents in a collection. The :dbcommand:`parallelCollectionScan` + command returns an array of cursors for MongoDB to use in iterating the + collection, bringing increased throughput. + + The command has following syntax: + + .. code-block:: javascript + + { + parallelCollectionScan: "", + numCursors: + } + + The :dbcommand:`parallelCollectionScan` command takes the following + fields: + + .. include:: /reference/command/parallelCollectionScan-field.rst