Skip to content

Commit fbb4773

Browse files
(DOCSP12604,12640): Adding balancer and chunk management methods
1 parent 8248582 commit fbb4773

File tree

1 file changed

+63
-0
lines changed

1 file changed

+63
-0
lines changed

source/reference/methods.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1076,10 +1076,48 @@ Sharding Methods
10761076

10771077
- Aliases to :method:`sh.updateZoneKeyRange()`.
10781078

1079+
* - :method:`sh.balancerCollectionStatus()`
1080+
1081+
- Returns information on whether the chunks of a sharded collection are balanced.
1082+
1083+
.. versionadded:: 4.4
1084+
1085+
* - :method:`sh.disableAutoSplit()`
1086+
1087+
- Disables auto-splitting for the sharded cluster.
1088+
1089+
* - :method:`sh.disableBalancing()`
1090+
1091+
- Disables balancing on a single collection in a sharded
1092+
database. Does not affect balancing of other collections in a sharded cluster.
1093+
1094+
* - :method:`sh.enableAutoSplit()`
1095+
1096+
- Enables auto-splitting for the sharded cluster.
1097+
1098+
* - :method:`sh.enableBalancing()`
1099+
1100+
- Activates the sharded collection balancer process if
1101+
previously disabled using :method:`sh.disableBalancing()`.
1102+
10791103
* - :method:`sh.enableSharding()`
10801104

10811105
- Enables sharding on a specific database.
10821106

1107+
* - :method:`sh.getBalancerState()`
1108+
1109+
- Returns a boolean to report if the :term:`balancer` is currently
1110+
enabled.
1111+
1112+
* - :method:`sh.isBalancerRunning()`
1113+
1114+
- Returns a boolean to report if the :term:`balancer` process is
1115+
currently migrating chunks.
1116+
1117+
* - :method:`sh.moveChunk()`
1118+
1119+
- Migrates a :term:`chunk` in a :term:`sharded cluster`.
1120+
10831121
* - :method:`sh.removeRangeFromZone()`
10841122

10851123
- Removes the association between a range of shard key values and a
@@ -1099,14 +1137,39 @@ Sharding Methods
10991137
the :method:`sh.addShardTag()` method. This method aliases to
11001138
:method:`sh.removeRangeFromZone()` in MongoDB 3.4.
11011139

1140+
* - :method:`sh.setBalancerState()`
1141+
1142+
- Enables or disables the :term:`balancer` which migrates
1143+
:term:`chunks` between :term:`shards`.
1144+
11021145
* - :method:`sh.shardCollection()`
11031146

11041147
- Enables sharding for a collection.
1148+
1149+
* - :method:`sh.splitAt()`
1150+
1151+
- Divides an existing :term:`chunk` into two chunks using a
1152+
specific value of the :term:`shard key` as the dividing point.
1153+
1154+
* - :method:`sh.splitFind()`
1155+
1156+
- Divides an existing :term:`chunk` that contains a document
1157+
matching a query into two approximately equal chunks.
1158+
1159+
* - :method:`sh.startBalancer()`
1160+
1161+
- Enables the :term:`balancer`.
11051162

11061163
* - :method:`sh.status()`
11071164

11081165
- Reports on the status of a sharded cluster.
11091166

1167+
* - :method:`sh.stopBalancer()`
1168+
1169+
- Disables the :term:`balancer`. This operation does not wait for
1170+
the balancer to complete any in progress operations, and may
1171+
terminate ongoing operations.
1172+
11101173
* - :method:`sh.updateZoneKeyRange()`
11111174

11121175
- Associates a range of shard keys with a zone. Supports configuring

0 commit comments

Comments
 (0)