Documentation
General Information
Documentation
Developer Articles & Topics
Community Forums
Blog
University
Products
Platform
Atlas
Build on a developer data platform
Platform Services
Database
Deploy a multi-cloud database
Search
Deliver engaging search experiences
Vector Search
Design intelligent apps with gen AI
Stream Processing
Unify data in motion and data at rest
Self Managed
Enterprise Advanced
Run and manage MongoDB yourself
Community Edition
Develop locally with MongoDB
Tools
Compass
Work with MongoDB data in a GUI
Integrations
Integrations with third-party services
Relational Migrator
Migrate to MongoDB with confidence
View All Products
Explore our full developer suite
arrow-right
Build with MongoDB Atlas
Get started for free in minutes
Sign Up
Test Enterprise Advanced
Develop with MongoDB on-premises
Download
Try Community Edition
Explore the latest version of MongoDB
Download
Resources
Documentation
Atlas Documentation
Get started using Atlas
Server Documentation
Learn to use MongoDB
Start With Guides
Get step-by-step guidance for key tasks
Tools and Connectors
Learn how to connect to MongoDB
MongoDB Drivers
Use drivers and libraries for MongoDB
Resources Hub
Get help building the next big thing with MongoDB
arrow-right
Connect
Developer Center
Explore a wide range of developer resources
Community
Join a global community of developers
Courses and Certification
Learn for free from MongoDB
Webinars and Events
Find a webinar or event near you
Solutions
Use cases
Artificial Intelligence
Edge Computing
Internet of Things
Mobile
Payments
Serverless Development
Industries
Financial Services
Telecommunications
Healthcare
Retail
Public Sector
Manufacturing
Solutions Library
Organized and tailored solutions to kick-start projects
arrow-right
Developer Data Platform
Accelerate innovation at scale
Learn more
arrow-right
Startups and AI Innovators
For world-changing ideas and AI pioneers
Learn more
arrow-right
Customer Case Studies
Hear directly from our users
See Stories
arrow-right
Company
Careers
Start your next adventure
Blog
Read articles and announcements
Newsroom
Read press releases and news stories
Partners
Learn about our partner ecosystem
Leadership
Meet our executive team
Company
Learn more about who we are
Contact Us
Reach out to MongoDB
Let’s chat
arrow-right
Investors
Visit our investor portal
Learn more
arrow-right
Pricing
Eng
Support
Sign In
Try Free
menu-vertical
Docs Menu
Docs Home
MongoDB Manual
8.0 (upcoming)
Introduction
Installation
MongoDB Shell (mongosh)
CRUD Operations
Aggregation Operations
Indexes
Atlas Search
Atlas Vector Search
Time Series
Change Streams
Transactions
Data Modeling
Replication
Sharding
Storage
Administration
Security
FAQ
Reference
Cluster Parameters
Collation
Configuration File Options
Connection Strings
Database Commands
Default MongoDB Port
Default MongoDB Read Concerns/Write Concerns
Exit Codes and Statuses
Error Codes
Glossary
Log Messages
MongoDB Limits and Thresholds
MongoDB Package Components
MongoDB Server Parameters
MongoDB Wire Protocol
mongosh
Methods
Native Methods in
mongosh
Atlas Search Index Methods
Atlas Stream Processing Methods
Collection Methods
Cursor Methods
Database Methods
Query Plan Cache Methods
Bulk Operation Methods
User Management Methods
Role Management Methods
Replication Methods
Sharding Methods
convertShardKeyToHashed
db.checkMetadataConsistency()
db.collection.checkMetadataConsistency()
sh.abortReshardCollection()
sh.addShard()
sh.addShardTag()
sh.addShardToZone()
sh.addTagRange()
sh.balancerCollectionStatus()
sh.checkMetadataConsistency()
sh.commitReshardCollection()
sh.disableAutoMerger()
sh.disableBalancing()
sh.enableAutoMerger()
sh.enableBalancing()
sh.disableAutoSplit
sh.enableAutoSplit
sh.enableSharding()
sh.getBalancerState()
sh.getShardedDataDistribution()
sh.help()
sh.isBalancerRunning()
sh.moveChunk()
sh.moveCollection()
sh.removeRangeFromZone()
sh.removeShardTag()
sh.removeShardFromZone()
sh.removeTagRange()
sh.reshardCollection()
sh.setBalancerState()
sh.shardCollection()
sh.splitAt()
sh.splitFind()
sh.startAutoMerger()
sh.startBalancer()
sh.status()
sh.stopAutoMerger()
sh.stopBalancer()
sh.waitForBalancer()
sh.waitForBalancerOff()
sh.waitForPingChange()
sh.updateZoneKeyRange()
Object Constructors and Methods
Connection Methods
Client-Side Field Level Encryption Methods
Operators
Server Sessions
Slot-Based Query Execution Engine
Stable API
System Collections
Legacy
mongo
Shell
Release Notes
Technical Support
Docs Home
/
MongoDB Manual
/
Reference
/
mongosh
/
Sharding Methods
sh.help()
sh.help()
Returns:
a basic help text for all sharding related shell functions.
Back
sh.getShardedDataDistribution()
Next
sh.isBalancerRunning()