db.adminCommand()

Definition

• db.adminCommand(command)
• Provides a helper to run specified database commands against the admin database.

ParameterTypeDescriptioncommanddocument or stringA database command, specified either in document formor as a string. If specified as a string, the command cannot includeany arguments.

Behavior

db.adminCommand runs commands against the admindatabase regardless of the database context in which it runs.The following commands are equivalent:

db.getSiblingDB("admin").runCommand(<command>)
 
db.adminCommand(<command>)

For a list of available administrative database commands, seeAdministration Commands.

Note

For a mongod or mongos running withauthorization, the authorized user must havethe appropriate privileges to run the database command. See thereference documentation for the command for more information onsecurity requirements.

Response

The method returns a response document that contains the followingfields:

Examples

killOp

The following example uses the db.adminCommand()method to execute a killOp command to terminate anoperation with opid 724. killOp is an administrativecommand and must be run against the admin database.

db.adminCommand( { "killOp": 1, "op": 724 } )

renameCollection

The following example uses db.adminCommand() to executethe renameCollection administrative database commandto rename the orders collection in the test database toorders-2016.

db.adminCommand(
  {
     renameCollection: "test.orders",
     to: "test.orders-2016"
  }
)

createUser

The following example uses the db.adminCommand() method tocreate a user named bruce with the dbOwner role on theadmin database.

Tip

Starting in version 4.2 of the mongo shell, you canuse the passwordPrompt() method in conjunction withvarious user authentication/management methods/commands to promptfor the password instead of specifying the password directly in themethod/command call. However, you can still specify the passworddirectly as you would with earlier versions of themongo shell.

db.adminCommand(
  {
    createUser: "bruce",
    pwd: passwordPrompt(),  // or <cleartext password>
    roles: [
      { role: "dbOwner", db: "admin" }
    ]
  }
)