Skip to content

command descriptions for six include files #941

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.

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
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions source/includes/ref-toc-command-aggregation.yaml
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
name: ":dbcommand:`aggregate`"
file: /reference/command/aggregate
description: ""
description: "Performs a query using the :doc:`aggregation framework </core/aggregation>` pipeline."
---
name: ":dbcommand:`count`"
file: /reference/command/count
description: ""
description: "Counts the number of documents in a collection."
---
name: ":dbcommand:`distinct`"
file: /reference/command/distinct
description: ""
description: "Displays the distinct values found for a specified key in a collection."
---
name: ":dbcommand:`group`"
file: /reference/command/group
description: ""
description: "Groups documents in a collection by the specified key and performs simple aggregation."
---
name: ":dbcommand:`mapReduce`"
file: /reference/command/mapReduce
description: ""
description: "Performs map-reduce style data aggregation."
...
8 changes: 4 additions & 4 deletions source/includes/ref-toc-command-authentication.yaml
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
name: ":dbcommand:`logout`"
file: /reference/command/logout
description: ""
description: "Terminates the current authenticated session."
---
name: ":dbcommand:`authenticate`"
file: /reference/command/authenticate
description: ""
description: "Starts an authenticated session using a username and password."
---
name: ":dbcommand:`copydbgetnonce`"
file: /reference/command/copydbgetnonce
description: ""
description: "This is an internal command to generate a one-time password for use with the :dbcommand:`copydb` command."
---
name: ":dbcommand:`getnonce`"
file: /reference/command/getnonce
description: ""
description: "This is an internal command to generate a one-time password for authentication."
...
12 changes: 6 additions & 6 deletions source/includes/ref-toc-command-crud.yaml
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
name: ":dbcommand:`findAndModify`"
file: /reference/command/findAndModify
description: ""
description: "Returns and modifies a single document."
---
name: ":dbcommand:`text`"
file: /reference/command/text
description: ""
description: "Performs a text search."
---
name: ":dbcommand:`getLastError`"
file: /reference/command/getLastError
description: ""
description: "Returns the success status of the last operation."
---
name: ":dbcommand:`getPrevError`"
file: /reference/command/getPrevError
description: ""
description: "Returns status document containing all errors since the last :dbcommand:`resetError` command."
---
name: ":dbcommand:`resetError`"
file: /reference/command/resetError
description: ""
description: "Resets the last error status."
---
name: ":dbcommand:`eval`"
file: /reference/command/eval
description: ""
description: "Runs a JavaScript function on the database server."
...
52 changes: 25 additions & 27 deletions source/includes/ref-toc-command-diagnostic.yaml
Original file line number Diff line number Diff line change
@@ -1,102 +1,100 @@
name: ":dbcommand:`listDatabases`"
file: /reference/command/listDatabases
description: ""
description: "Provides a list of databases and basic database statistics."
---
name: ":dbcommand:`dbHash`"
file: /reference/command/dbHash
description: ""
description: "This is an internal command."
---
name: ":dbcommand:`driverOIDTest`"
file: /reference/command/driverOIDTest
description: ""
description: "This is an internal command."
---
name: ":dbcommand:`listCommands`"
file: /reference/command/listCommands
description: ""
description: "Lists all database commands implemented for the current :program:`mongod` instance."
---
name: ":dbcommand:`availableQueryOptions`"
file: /reference/command/availableQueryOptions
description: ""
description: "This is an internal command available only on :program:`mongos` instances."
---
name: ":dbcommand:`buildInfo`"
file: /reference/command/buildInfo
description: ""
description: "Displays statistics about the MongoDB build."
---
name: ":dbcommand:`collStats`"
file: /reference/command/collStats
description: ""
description: "Displays statistics about a specified collection."
---
name: ":dbcommand:`connPoolStats`"
file: /reference/command/connPoolStats
description: ""
description: "Displays statistics about open connections to the current database instance."
---
name: ":dbcommand:`dbStats`"
file: /reference/command/dbStats
description: ""
description: "Displays storage statistics for the database."
---
name: ":dbcommand:`cursorInfo`"
file: /reference/command/cursorInfo
description: ""
description: "Displays statistics about the numbers of cursors used."
---
name: ":dbcommand:`dataSize`"
file: /reference/command/dataSize
description: ""
description: "This is an internal command that returns data size for a set of data within a given range."
---
name: ":dbcommand:`diagLogging`"
file: /reference/command/diagLogging
description: ""
description: "This is an internal command that obtains a write lock on a database and blocks other operations."
---
name: ":dbcommand:`getCmdLineOpts`"
file: /reference/command/getCmdLineOpts
description: ""
description: "Displays the command-line options used to start the current :program:`mongod` process."
---
name: ":dbcommand:`netstat`"
file: /reference/command/netstat
description: ""
description: "This is an internal command available only on :program:`mongos` instances."
---
name: ":dbcommand:`ping`"
file: /reference/command/ping
description: ""
description: "Tests whether a server is responding to commands."
---
name: ":dbcommand:`profile`"
file: /reference/command/profile
description: ""
description: "Modifies the current level of database profiling."
---
name: ":dbcommand:`validate`"
file: /reference/command/validate
description: ""
description: "Scans for a collection's data and indexes for correctness."
---
name: ":dbcommand:`top`"
file: /reference/command/top
description: ""
description: "Returns raw usage statistics for each database in the :program:`mongod` instance."
---
name: ":dbcommand:`indexStats`"
file: /reference/command/indexStats
description: ""
description: "Aggregates statistics for the B-tree data structure that stores data for a MongoDB index."
---
name: ":dbcommand:`whatsmyuri`"
file: /reference/command/whatsmyuri
description: ""
description: "This is an internal command."
---
name: ":dbcommand:`getLog`"
file: /reference/command/getLog
description: ""
description: "Displays recent messages from MongoDB's log."
---
name: ":dbcommand:`hostInfo`"
file: /reference/command/hostInfo
description: ""
description: "Displays information about the underlying system MongoDB runs on."
---
name: ":dbcommand:`serverStatus`"
file: /reference/command/serverStatus
description: ""
description: "Provides detailed statistics on the state of the database process."
---
name: ":dbcommand:`features`"
file: /reference/command/features
description: ""
description: "This is an internal command that returns the build-level feature settings."
---
name: ":dbcommand:`isSelf`"
file: /reference/command/isSelf
description: ""
description: "This is an internal command."
...


6 changes: 3 additions & 3 deletions source/includes/ref-toc-command-geospatial.yaml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
name: ":dbcommand:`geoNear`"
file: /reference/command/geoNear
description: ""
description: "Performs a geospatial query that returns the 100 documents closest to a given point."
---
name: ":dbcommand:`geoSearch`"
file: /reference/command/geoSearch
description: ""
description: "Performs a geospatial query that uses MongoDB's :term:`haystack index` functionality."
---
name: ":dbcommand:`geoWalk`"
file: /reference/command/geoWalk
description: ""
description: "This is an internal command."
...
22 changes: 11 additions & 11 deletions source/includes/ref-toc-command-replication.yaml
Original file line number Diff line number Diff line change
@@ -1,44 +1,44 @@
name: ":dbcommand:`replSetFreeze`"
file: /reference/command/replSetFreeze
description: ""
description: "Prevents the current member from seeking election as :term:`primary` for a period of time."
---
name: ":dbcommand:`replSetGetStatus`"
file: /reference/command/replSetGetStatus
description: ""
description: "Displays the status of the replica set."
---
name: ":dbcommand:`replSetInitiate`"
file: /reference/command/replSetInitiate
description: ""
description: "Initializes a new replica set."
---
name: ":dbcommand:`replSetMaintenance`"
file: /reference/command/replSetMaintenance
description: ""
description: "Enables or disables the maintenance mode and `RECOVERING`` state for a :term:`secondary`."
---
name: ":dbcommand:`replSetReconfig`"
file: /reference/command/replSetReconfig
description: ""
description: "Modifies the configuration of a replica set."
---
name: ":dbcommand:`replSetStepDown`"
file: /reference/command/replSetStepDown
description: ""
description: "Forces the primary to become a secondary, which initiates election for primary."
---
name: ":dbcommand:`replSetSyncFrom`"
file: /reference/command/replSetSyncFrom
description: ""
description: "Explicitly sets the host that this replica set member will sync from, overriding the default."
---
name: ":dbcommand:`resync`"
file: /reference/command/resync
description: ""
description: "This is for master-slave replication only. This forces a :program:`mongod` to re-synchronize."
---
name: ":dbcommand:`applyOps`"
file: /reference/command/applyOps
description: ""
description: "This is an internal command that applies :term:`oplog` entries."
---
name: ":dbcommand:`isMaster`"
file: /reference/command/isMaster
description: ""
description: "Displays information about this member's role in the replica set, including whether it is the master."
---
name: ":dbcommand:`getoptime`"
file: /reference/command/getoptime
description: ""
description: "This is an internal command."
...