MongoDB Shgll Chgaľ Shggľ

To gsľ sľarľsd, insľall ľhs MongoDB Shell (mongosh).

Basic Commands
Thsss basic hslp commands ars availabls in ľhs MongoDB Shsll.

mongosh Opsn a connscľion ľo your local

MongoDB insľancs. 6ll oľhsr
commands will bs run wiľhin ľhis
mongosh connscľion.

db.help() Show hslp ror daľabass msľhods.

db.<collection>.help() Show hslp on collscľion msľhods. Ths

<collscľion> can bs ľhs nams or
an s…isľing collscľion or a non-s…
isľing collscľion.
db.users.help() Shows hslp on msľhods rslaľsd ľo ľhs
ussrs collscľion.

show dbs Prinľ a lisľ or all daľabasss on ľhs

ssrvsr.

use <db> Swiľch currsnľ daľabass ľo <db>. Ths

mongo shsll variabls db is ssľ ľo ľhs
currsnľ daľabass.

show collections Prinľ a lisľ or all collscľions ror ľhs

currsnľ daľabass.

show users Prinľ a lisľ or ussrs ror ľhs currsnľ

daľabass.

show roles Prinľ a lisľ or all rolss, boľh

ussr-dsfinsd and builľ-in, ror
ľhs currsnľ daľabass.

show profile Prinľ ľhs fivs mosľ rscsnľ opsraľions

ľhaľ ľook 1 millisscond or mors on
daľabasss wiľh profiling snablsd.
show databases Prinľ a lisľ or all s…isľing daľabasss
availabls ľo ľhs currsnľ ussr.

exit E…iľ ľhs mongosh ssssion.

Crgaľg Opgraľions
Crsaľs or inssrľ opsraľions add nsw documsnľs ľo a collscľion. Ir ľhs collscľion
doss noľ s…isľ, crsaľs opsraľions also crsaľs ľhs collscľion.

db.collection.insertOne() Inssrľs a singls documsnľ inľo a

collscľion.
db.users.insertOne( { name: "Chris"} 6dd a nsw documsnľ wiľh ľhs nams or
) Chris inľo ľhs ussrs collscľion

db.collection.insertMany() Inssrľs mulľipls documsnľs inľo a

collscľion.
db.users.insertMany( { age: "24"}, 6dd ľwo nsw documsnľs wiľh ľhs ags or
{age: "38"} ) 2K and 38 inľo ľhs ussrs collscľion

Pgad Opgraľions
Psad opsraľions rsľrisvs documsnľs rrom a collscľion; i.s. qusry a collscľion ror
documsnľs.

db.collection.find() Sslscľs documsnľs in a collscľion or

visw and rsľurns a cursor ľo ľhs
sslscľsd documsnľs.
db.users.find() Psľurns all ussrs.

db.collection.find(<filterobjec Iind all documsnľs ľhaľ maľch ľhs

t>) filľsr objscľ
db.users.find({place: "NYC"}) Psľurns all ussrs wiľh ľhs placs NYC.

db.collection.find({<field>:1,< Psľurns all documsnľs ľhaľ maľch ľhs

field>:1}) qusry arľsr you s…pliciľly includs
ssvsral fislds by ssľľing ľhs <fisld> ľo
1 in ľhs projscľion documsnľ.
db.users.find({status:1,item:1}) Psľurns maľching documsnľs only rrom sľaľs
fisld, iľsm fisld and, by dsraulľ, ľhs _id fisld.
db.collection.find({<field>:1,< Psľurns all documsnľs ľhaľ maľch
field>:0, _id:0}) ľhs qusry and rsmovss ľhs _id fisld
rrom ľhs rssulľs by ssľľing iľ ľo 0 in
ľhs projscľion.
db.users.find({status:1,item:1,_id:0} Psľurns maľching documsnľs only rrom
) sľaľs fisld and iľsm fisld. Doss noľ rsľurn
ľhs _id fisld.

Updaľg Opgraľions
Updaľs opsraľions modiry s…isľing documsnľs in a collscľion.

db.collection.updateOne() Updaľss a singls documsnľ wiľhin ľhs

collscľion bassd on ľhs filľsr.
db.users.updateOne({ age: 25 }, Updaľss all ussrs rrom ľhs ags or 25 ľo 32.
{ $set: { age: 32 } })

db.collection.updateMany() Updaľss a singls documsnľ wiľhin ľhs

collscľion bassd on ľhs filľsr.
db.users.updateMany({ age: 27 }, Updaľss all ussrs wiľh an ags or 27 wiľh an
{ $inc: { age: 3 } }) incrsass or 3.

db.collection.replaceOne() Psplacss a singls documsnľ wiľhin ľhs

collscľion bassd on ľhs filľsr.
db.users.replaceOne({ name: Kris }, Psplacss ľhs firsľ ussr wiľh ľhs nams Kris
{ name: Chris }) wiľh a documsnľ ľhaľ has ľhs nams Chris in
iľs nams fisld.

Dglgľg Opgraľions
Dslsľs opsraľions rsmovs documsnľs rrom a collscľion.

db.collection.deleteOne() Psmovss a singls documsnľ rrom a

collscľion.
db.users.deleteOne({ age: 37 }) Dslsľss ľhs firsľ ussr wiľh ľhs ags 37.

db.collection.deleteMany() Psmovss all documsnľs ľhaľ maľch ľhs

filľsr rrom a collscľion.
db.users.deleteMany({ age: {$lt:18 }) Dslsľss all ussrs wiľh ľhs ags lsss ľhan 18..
Comparison Qugry Opgraľors
Uss ľhs rollowing insids an filľsr objscľ ľo maks compls… qusriss

$eq Maľchss valuss ľhaľ ars squal ľo a

spscifisd valus.
db.users.find({ system: { $eq: Iinds all ussrs wiľh ľhs opsraľing sysľsm
"macOS" } }) macOS.

$gt Maľchss valuss ľhaľ ars grsaľsr ľhan a

spscifisd valus.
db.users.deleteMany({ age: { $gt: 66} Dslsľss all ussrs wiľh an ags grsaľsr ľhan 99.
})

$gte Maľchss valuss ľhaľ ars grsaľsr ľhan

or squal ľo a spscifisd valus.
db.users.updateMany({ age": {$gte:21 Updaľss all accsss ľo "valid" ror all ussrs wiľh
},{access: "valid"}) an ags grsaľsr ľhan or squal ľo 21.

$in Maľchss any or ľhs valuss spscifisd in

an array.
db.users.find( { place: { $in: Iind all ussrs wiľh ľhs placs fisld ľhaľ is siľhsr
[ "NYC", "SF"] } ) NYC or SI.

$lt Maľchss valuss ľhaľ ars lsss ľhan a

spscifisd valus.
db.users.deleteMany({ "age": {$lt:18 Dslsľss all ussrs wiľh ľhs ags lsss ľhan 18..
})

$lte Maľchss valuss ľhaľ ars lsss ľhan or

squal ľo a spscifisd valus.
db.users.updateMany({ age: { $lte: 17 Updaľss all accsss ľo "invalid" ror all ussrs
}, {access: "invalid"}) wiľh an ags lsss ľhan or squal ľo 17.

$ne Maľchss all valuss ľhaľ ars noľ squal

ľo a spscifisd valus.
db.users.find({ "place": {$ne: Iind all ussrs wiľh ľhs placs fisld ssľ ľo
‘NYC"}) anyľhing oľhsr ľhan NYC.
$nin Maľchss nons or ľhs valuss spscifisd
in an array.
db.users.find( { place: { $nin: [ Iind all ussrs wiľh ľhs placs fisld ľhaľ doss noľ
"NYC", "SF" ] } ) squal NYC or SI.

Iigld Updaľg Opgraľors

Uss ľhs rollowing insids an updaľs objscľ ľo maks compls… updaľss

$inc Incrsmsnľs ľhs valus or ľhs fisld by

db.users.updateOne({ age: 22 }, { ľhs spscifisd amounľ.
$inc: { age: 3} }) 6dds 3 ľo ľhs ags or ľhs firsľ ussr wiľh ľhs
ags or 22.

$min Only updaľss ľhs fisld ir ľhs spscifisd

valus is lsss ľhan ľhs s…isľing fisld
db.scores.insertOne( { _id: 1, valus.
highScore: 800, lowScore: 200 } ) Crsaľss a scolss collscľion and ssľs ľhs
valus or highScors ľo 800 and lowScors ľo
200.
db.scores.updateOne( { _id: 1 }, {
$min: { lowScore: 150 } } ) $min comparss 200 (ľhs currsnľ valus or
lowScors) ľo ľhs spscifisd valus or 150.
Bscauss 150 is lsss ľhan 200, $min will updaľs
lowScors ľo 150.
$max
Only updaľss ľhs fisld ir ľhs spscifisd
valus is grsaľsr ľhan ľhs s…isľing
db.scores.updateOne( { _id: 1 }, { fisld valus.
$max: { highScore: 1000 } } ) $ma… comparss 800 (ľhs currsnľ valus
or highScors) ľo ľhs spscifisd valus or
1000. Bscauss 1000 is mors ľhan 800,
$ma… will updaľs highScors ľo 1000.

$rename Psnamss a fisld.

db.scores.updateOne( { $rename: Psnamss ľhs fisld ‘highScorss’ ľo ‘high’,
{ 'highScore': 'high'} )
$set Ssľs ľhs valus or a fisld in a
documsnľ.
db.users.updateOne({ $set: { name: Psplacss ľhs valus or ľhs nams fisld wiľh ľhs
"valid user" } }) spscifisd valus valid ussr.

$unset Psmovss ľhs spscifisd fisld rrom a

db.users.updateOne({ $unset: { name: documsnľ.
"" } }) Dslsľss ľhs spscifisd valus valid ussr rrom ľhs
nams fisld.

Pgad Modifigrs
6dd any or ľhs rollowing ľo ľhs snd or any rsad opsraľion

cursor.sort() Ordsrs ľhs slsmsnľs or an array

during a $push opsraľion.
db.users.find().sort({ name: 1, age: Sorľs all ussrs by nams in alphabsľical ordsr
-1 }) and ľhsn ir any namss ars ľhs sams sorľ by
ags in rsvsrss ordsr

cursor.limit() Spscifiss ľhs ma…imum numbsr or

documsnľs ľhs cursor will rsľurn.

cursor.skip() Conľrols whsrs MongoDB

bsgins rsľurning rssulľs.

cursor.push() 6ppsnds a spscifisd valus ľo an array.

db.users.updateMany({}, { $push: 6dd Chris ľo ľhs rrisnds array ror all ussrs
{ friends: "Chris" } })
6ggrggaľion Opgraľions
Ths 6ggrsgaľion Iramswork providss a spscific languags ľhaľ can bs ussd ľo
s…scuľs a ssľ or aggrsgaľion opsraľions (procsssing ” compuľaľion) againsľ
daľa hsld in MongoDB.

db.collection.aggregate() 6 msľhod ľhaľ providss accsss ľo ľhs

aggrsgaľion pipslins.

db.users.aggregate([ Sslscľs documsnľs in ľhs ussrs collscľion wiľh

{$match: { access: "valid" } }, accdb.ordsrs.ssľimaľsdDocumsnľCounľ({})_id
{$group: { _id: "$cust_id", total: fisld rrom ľhs sum or ľhs amounľ fisld, and
{$sum: "$amount" } } }, sorľs ľhs rssulľs by ľhs ľoľal fisld in dsscsnding
{$sort: { total: -1 } }]) ordsr:

6ggrggaľion Opgraľions
6ggrggaľion pipglings consisľ or ons or mors sľagss ľhaľ procsss documsnľs
and can rsľurn rssulľs ror groups or documsnľs.

count Counľs ľhs numbsr or documsnľs in

a collscľion or a visw.

distinct Displays ľhs disľincľ valuss round ror a

spscifisd ksy in a collscľion or a visw.

mapReduce Pun map-rsducs aggrsgaľion

opsraľions ovsr a collscľion

6ggrggaľion Opgraľions
Singlg Purposg 6ggrggaľion Mgľhods aggrsgaľs documsnľs rrom a singls
collscľion.

db.collection.estimatedDocument Psľurns an appro…imaľs counľ or ľhs

Count() documsnľs in a collscľion or a visw.
db.users.estimatedDocumentCount({}) Psľrisvss an appro…imaľs counľ or all ľhs
documsnľs in ľhs ussrs collscľion.
db.collection.count() Psľurns a counľ or ľhs numbsr or
documsnľs in a collscľion or a visw.
db.users.count({}) Psľurns ľhs disľincľ valuss ror ľhs ags fisld
rrom all documsnľs in ľhs ussrs collscľion.

db.collection.distinct() Psľurns an array or documsnľs ľhaľ

havs disľincľ valuss ror ľhs spscifisd
fisld.
db.users.distinct("age") Psľurns ľhs disľincľ valuss ror ľhs ags fisld
rrom all documsnľs in ľhs ussrs collscľion.

Indgxing Commands
Inds…ss supporľ ľhs s cisnľ s…scuľion or qusriss in MongoDB. Inds…ss ars
spscial daľa sľrucľurss ľhaľ sľors a small porľion or ľhs daľa ssľ in an
sasy-ľo-ľravsrss rorm.

db.collection.createIndex() Builds an inds… on a collscľion.

db.users.createIndex("account Crsaľss ľhs accounľ crsaľion daľs inds… in
creation date") ľhs ussrs collscľion.

db.collection.dropIndex() Psmovss a spscifisd inds… on a

collscľion.
db.users.dropIndex("account creation Psmovss ľhs accounľ crsaľion daľs inds… rrom
date") ľhs ussrs collscľion.

db.collection.dropIndexes() Psmovss all inds…ss buľ ľhs _id (no

paramsľsrs) or a spscifisd ssľ or inds…
ss on a collscľion.
db.users.dropIndexes() Drop all buľ ľhs _id inds… rrom a collscľion.

db.users.dropIndex("account creation
Psmovss ľhs accounľ crsaľion daľs inds… and
date", "account termination date")
ľhs accounľ ľsrminaľion daľs inds… rrom ľhs
ussrs collscľion.
db.collection.getIndexes() Psľurns an array or documsnľs
ľhaľ dsscribs ľhs s…isľing inds…ss
on a collscľion.
db.users.getIndexes() Psľurns an array or documsnľs ľhaľ hold inds…
inrormaľion ror ľhs ussrs collscľion.

db.collection.reIndex() Psbuilds all s…isľing inds…ss on a

collscľion
db.users.reIndex() Drops all inds…ss on ľhs ussrs collscľion and
rscrsaľss ľhsm.

db.collection.totalIndexSize() Psporľs ľhs ľoľal sizs ussd by ľhs

inds…ss on a collscľion. Providss a
wrappsr around ľhs ľoľalInds…Sizs
fisld or ľhs collSľaľs ouľpuľ.
db.users.totalIndexSize() Psľurns ľhs ľoľal sizs or all inds…ss ror ľhs
ussrs collscľion.

Pgplicaľion Commands
Psplicaľion rsrsrs ľo ľhs procsss or snsuring ľhaľ ľhs sams daľa is availabls on
mors ľhan ons MongoDB Ssrvsr.

rs.add() 6dds a msmbsr ľo a rsplica ssľ.

rs.add( "mongodbd4.example.net:27017" 6dds a nsw sscondary msmbsr,
) mongodbdK.s…ampls.nsľ:27017, wiľh dsraulľ
voľs and prioriľy ssľľings ľo a nsw rsplica ssľ

rs.conf() Psľurns a documsnľ ľhaľ conľains ľhs

currsnľ rsplica ssľ configuraľion.

rs.status() Psľurns ľhs rsplica ssľ sľaľus rrom

ľhs poinľ or visw or ľhs msmbsr
whsrs ľhs msľhod is run.
rs.stepDown() Insľrucľs ľhs primary or ľhs rsplica
ssľ ľo bscoms a sscondary. 6rľsr ľhs
primary sľsps down, sligibls
sscondariss will hold an slscľion ror
primary.

rs.remove() Psmovss ľhs msmbsr dsscribsd by ľhs

hosľnams paramsľsr rrom ľhs currsnľ
rsplica ssľ.

rs.reconfig() Psconfigurss an s…isľing rsplica

ssľ, ovsrwriľing ľhs s…isľing
rsplica ssľ configuraľion.

Sharding Commands
Sharding is a msľhod ror disľribuľing or parľiľioning daľa across mulľipls
compuľsrs. This is dons by parľiľioning ľhs daľa by ksy rangss and
disľribuľing ľhs daľa among ľwo or mors daľabass insľancss.

sh.abortReshardCollection() Ends a rssharding opsraľion

sh.abortReshardCollection("users") 6borľs a running rsshard opsraľion on ľhs
ussrs collscľion.

sh.addShard() 6dds a shard ľo a shardsd clusľsr.

sh.addShard("cluster"/mongodb3.exampl 6dds ľhs clusľsr rsplica ssľ and spscifiss ons
e.net:27327") msmbsr or ľhs rsplica ssľ.

sh.commitReshardCollection Iorcss a rssharding opsraľion ľo block

() wriľss and complsľs.
sh.commitReshardCollection("records.u Iorcss ľhs rssharding opsraľion on ľhs
sers") rscords.ussrs ľo block wriľss and complsľs.
sh.disableBalancing() Disabls balancing on a singls
collscľion in a shardsd daľabass. Doss
noľ aLscľ balancing or oľhsr
collscľions in a shardsd clusľsr.
sh.disableBalancing("records.users") Disablss ľhs balancsr ror ľhs spscifisd
shardsd collscľion.

sh.enableAutoSplit() Enablss auľo-spliľľing ror ľhs shardsd

clusľsr.

sh.disableAutoSplit() Disablss auľo-spliľľing ror ľhs shardsd

clusľsr.

sh.enableSharding() Crsaľss a daľabass.

sh.enablingSharding("records") Crsaľss ľhs rscords daľabass.

sh.help() Psľurns hslp ľs…ľ ror ľhs sh msľhods.

sh.moveChunk() Migraľss a chunk in a shardsd clusľsr.

sh.moveChunk("records.users", { Iinds ľhs chunk ľhaľ conľains ľhs documsnľs
zipcode: "10003" }, "shardexample") wiľh ľhs zipcods fisld ssľ ľo 10003 and ľhsn
movss ľhaľ chunk ľo ľhs shard
namsd shards…ampls.

sh.reshardCollection() Iniľiaľss a rssharding opsraľion ľo

changs ľhs shard ksy ror a collscľion,
changing ľhs disľribuľion or your daľa.
sh.reshardCollection("records.users", Psshards ľhs ussrs collscľion wiľh ľhs nsw
{ order_id: 1 }) shard ksy { ordsr_id: 1 }

sh.shardCollection() Enablss sharding ror a collscľion.

sh.shardCollection("records.users", Shards ľhs ussrs collscľion by ľhs zipcods
{ zipcode: 1 } ) fisld.
sh.splitAt() Dividss an s…isľing chunk inľo
ľwo chunks using a spscific valus
or ľhs shard ksy as ľhs dividing
poinľ.
sh.splitAt( "records.users", { x: 70 Spliľs a chunk or ľhs rscords.ussrs collscľion aľ
} ) ľhs shard ksy valus …: 70

sh.splitFind() Dividss an s…isľing chunk ľhaľ conľains

a documsnľ maľching a qusry inľo
ľwo appro…imaľsly squal chunks.
sh.splitFind( "records.users", { x:70 Spliľs, aľ ľhs msdian poinľ, a chunk ľhaľ
} ) conľains ľhs shard ksy valus …: 70.

sh.status() Psporľs on ľhs sľaľus or a shardsd

clusľsr, as db.prinľShardingSľaľus().

sh.waitForPingChange() Inľsrnal. Waiľs ror a changs in ping

sľaľs rrom ons or ľhs mongos in ľhs
shardsd clusľsr.

refineCollectionShardKey Modifiss ľhs collscľion's shard ksy by

adding nsw fisld(s) as a su … ľo ľhs s…
isľing ksy.
db.adminCommand( { shardCollection: Shard ľhs ordsrs collscľion in ľhs ľssľ
"test.orders", key: { customer_id: 1 daľabass. Ths opsraľion usss ľhs cusľomsr_id
} } ) fisld as ľhs iniľial shard ksy.

db.getSiblingDB("test").orders.create Crsaľs ľhs inds… ľo supporľ ľhs nsw shard ksy

Index( { customer_id: 1, order_id: 1 ir ľhs inds… doss noľ alrsady s…isľ.
} )

db.adminCommand( { Pun rsfinsCollscľionShardKsy command ľo

refineCollectionShardKey: add ľhs ordsr_id fisld as a su …
"test.orders",
key: { customer_id: 1, order_id: 1
}
} )
convertShardKeyToHashed() Psľurns ľhs hashsd valus ror ľhs inpuľ.

use test Considsr a shardsd collscľion ľhaľ usss a

db.orders.createIndex( { _id: hashsd shard ksy.
"hashed" } )
sh.shardCollection( "test.orders", {
_id : "hashed" } )

{ Ir ľhs rollowing documsnľ s…isľs in ľhs

_id: collscľion, ľhs hashsd valus or ľhs _id fisld is
ObjectId("5b2be413c06d624ab26ff6ca"), ussd ľo disľribuľs ľhs documsnľ:

"item" : "Chocolates",
"qty" : 25
}

convertShardKeyToHashed( Dsľsrmins ľhs hashsd valus or _id fisld ussd

ObjectId("5b2be413c06d624ab26ff6ca") ľo disľribuľs ľhs documsnľ across ľhs shards,
)

Daľabasg Mgľhods

db.runCommand() Pun a command againsľ ľhs

currsnľ daľabass

db.adminCommand() Providss a hslpsr ľo run

spscifisd daľabass commands
againsľ ľhs admin daľabass.
Usgr Managgmgnľ Commands
Maks updaľss ľo ussrs in ľhs MongoDB Shsll.

db.auth() 6uľhsnľicaľss a ussr ľo a daľabass.

db.changeUserPassword() Updaľss a ussr's password.

db.createUser() Crsaľss a nsw ussr ror ľhs daľabass

on which ľhs msľhod is run.

db.dropUser() Psmovss ussr/all ussrs rrom ľhs

db.dropAllUsers() currsnľ daľabass.

db.getUser() Psľurns inrormaľion ror a spscifisd

db.getUsers() ussr/all ussrs in ľhs daľabass.

db.grantRolesToUser() Granľs a rols and iľs privilsgss ľo a

ussr.

db.removeUser() Psmovss ľhs spscifisd ussrnams rrom

ľhs daľabass.

db.revokeRolesFromUser() Psmovss ons or mors rolss rrom a ussr

on ľhs currsnľ daľabass.

db.updateUser() Updaľss ľhs ussr's profils on ľhs

daľabass on which you run ľhs
msľhod.

passwordPrompt() Prompľs ror ľhs password in mongosh.

 Polg Managgmgnľ Commands
Maks updaľss ľo rolss in ľhs MongoDB Shsll.

db.createRole() 6uľhsnľicaľss a ussr ľo a daľabass.

db.dropRole() Dslsľss a ussr-dsfinsd rols/all

db.dropAllRoles() ussr-dsfinsd rolss associaľsd wiľh a
daľabass.

db.getRole() Psľurns inrormaľion ror ľhs spscifisd

db.getRoles() rols/all ľhs ussr-dsfinsd rolss in
a daľabass.

db.grantPrivilegesToRole() 6ssigns privilsgss ľo a ussr-dsfinsd

rols.

db.revokePrivilegesFromRole() Psmovss ľhs spscifisd privilsgss rrom

a ussr-dsfinsd rols.

db.grantRolesToRole() Spscifiss rolss rrom which a

ussr-dsfinsd rols inhsriľs privilsgss.

db.revokeRolesFromRole() Psmovss inhsriľsd rolss rrom a rols.

db.updateRole() Updaľss a ussr-dsfinsd rols.

ff