-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
sh.addShardTag.txt
67 lines (39 loc) · 1.27 KB
/
sh.addShardTag.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
================
sh.addShardTag()
================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Definition
----------
.. method:: sh.addShardTag(shard, tag)
Associates a shard with a tag or identifier. MongoDB uses these
identifiers to direct :term:`chunks <chunk>` that fall within a
tagged range to specific shards. :method:`sh.addTagRange()`
associates chunk ranges with tag ranges.
.. list-table::
:header-rows: 1
:widths: 20 20 80
* - Parameter
- Type
- Description
* - ``shard``
- string
- The name of the shard to which to give a specific tag.
* - ``tag``
- string
- The name of the tag to add to the shard.
Only issue :method:`sh.addShardTag()` when connected to a
:binary:`~bin.mongos` instance.
Example
-------
The following example adds three tags, ``NYC``, ``LAX``, and ``NRT``, to
three shards:
.. code-block:: javascript
sh.addShardTag("shard0000", "NYC")
sh.addShardTag("shard0001", "LAX")
sh.addShardTag("shard0002", "NRT")
.. seealso:: :method:`sh.addTagRange()` and :method:`sh.removeShardTag()`.