Segmenting Data by Location
In sharded clusters, you can create zones of sharded data based on the shard key. You can associate each zone with one or more shards in the cluster. A shard can associate with any number of zones. In a balanced cluster, MongoDB migrates chunks covered by a zone only to those shards associated with the zone.
This tutorial uses Zones to segment data based on geographic area.
The following are some example use cases for segmenting data by geographic area:
- An application that requires segmenting user data based on geographic country
- A database that requires resource allocation based on geographic country
The following diagram illustrates a sharded cluster that uses geographic based zones to manage and satisfy data segmentation requirements.
Scenario
A financial chat application logs messages, tracking the country of the originating user. The application stores the logs in the chat
database under the messages
collection. The chats contain information that must be segmented by country to have servers local to the country serve read and write requests for the country’s users. A group of countries can be assigned same zone in order to share resources.
The application currently has users in the US, UK, and Germany. The country
field represents the user’s country based on its ISO 3166-1 Alpha-2 two-character country codes.
The following documents represent a partial view of three chat messages:
Shard Key
The messages
collection uses the { country : 1, userid : 1 }
compound index as the shard key.
The country
field in each document allows for creating a zone for each distinct country value.
The userid
field provides a high cardinality and low frequency component to the shard key relative to country
.
See Choosing a Shard Key for more general instructions on selecting a shard key.
Architecture
The sharded cluster has shards in two data centers - one in Europe, and one in North America.
Zones
This application requires one zone per data center.
-
EU
- European data center -
Shards deployed on this data center are assigned to the
EU
zone.For each country using the
EU
data center for local reads and writes, create a zone range for theEU
zone with:- a lower bound of
{ "country" : <country>, "userid" : MinKey }
- an upper bound of
{ "country" : <country>, "userid" : MaxKey }
- a lower bound of
-
NA
- North American data center -
Shards deployed on this data center are assigned to the
NA
zone.For each country using the
NA
data center for local reads and writes, create a zone range for theNA
zone with:- a lower bound of
{ "country" : <country>, "userid" : MinKey }
- an upper bound of
{ "country" : <country>, "userid" : MaxKey }
- a lower bound of
Note
The MinKey
and MaxKey
values are reserved special values for comparisons
Write Operations
With zones, if an inserted or updated document matches a configured zone, it can only be written to a shard inside of that zone.
MongoDB can write documents that do not match a configured zone to any shard in the cluster.
Note
The behavior described above requires the cluster to be in a steady state with no chunks violating a configured zone. See the following section on the balancer for more information.
Read Operations
MongoDB can route queries to a specific shard if the query includes at least the country
field.
For example, MongoDB can attempt a targeted read operation on the following query:
Queries without the country
field perform broadcast operations.
Balancer
The balancer migrates chunks to the appropriate shard respecting any configured zones. Until the migration, shards may contain chunks that violate configured zones. Once balancing completes, shards should only contain chunks whose ranges do not violate its assigned zones.
Adding or removing zones or zone ranges can result in chunk migrations. Depending on the size of your data set and the number of chunks a zone or zone range affects, these migrations may impact cluster performance. Consider running your balancer during specific scheduled windows. See Schedule the Balancing Window for a tutorial on how to set a scheduling window.
Security
For sharded clusters running with Role-Based Access Control, authenticate as a user with at least the clusterManager
role on the admin
database.
Procedure
You must be connected to a mongos
to create zones and zone ranges. You cannot create zones or zone ranges by connecting directly to a shard.
Disable the Balancer (Optional)
To reduce performance impacts, the balancer may be disabled on the collection to ensure no migrations take place while configuring the new zones.
Use sh.disableBalancing()
, specifying the namespace of the collection, to stop the balancer.
Use sh.isBalancerRunning()
to check if the balancer process is currently running. Wait until any current balancing rounds have completed before proceeding.
Add each shard to the appropriate zone
Add each shard in the North American data center to the NA
zone.
Add each shard in the European data center to the EU
zone.
You can review the zones assigned to any given shard by running sh.status()
.
Define ranges for each zone
For shard key values where country : US
, define a shard key range and associate it to the NA
zone using the sh.addTagRange()
method. This method requires:
- The full namespace of the target collection.
- The inclusive lower bound of the range.
- The exclusive upper bound of the range.
- The name of the zone.
For shard key values where country : UK
, define a shard key range and associate it to the EU
zone using the sh.addTagRange()
method. This method requires:
- The full namespace of the target collection.
- The inclusive lower bound of the range.
- The exclusive upper bound of the range.
- The name of the zone.
For shard key values where country : DE
, define a shard key range and associate it to the EU
zone using the sh.addTagRange()
method. This method requires:
- The full namespace of the target collection.
- The inclusive lower bound of the range.
- The exclusive upper bound of the range.
- The name of the zone.
The MinKey
and MaxKey
values are reserved special value for comparisons.