Skip to content

Commit b5942b7

Browse files
author
Andrew Leung
committed
changing :func: to :method:
1 parent 06dcd61 commit b5942b7

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

source/administration/sharding.txt

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ more detail or use the following procedure as a quick starting point:
125125
replicaSetName/<seed1>,<seed2>,<seed3>
126126

127127
For example, if the name of the replica set is "``repl0``", then
128-
your :func:`sh.addShard` command would be:
128+
your :method:`sh.addShard` command would be:
129129

130130
.. code-block:: javascript
131131

@@ -136,7 +136,7 @@ more detail or use the following procedure as a quick starting point:
136136
MongoDB enables sharding on a per-database basis. This is only a
137137
meta-data change and will not redistribute your data. To enable
138138
sharding for a given database, use the :dbcommand:`enableSharding`
139-
command or the :func:`sh.enableSharding()` shell function.
139+
command or the :method:`sh.enableSharding()` shell function.
140140

141141
.. code-block:: javascript
142142

@@ -165,7 +165,7 @@ more detail or use the following procedure as a quick starting point:
165165
collections must belong to a database for which you have enabled
166166
sharding. When you shard a collection, you also choose the shard
167167
key. To shard a collection, run the :dbcommand:`shardCollection`
168-
command or the :func:`sh.shardCollection()` shell helper.
168+
command or the :method:`sh.shardCollection()` shell helper.
169169

170170
.. code-block:: javascript
171171

@@ -223,7 +223,7 @@ procedure:
223223

224224
#. First, you need to tell the cluster where to find the individual
225225
shards. You can do this using the :dbcommand:`addShard` command or
226-
the :func:`sh.addShard()` helper:
226+
the :method:`sh.addShard()` helper:
227227

228228
.. code-block:: javascript
229229

@@ -266,7 +266,7 @@ procedure:
266266
following form: the replica set name, followed by a forward
267267
slash, followed by a comma-separated list of seeds for the
268268
replica set. For example, if the name of the replica set is
269-
"myapp1", then your :func:`sh.addShard` command might resemble:
269+
"myapp1", then your :method:`sh.addShard` command might resemble:
270270

271271
.. code-block:: javascript
272272

@@ -312,7 +312,7 @@ The procedure to remove a shard is as follows:
312312
shard name when you first ran the :dbcommand:`addShard` command. If not,
313313
you can find out the name of the shard by running the
314314
:dbcommand:`listshards` or :dbcommand:`printShardingStatus`
315-
commands or the :func:`sh.status()` shell helper.
315+
commands or the :method:`sh.status()` shell helper.
316316

317317
The following examples will remove a shard named ``mongodb0`` from the cluster.
318318

@@ -444,11 +444,11 @@ You may want to split chunks manually if:
444444
keys are between ``250`` and ``500`` are in a single chunk.
445445

446446
To determine the current chunk ranges across the cluster, use
447-
:func:`sh.status()` or :func:`db.printShardingStatus()`.
447+
:method:`sh.status()` or :method:`db.printShardingStatus()`.
448448

449449
To split chunks manually, use the :dbcommand:`split` command with
450450
operators: ``middle`` and ``find``. The equivalent shell helpers are
451-
:func:`sh.splitAt()` or :func:`sh.splitFind()`.
451+
:method:`sh.splitAt()` or :method:`sh.splitFind()`.
452452

453453
.. example::
454454

@@ -459,13 +459,13 @@ operators: ``middle`` and ``find``. The equivalent shell helpers are
459459

460460
sh.splitFind( { "zipcode": 63109 } )
461461

462-
:func:`sh.splitFind()` will split the chunk containing the queried
462+
:method:`sh.splitFind()` will split the chunk containing the queried
463463
document into two equal sized chunks, dividing the chunk using the
464-
balancer algorithm. The :func:`sh.splitFind()` query may not be based
464+
balancer algorithm. The :method:`sh.splitFind()` query may not be based
465465
on the shard key, but it makes sense to use the shard key, and
466466
including the shard key will expedite the operation.
467467

468-
Use :func:`sh.splitAt()` to split a chunk in two using the queried
468+
Use :method:`sh.splitAt()` to split a chunk in two using the queried
469469
document as the partition point:
470470

471471
.. code-block:: javascript
@@ -574,7 +574,7 @@ To modify the chunk size, use the following procedure:
574574

575575
use config
576576

577-
#. Issue the following :func:`save() <db.collection.save()>`
577+
#. Issue the following :method:`save() <db.collection.save()>`
578578
operation:
579579

580580
.. code-block:: javascript
@@ -718,7 +718,7 @@ Here's what this tells you:
718718

719719
.. note::
720720

721-
Use the :func:`sh.isBalancerRunning()` helper in the
721+
Use the :method:`sh.isBalancerRunning()` helper in the
722722
:program:`mongo` shell to determine if the balancer is
723723
running, as follows:
724724

@@ -746,7 +746,7 @@ be able to migrate chunks:
746746

747747
use config
748748

749-
#. Use an operation modeled on the following example :func:`update()
749+
#. Use an operation modeled on the following example :method:`update()
750750
<db.collection.update()>` operation to modify the balancer's
751751
window:
752752

@@ -800,10 +800,10 @@ all migration, use the following procedure:
800800

801801
If a balancing round is in progress, the system will complete the
802802
current round before the balancer is officially disabled. After
803-
disabling, you can use the :func:`sh.getBalancerState()` shell
803+
disabling, you can use the :method:`sh.getBalancerState()` shell
804804
function to determine whether the balancer is in fact disabled.
805805

806-
The above process and the :func:`sh.setBalancerState()` helper provide a
806+
The above process and the :method:`sh.setBalancerState()` helper provide a
807807
wrapper on the following process, which may be useful if you need to
808808
run this operation from a driver that does not have helper functions:
809809

@@ -1168,6 +1168,6 @@ operation:
11681168
for the duration of the backup procedure.
11691169

11701170
Confirm that the balancer is not active using the
1171-
:func:`sh.getBalancerState()` method before starting a backup
1171+
:method:`sh.getBalancerState()` method before starting a backup
11721172
operation. When the backup procedure is complete you can reactivate
11731173
the balancer process.

0 commit comments

Comments
 (0)