Skip to content

Commit 6a5a014

Browse files
authored
DOCSP-26224 replace docs directives pointing to transactions (#2090)
* DOCSP-26224 replace docs directives pointing to transactions * internal review feedback
1 parent 75b7f3d commit 6a5a014

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+87
-93
lines changed

source/core/gridfs.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ that exceed the :term:`BSON`\-document :ref:`size limit
2020

2121
.. note::
2222

23-
GridFS does not support :doc:`multi-document transactions </core/transactions>`.
23+
GridFS does not support :ref:`multi-document transactions <transactions>`.
2424

2525

2626
Instead of storing a file in a single document, GridFS divides the file

source/core/retryable-writes.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ cannot be :writeconcern:`{w: 0} <\<number\>>`.
149149
Starting in MongoDB 4.2, you can update a document's shard key value
150150
(unless the shard key field is the immutable ``_id`` field) by
151151
issuing single-document update/findAndModify operations either as a
152-
retryable write or in a :doc:`transaction </core/transactions>`. For
152+
retryable write or in a :ref:`transaction <transactions>`. For
153153
details, see :ref:`update-shard-key`.
154154

155155
.. [#duplicate-key-update]

source/core/transactions-operations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ DDL Operations
6565

6666
Starting in MongoDB 4.4 with :ref:`feature compatibility version (fcv)
6767
<view-fcv>` ``"4.4"``, you can create collections and indexes inside a
68-
:doc:`multi-document transaction </core/transactions>` if the
68+
:ref:`multi-document transaction <transactions>` if the
6969
transaction is :red:`not` a cross-shard write transaction.
7070

7171
.. _transactions-operations-ddl-explicit:

source/core/transactions.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Create Collections and Indexes In a Transaction
396396
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
397397

398398
Starting in MongoDB 4.4, you can perform the following operations inside
399-
of a :doc:`multi-document transaction </core/transactions>` as long as
399+
of a :ref:`multi-document transaction <transactions>` as long as
400400
the transaction is not a cross-shard write transaction:
401401

402402
- Create collections.

source/includes/change-stream/clusterTime.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The timestamp from the oplog entry associated with the event.
44

55
Change stream event notifications associated with a
6-
:doc:`multi-document transaction </core/transactions>`
6+
:ref:`multi-document transaction <transactions>`
77
all have the same ``clusterTime`` value: the time when the transaction
88
was committed.
99

source/includes/extracts-rs-stepdown.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ content: |
2323
original primary resumes normal operation.
2424
2525
Writes that were in progress when |command-method-name| is run
26-
are killed. In-progress :doc:`transactions </core/transactions>`
26+
are killed. In-progress :ref:`transactions <transactions>`
2727
also fail with :ref:`transient-transaction-error` and can be
2828
retried as a whole.
2929

source/includes/extracts-transactions.yaml

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
ref: transactions-read-pref
22
content: |
33
4-
:doc:`Multi-document transactions </core/transactions>` that contain
4+
:ref:`Multi-document transactions <transactions>` that contain
55
read operations must use read preference :readmode:`primary`. All
66
operations in a given transaction must route to the same member.
77
@@ -22,7 +22,7 @@ content: |
2222
2323
For additional transactions usage considerations
2424
(such as runtime limit and oplog size limit), see also
25-
:doc:`/core/transactions-production-consideration`.
25+
:ref:`<production-considerations>`.
2626
2727
---
2828
ref: transactions-intro
@@ -47,7 +47,7 @@ content: |
4747
multi-document transactions on replica sets.
4848
4949
For details regarding transactions in MongoDB, see the
50-
:doc:`/core/transactions` page.
50+
:ref:`transactions <transactions>` page.
5151
5252
---
5353
ref: transactions-faq
@@ -75,7 +75,7 @@ content: |
7575
multi-document transactions on replica sets.
7676
7777
For details regarding transactions in MongoDB, see the
78-
:doc:`/core/transactions` page.
78+
:ref:`transactions <transactions>` page.
7979
8080
---
8181
ref: transactions-operations-restrictions
@@ -139,11 +139,11 @@ content: |
139139
140140
.. include:: /includes/extracts/transactions-cross-shard-collection-restriction.rst
141141
142-
- You cannot write to :doc:`capped </core/capped-collections>`
142+
- You cannot write to :ref:`capped <manual-capped-collection>`
143143
collections. (Starting in MongoDB 4.2)
144144
145145
- You cannot use read concern :readconcern:`"snapshot"` when reading
146-
from a :doc:`capped </core/capped-collections>` collection.
146+
from a :ref:`capped <manual-capped-collection>` collection.
147147
(Starting in MongoDB 5.0)
148148
149149
- You cannot read/write to collections in the ``config``, ``admin``,
@@ -191,8 +191,8 @@ content: |
191191
ref: transactions-supported-operation
192192
content: |
193193
194-
|operation| can be used inside :doc:`multi-document transactions
195-
</core/transactions>`.
194+
|operation| can be used inside :ref:`multi-document transactions
195+
<transactions>`.
196196
197197
---
198198
ref: transactions-distinct-support
@@ -275,7 +275,7 @@ content: |
275275
ref: transactions-read-concern-majority
276276
content: |
277277
Disabling :readconcern:`"majority"` read concern affects support for
278-
:doc:`transactions </core/transactions>` on sharded clusters. Specifically:
278+
:ref:`transactions <transactions>` on sharded clusters. Specifically:
279279
280280
- A transaction cannot use read concern :readconcern:`"snapshot"` if
281281
the transaction involves a shard that has :ref:`disabled read
@@ -285,7 +285,7 @@ content: |
285285
transaction's read or write operations involves a shard that has
286286
disabled read concern :readconcern:`"majority"`.
287287
288-
However, it does not affect :doc:`transactions </core/transactions>`
288+
However, it does not affect :ref:`transactions <transactions>`
289289
on replica sets. For transactions on replica sets, you can specify
290290
read concern :readconcern:`"majority"` (or :readconcern:`"snapshot"`
291291
or :readconcern:`"local"` ) for multi-document transactions even if
@@ -402,31 +402,31 @@ content: |
402402
403403
You cannot run transactions on a sharded cluster that has a shard
404404
with :rsconf:`writeConcernMajorityJournalDefault` set to ``false``
405-
(such as a shard with a voting member that uses the :doc:`in-memory
406-
storage engine </core/inmemory>`).
405+
(such as a shard with a voting member that uses the :ref:`in-memory
406+
storage engine <storage-inmemory>`).
407407
408408
---
409409
ref: transactions-killop-change
410410
content: |
411411
412412
Starting in MongoDB 4.2, you cannot specify :dbcommand:`killCursors` as
413-
the first operation in a :doc:`transaction </core/transactions>`.
413+
the first operation in a :ref:`transaction <transactions>`.
414414
415415
---
416416
ref: transactions-capped-collection-change
417417
content: |
418418
419-
Starting in MongoDB 4.2, you cannot write to :doc:`capped
420-
</core/capped-collections>` collections in :doc:`transactions
421-
</core/transactions>`.
419+
Starting in MongoDB 4.2, you cannot write to :ref:`capped
420+
<manual-capped-collection>` collections in :ref:`transactions
421+
<transactions>`.
422422
423423
---
424424
ref: transactions-capped-collection-read-change
425425
content: |
426426
427427
Starting in MongoDB 5.0, you cannot use read concern
428428
:readconcern:`"snapshot"` when reading from a
429-
:doc:`capped </core/capped-collections>` collection.
429+
:ref:`capped <manual-capped-collection>` collection.
430430
431431
---
432432
ref: transactions-arbiters
@@ -473,14 +473,14 @@ content: |
473473
ref: transactions-inmemory-txn-page
474474
content: |
475475
476-
Starting in MongoDB 4.2, :doc:`multi-document transactions
477-
</core/transactions>` are supported on replica sets and sharded
476+
Starting in MongoDB 4.2, :ref:`multi-document transactions
477+
<transactions>` are supported on replica sets and sharded
478478
clusters where:
479479
480480
- the primary uses the WiredTiger storage engine, and
481481
482-
- the secondary members use either the WiredTiger storage engine or the
483-
:doc:`in-memory </core/inmemory>` storage engines.
482+
- the secondary members use either the WiredTiger storage engine or
483+
the :ref:`in-memory <storage-inmemory>` storage engines.
484484
485485
In MongoDB 4.0, only replica sets using the WiredTiger storage
486486
engine supported transactions.
@@ -490,7 +490,7 @@ content: |
490490
You cannot run transactions on a sharded cluster that has a shard
491491
with :rsconf:`writeConcernMajorityJournalDefault` set to
492492
``false``, such as a shard with a voting member that uses the
493-
:doc:`in-memory storage engine </core/inmemory>`.
493+
in-memory storage engine.
494494
495495
---
496496
ref: transactions-inmemory-storage-page
@@ -499,11 +499,11 @@ content: |
499499
Starting in MongoDB 4.2, transactions are supported on replica sets
500500
and sharded clusters where:
501501
502-
- the primary uses the :doc:`WiredTiger </core/wiredtiger>` storage
502+
- the primary uses the :ref:`WiredTiger <storage-wiredtiger>` storage
503503
engine, and
504504
505505
- the secondary members use either the WiredTiger storage engine or the
506-
:doc:`in-memory </core/inmemory>` storage engines.
506+
:ref:`in-memory <storage-inmemory>` storage engines.
507507
508508
In MongoDB 4.0, only replica sets using the WiredTiger storage
509509
engine supported transactions.
@@ -513,7 +513,7 @@ content: |
513513
You cannot run transactions on a sharded cluster that has a shard
514514
with :rsconf:`writeConcernMajorityJournalDefault` set to
515515
``false``, such as a shard with a voting member that uses the
516-
:doc:`in-memory storage engine </core/inmemory>`.
516+
:ref:`in-memory storage engine <storage-inmemory>`.
517517
---
518518
ref: transactions-sharded-clusters-commit-writeconcern
519519
content: |
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Starting in MongoDB 5.3, you can use the :pipeline:`$setWindowFields`
2-
stage with :doc:`transactions </core/transactions>` and the
2+
stage with :ref:`transactions <transactions>` and the
33
:readconcern:`"snapshot"` read concern.

source/includes/write-concern-majority-and-transactions.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
If you specify a :writeconcern:`"majority"` write concern for a
2-
:doc:`multi-document transaction </core/transactions>` and the
2+
:ref:`multi-document transaction <transactions>` and the
33
transaction fails to replicate to the :ref:`calculated majority
44
<calculating-majority-count>` of :term:`replica set` members, then the
55
transaction may not immediately roll back on replica set members.

source/reference/command/aggregate.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ arguments:
9999

100100
- Optional. Specifies to return the information on the processing of the pipeline.
101101

102-
Not available in :doc:`multi-document transactions </core/transactions>`.
102+
Not available in :ref:`multi-document transactions <transactions>`.
103103

104104

105105

0 commit comments

Comments
 (0)