-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
Copy pathsh.commitReshardCollection.txt
92 lines (60 loc) · 2.04 KB
/
sh.commitReshardCollection.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
============================
sh.commitReshardCollection()
============================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. method:: sh.commitReshardCollection(namespace)
.. versionadded:: 5.0
During a resharding operation, MongoDB does not block writes until
the estimated duration to complete the resharding operation is
below **two seconds**.
If the current estimate is above two seconds but the time frame is
acceptable to you, you can finish resharding faster. The
:method:`sh.commitReshardCollection()` method blocks writes early and
forces the resharding operation to complete.
.. |dbcommand| replace:: :dbcommand:`commitReshardCollection` command
.. include:: /includes/fact-mongosh-shell-method-alt.rst
Compatibility
-------------
This method is available in deployments hosted in the following environments:
.. include:: /includes/fact-environments-atlas-only.rst
.. include:: /includes/fact-environments-atlas-support-no-free.rst
.. include:: /includes/fact-environments-onprem-only.rst
Syntax
------
The :method:`sh.commitReshardCollection()` method has the following
syntax:
.. code-block:: javascript
sh.commitReshardCollection( <namespace> )
Parameter
~~~~~~~~~
The :method:`sh.commitReshardCollection()` method takes the following
parameter:
.. list-table::
:header-rows: 1
:widths: 20 20 60
* - Parameter
- Type
- Description
* - :ref:`namespace <method-commitReshardCollection-namespace>`
- String
- .. _method-commitReshardCollection-namespace:
The name of the collection to shard in the form
``"<database>.<collection>"``.
Example
-------
Commit a Resharding Operation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The following command forces the :ref:`resharding operation
<sharding-resharding>` on the ``sales.orders`` to block writes and
complete:
.. code-block:: javascript
sh.commitReshardCollection("sales.orders")
.. seealso::
:ref:`sharding-resharding`