Skip to content

command descriptions for four include files #943

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
48 changes: 24 additions & 24 deletions source/includes/ref-toc-command-administration.yaml
Original file line number Diff line number Diff line change
@@ -1,96 +1,96 @@
name: ":dbcommand:`renameCollection`"
file: /reference/command/renameCollection
description: ""
description: "Changes the name of an existing collection."
---
name: ":dbcommand:`copydb`"
file: /reference/command/copydb
description: ""
description: "Copies a database from a remote host to the current host."
---
name: ":dbcommand:`dropDatabase`"
file: /reference/command/dropDatabase
description: ""
description: "Removes the current database."
---
name: ":dbcommand:`drop`"
file: /reference/command/drop
description: ""
description: "Removes the specified collection from the database."
---
name: ":dbcommand:`create`"
file: /reference/command/create
description: ""
description: "Creates a collection and sets collection parameters."
---
name: ":dbcommand:`clone`"
file: /reference/command/clone
description: ""
description: "Copies a database from a remote host to the current host."
---
name: ":dbcommand:`cloneCollection`"
file: /reference/command/cloneCollection
description: ""
description: "Copies a collection from a remote host to the current host."
---
name: ":dbcommand:`cloneCollectionAsCapped`"
file: /reference/command/cloneCollectionAsCapped
description: ""
description: "Copies a non-capped collection as a new :term:`capped collection`."
---
name: ":dbcommand:`closeAllDatabases`"
file: /reference/command/closeAllDatabases
description: ""
description: "Internal command that invalidates all cursors and closes open database files."
---
name: ":dbcommand:`convertToCapped`"
file: /reference/command/convertToCapped
description: ""
description: "Converts a non-capped collection to a capped collection."
---
name: ":dbcommand:`filemd5`"
file: /reference/command/filemd5
description: ""
description: "Returns the :term:`md5` hash for files stored using :term:`GridFS`."
---
name: ":dbcommand:`dropIndexes`"
file: /reference/command/dropIndexes
description: ""
description: "Removes one or all indexes from a collection."
---
name: ":dbcommand:`fsync`"
file: /reference/command/fsync
description: ""
description: "Flushes pending writes to the storage layer and locks the database to allow backups."
---
name: ":dbcommand:`clean`"
file: /reference/command/clean
description: ""
description: "Internal command that obtains a write lock on the database."
---
name: ":dbcommand:`connPoolSync`"
file: /reference/command/connPoolSync
description: ""
description: "Internal command."
---
name: ":dbcommand:`compact`"
file: /reference/command/compact
description: ""
description: "Defragments a collection and rebuilds the indexes."
---
name: ":dbcommand:`collMod`"
file: /reference/command/collMod
description: ""
description: "Sets flags on a collection."
---
name: ":dbcommand:`reIndex`"
file: /reference/command/reIndex
description: ""
description: "Rebuilds all indexes on a collection."
---
name: ":dbcommand:`setParameter`"
file: /reference/command/setParameter
description: ""
description: "Modifies configuration options."
---
name: ":dbcommand:`getParameter`"
file: /reference/command/getParameter
description: ""
description: "Retrieves configuration options."
---
name: ":dbcommand:`repairDatabase`"
file: /reference/command/repairDatabase
description: ""
description: "Repairs any errors and inconsistencies with the data storage."
---
name: ":dbcommand:`touch`"
file: /reference/command/touch
description: ""
description: "Loads documents and indexes from data storage to memory."
---
name: ":dbcommand:`shutdown`"
file: /reference/command/shutdown
description: ""
description: "Shuts down the :program:`mongod` or :program:`mongos` process."
---
name: ":dbcommand:`logRotate`"
file: /reference/command/logRotate
description: ""
description: "Rotates the MongoDB logs to prevent a single file from taking too much space."
...
28 changes: 14 additions & 14 deletions source/includes/ref-toc-command-internal.yaml
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
name: ":dbcommand:`handshake`"
file: /reference/command/handshake
description: ""
description: "Internal command."
---
name: ":dbcommand:`_recvChunkAbort`"
file: /reference/command/recvChunkAbort
description: ""
description: "Internal command. Do not call directly."
---
name: ":dbcommand:`_recvChunkCommit`"
file: /reference/command/recvChunkCommit
description: ""
description: "Internal command. Do not call directly."
---
name: ":dbcommand:`_recvChunkStart`"
file: /reference/command/recvChunkStart
description: ""
description: "Internal command. Do not call directly."
---
name: ":dbcommand:`_recvChunkStatus`"
file: /reference/command/recvChunkStatus
description: ""
description: "Internal command. Do not call directly."
---
name: ":dbcommand:`_replSetFresh`"
file: /reference/command/replSetFresh
description: ""
description: "Internal command that supports replica set functionality."
---
name: ":dbcommand:`mapreduce.shardedfinish`"
file: /reference/command/mapreduce.shardedfinish
description: ""
description: "Internal command that supports :term:`map-reduce` in :term:`sharded cluster` environments."
---
name: ":dbcommand:`_transferMods`"
file: /reference/command/transferMods
description: ""
description: "Internal command. Do not call directly."
---
name: ":dbcommand:`replSetHeartbeat`"
file: /reference/command/replSetHeartbeat
description: ""
description: "Internal command that supports replica set functionality."
---
name: ":dbcommand:`replSetGetRBID`"
file: /reference/command/replSetGetRBID
description: ""
description: "Internal command that supports replica set functionality."
---
name: ":dbcommand:`_migrateClone`"
file: /reference/command/migrateClone
description: ""
description: "Internal command. Do not call directly."
---
name: ":dbcommand:`replSetElect`"
file: /reference/command/replSetElect
description: ""
description: "Internal command that supports replica set functionality."
---
name: ":dbcommand:`writeBacksQueued`"
file: /reference/command/writeBacksQueued
description: ""
description: "Internal command that reports on write back operations."
---
name: ":dbcommand:`writebacklisten`"
file: /reference/command/writebacklisten
description: ""
description: "Internal command."
...
39 changes: 19 additions & 20 deletions source/includes/ref-toc-command-sharding.yaml
Original file line number Diff line number Diff line change
@@ -1,77 +1,76 @@
name: ":dbcommand:`flushRouterConfig`"
file: /reference/command/flushRouterConfig
description: ""
description: "Forces an update to the cluster metadata cached by a :program:`mongos`."
---
name: ":dbcommand:`addShard`"
file: /reference/command/addShard
description: ""
description: "Adds a :term:`shard` to a :term:`sharded cluster`."
---
name: ":dbcommand:`checkShardingIndex`"
file: /reference/command/checkShardingIndex
description: ""
description: "Internal command that supports sharding."
---
name: ":dbcommand:`enableSharding`"
file: /reference/command/enableSharding
description: ""
description: "Enables sharding on a specific database."
---
name: ":dbcommand:`listShards`"
file: /reference/command/listShards
description: ""
description: "Returns a list of configured shards."
---
name: ":dbcommand:`removeShard`"
file: /reference/command/removeShard
description: ""
description: "Starts the process of removing a shard from a sharded cluster."
---
name: ":dbcommand:`getShardMap`"
file: /reference/command/getShardMap
description: ""
description: "Internal command that supports sharding."
---
name: ":dbcommand:`getShardVersion`"
file: /reference/command/getShardVersion
description: ""
description: "Internal command that supports sharding."
---
name: ":dbcommand:`setShardVersion`"
file: /reference/command/setShardVersion
description: ""
description: "Internal command that supports sharding."
---
name: ":dbcommand:`shardCollection`"
file: /reference/command/shardCollection
description: ""
description: "Enables the sharding functionality for a collection, allowing the collection to be sharded."
---
name: ":dbcommand:`shardingState`"
file: /reference/command/shardingState
description: ""
description: "Reports whether the :program:`mongod` is a member of a sharded cluster."
---
name: ":dbcommand:`unsetSharding`"
file: /reference/command/unsetSharding
description: ""
description: "Internal command that supports sharding."
---
name: ":dbcommand:`split`"
file: /reference/command/split
description: ""
description: "Creates a new :term:`chunk`."
---
name: ":dbcommand:`splitChunk`"
file: /reference/command/splitChunk
description: ""
description: "Internal command. Instead use the methods :method:`sh.splitFind()` and :method:`sh.splitAt()`."
---
name: ":dbcommand:`splitVector`"
file: /reference/command/splitVector
description: ""
description: "Internal command that supports meta-data operations in sharded clusters."
---
name: ":dbcommand:`medianKey`"
file: /reference/command/medianKey
description: ""
description: "Internal command."
---
name: ":dbcommand:`moveChunk`"
file: /reference/command/moveChunk
description: ""
description: "Internal command that moves chunks between shards."
---
name: ":dbcommand:`movePrimary`"
file: /reference/command/movePrimary
description: ""
description: "Reassigns the :term:`primary shard` when removing a shard from a sharded cluster."
---
name: ":dbcommand:`isdbgrid`"
file: /reference/command/isdbgrid
description: ""
description: "Verifies that a process is a :program:`mongos`."
...

26 changes: 13 additions & 13 deletions source/includes/ref-toc-command-testing.yaml
Original file line number Diff line number Diff line change
@@ -1,48 +1,48 @@
name: ":dbcommand:`testDistLockWithSkew`"
file: /reference/command/testDistLockWithSkew
description: ""
description: "Internal command. Do not call this directly."
---
name: ":dbcommand:`testDistLockWithSyncCluster`"
file: /reference/command/testDistLockWithSyncCluster
description: ""
description: "Internal command. Do not call this directly."
---
name: ":dbcommand:`captrunc`"
file: /reference/command/captrunc
description: ""
description: "Internal command. Truncates capped collections."
---
name: ":dbcommand:`emptycapped`"
file: /reference/command/emptycapped
description: ""
description: "Internal command. Removes all documents from a capped collection."
---
name: ":dbcommand:`godinsert`"
file: /reference/command/godinsert
description: ""
description: "Internal command for testing."
---
name: ":dbcommand:`hashBSONElement`"
name: ":dbcommand:`_hashBSONElement`"
file: /reference/command/hashBSONElement
description: ""
description: "Internal command. Computes the MD5 hash of a BSON element."
---
name: ":dbcommand:`_journalLatencyTest`"
file: /reference/command/journalLatencyTest
description: ""
description: "Tests the time required to write and perform a file system sync for a file in the journal directory."
---
name: ":dbcommand:`sleep`"
file: /reference/command/sleep
description: ""
description: "Internal command for testing. Forces MongoDB to block all operations."
---
name: ":dbcommand:`replSetTest`"
file: /reference/command/replSetTest
description: ""
description: "Internal command for testing replica set functionality."
---
name: ":dbcommand:`forceerror`"
file: /reference/command/forceerror
description: ""
description: "Internal command for testing. Forces a user assertion exception."
---
name: ":dbcommand:`skewClockCommand`"
file: /reference/command/skewClockCommand
description: ""
description: "Internal command. Do not call this command directly."
---
name: ":dbcommand:`configureFailPoint`"
file: /reference/command/configureFailPoint
description: ""
description: "Internal command for testing. Configures failure points."
...