Skip to content

Commit 1446d29

Browse files
committed
switch to refs
1 parent d20eb8b commit 1446d29

29 files changed

+82
-154
lines changed

source/connection/connection-options.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,8 @@ parameters of the connection URI to specify the behavior of the client.
193193

194194
* - **authMechanism**
195195
- string
196-
- Specifies the :doc:`authentication mechanism
197-
</security/auth>` that the driver uses if a credential
196+
- Specifies the :ref:`authentication mechanism
197+
<java-authentication-mechanisms>` that the driver uses if a credential
198198
was supplied.
199199

200200
| **Default**: By default, the client picks the most secure

source/crud/builders/aggregates.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _aggregates-builders:
2+
13
===================
24
Aggregates Builders
35
===================
@@ -19,8 +21,6 @@ Aggregates Builders
1921

2022
Atlas Vector Search </builders/vector-search>
2123

22-
.. _aggregates-builders:
23-
2424
Overview
2525
--------
2626

@@ -90,7 +90,7 @@ Project
9090

9191
Use the ``project()`` method to create a :manual:`$project </reference/operator/aggregation/project/>`
9292
pipeline stage that project specified document fields. Field projection
93-
in aggregation follows the same rules as :doc:`field projection in queries </crud/read-operations/project>`.
93+
in aggregation follows the same rules as :ref:`field projection in queries </java-fundamentals-project>`.
9494

9595
.. tip::
9696

source/crud/builders/filters.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
1+
.. _filters-builders:
2+
13
================
24
Filters Builders
35
================
46

5-
6-
77
.. contents:: On this page
88
:local:
99
:backlinks: none
1010
:depth: 2
1111
:class: singlecol
1212

13-
.. _filters-builders:
14-
1513
Overview
1614
--------
1715

1816
In this guide, you can learn how to use **builders** to specify
1917
**filters** for your queries in the MongoDB Java driver.
2018

2119
Builders are classes provided by the MongoDB Java driver that help you
22-
construct :ref:`BSON <bson>` objects. To learn more, see our :doc:`guide
23-
on builders </builders/>`.
20+
construct :ref:`BSON <bson>` objects. To learn more, see our :ref:`guide
21+
on builders <java-builders>`.
2422

2523
Filters are the operations MongoDB uses to limit your results to what
2624
you want to see.

source/crud/builders/indexes.txt

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1+
.. _indexes-builders:
2+
13
================
24
Indexes Builders
35
================
46

5-
6-
77
.. contents:: On this page
88
:local:
99
:backlinks: none
1010
:depth: 2
1111
:class: singlecol
1212

13-
.. _indexes-builders:
14-
1513
Overview
1614
--------
1715

1816
In this guide, you can learn how to specify **indexes** using
19-
:doc:`builders </builders/>` in the MongoDB Java driver.
17+
:ref:`builders <java-builders>` in the MongoDB Java driver.
2018
The ``Indexes`` builder provides helper methods for constructing the
2119
following types of indexes:
2220

@@ -29,7 +27,7 @@ following types of indexes:
2927

3028
Indexes store a subset of the collection’s data set. The index stores
3129
the value of a specific field or set of fields, ordered by the value of
32-
the field. See our guide on :doc:`Indexes </fundamentals/indexes>` for
30+
the field. See our guide on :ref:`Indexes <java-fundamentals-indexes>` for
3331
examples of queries covered by indexes.
3432

3533
The ``Indexes`` class provides static factory methods for all the MongoDB index types.

source/crud/builders/projections.txt

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
1+
.. _projections-builders:
2+
13
====================
24
Projections Builders
35
====================
46

5-
6-
77
.. contents:: On this page
88
:local:
99
:backlinks: none
1010
:depth: 2
1111
:class: singlecol
1212

13-
.. _projections-builders:
14-
1513
Overview
1614
--------
1715

1816
In this guide, you can learn how to specify **projections** using
19-
:doc:`builders </builders/>` in the MongoDB Java driver.
17+
:ref:`builders <java-builders>` in the MongoDB Java driver.
2018

2119
MongoDB supports **field projection**, specifying which fields to include and exclude when returning results from a
2220
query. Projection in MongoDB follows some basic rules:

source/crud/builders/sort.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _v:
2+
13
==============
24
Sorts Builders
35
==============
@@ -15,8 +17,6 @@ Sorts Builders
1517
:depth: 2
1618
:class: singlecol
1719

18-
.. _sorts-builders:
19-
2020
Overview
2121
--------
2222

@@ -31,15 +31,15 @@ examples of sort criteria are:
3131
* Alphabetical order by first name
3232

3333
Builders are classes provided by the MongoDB Java driver that help you
34-
construct :ref:`BSON <bson>` objects. To learn more, see our :doc:`guide
35-
on builders </builders/>`.
34+
construct :ref:`BSON <bson>` objects. To learn more, see our :ref:`guide
35+
on builders <java-builders>`.
3636

3737
You should read this guide if you would like to use builders to specify sort
3838
criteria for your queries.
3939

4040
If you want to learn the fundamentals of sorting in the MongoDB Java
4141
driver, consider reading our
42-
:doc:`guide on sorting </crud/read-operations/sort/>`.
42+
:ref:`guide on sorting </java-fundamentals-sort>`.
4343

4444
.. _sorts-builders-sort-sample:
4545

@@ -63,7 +63,7 @@ criteria operators supported by MongoDB. These methods return a ``Bson`` object
6363
that you can pass to the ``sort()`` method of a ``FindIterable`` instance or to
6464
``Aggregates.sort()``. If you want to learn more about the ``Aggregates``
6565
class, see our
66-
:doc:`guide on the Aggregates builder </builders/aggregates>`.
66+
:ref:`guide on the Aggregates builder <aggregates-builders>`.
6767

6868
For more information about the classes and interfaces in this section, see the
6969
following API Documentation:

source/crud/collations.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ order as shown below:
7171
How to Specify Collations
7272
-------------------------
7373

74-
MongoDB supports collations on most :doc:`CRUD operations </fundamentals/crud>`
74+
MongoDB supports collations on most :ref:`CRUD operations <java-crud-operations>`
7575
and aggregations. For a complete list of supported operations, see the
7676
:manual:`Operations that Support Collations </reference/collation/#operations-that-support-collation>`
7777
server manual page.

source/crud/compound-operations.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -101,10 +101,10 @@ The output of the preceding code resembles the following:
101101
{"food": "pizza", "color": "green"}
102102

103103
For more information about the ``Projections`` class, see our
104-
:doc:`guide on the Projections builder </builders/projections/>`.
104+
:ref:`guide on the Projections builder <projections-builders>`.
105105

106106
For more information about the upsert operation, see our
107-
:doc:`guide on upserts </crud/write-operations/upsert/>`.
107+
:ref:`guide on upserts <java-upsert>`.
108108

109109
For more information about the methods and classes mentioned in this section,
110110
see the following API Documentation:
@@ -187,7 +187,7 @@ The output of the preceding code resembles the following:
187187
{"_id": 2, "food": "pear", "color": "yellow"}
188188

189189
For more information about the ``Sorts`` class, see our
190-
:doc:`guide on the Sorts builder </builders/sort/>`.
190+
:ref:`guide on the Sorts builder <sorts-builders>`.
191191

192192
For more information about the methods and classes mentioned in this section,
193193
see the following API Documentation:
@@ -318,10 +318,10 @@ instance:
318318
for the duration of your compound operation.
319319

320320
For information on the ``Updates`` class, see our
321-
:doc:`guide on the Updates builder </builders/updates/>`.
321+
:ref:`guide on the Updates builder <updates-builders>`.
322322

323323
For more information of the ``Filters`` class, see our
324-
:doc:`guide on the Filters builder </builders/filters/>`.
324+
:ref:`guide on the Filters builder <filters-builders>`.
325325

326326
For more information about the ``findOneAndUpdate()`` method, see
327327
the API Documentation for the `MongoCollection class <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#findOneAndUpdate(org.bson.conversions.Bson,java.util.List,com.mongodb.client.model.FindOneAndUpdateOptions)>`__.

source/crud/gridfs.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,8 @@ see the following resources:
263263

264264
- `GridFSFindIterable <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/gridfs/GridFSFindIterable.html>`__ API Documentation
265265
- `GridFSBucket.find() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/gridfs/GridFSBucket.html#find(org.bson.conversions.Bson)>`__ API Documentation
266-
- :doc:`Sort Results </crud/read-operations/sort>`
267-
- :doc:`Limit the Number of Returned Results </crud/read-operations/limit>`
266+
- :ref:`Sort Results <java-fundamentals-sort>`
267+
- :ref:`Limit the Number of Returned Results <java-fundamentals-limit>`
268268

269269
.. _gridfs-download-files:
270270

source/crud/query-document.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
.. _java-query:
2+
13
===============
24
Specify a Query
35
===============
46

5-
6-
77
.. contents:: On this page
88
:local:
99
:backlinks: none

source/crud/read-operations/geo.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ GeoJSON data to a ``2dsphere`` index. The following snippet creates a
115115
collection.createIndex(Indexes.geo2dsphere("location.geo"));
116116

117117
For more information about the ``Indexes`` builder, see our
118-
:doc:`guide on the Indexes builder </builders/indexes>`.
118+
:ref:`guide on the Indexes builder <indexes-builders>`.
119119

120120
.. guide resource
121121

@@ -166,7 +166,7 @@ legacy coordinate pairs to a ``2d`` index. The following snippet creates a
166166
collection.createIndex(Indexes.geo2d("coordinates"));
167167

168168
For more information about the ``Indexes`` builder, see our
169-
:doc:`guide on the Indexes builder </builders/indexes>`.
169+
:ref:`guide on the Indexes builder <indexes-builders>`.
170170

171171
For more information about legacy coordinate pairs, see the
172172
:manual:`{+mdb-server+} manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
@@ -208,7 +208,7 @@ For more information about geospatial query operators, see the
208208
.. external resource
209209

210210
For more information about ``Filters``, see our
211-
:doc:`guide on the Filters builder </builders/filters>`.
211+
:ref:`guide on the Filters builder <filters-builders>`.
212212

213213
Query Parameters
214214
~~~~~~~~~~~~~~~~
@@ -229,7 +229,7 @@ Examples
229229

230230
The following examples use the MongoDB Atlas sample dataset. You can learn how
231231
to set up your own free-tier Atlas cluster and how to load the sample dataset
232-
in our :doc:`quick start guide </quick-start>`.
232+
in our :ref:`quick start guide <java-get-started>`.
233233

234234
The examples use the ``theaters`` collection in the ``sample_mflix`` database
235235
from the sample dataset. The ``theaters`` collection contains a ``2dsphere`` index
@@ -293,7 +293,7 @@ For more information about the ``$near`` operator, see
293293
:manual:`the reference documentation for $near </reference/operator/query/near/#mongodb-query-op.-near>`.
294294

295295
For more information about ``Filters``,
296-
:doc:`see our guide on the Filters builder </builders/filters>`.
296+
:ref:`see our guide on the Filters builder <filters-builders>`.
297297

298298
Query Within a Range
299299
~~~~~~~~~~~~~~~~~~~~

source/crud/read-operations/limit.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ to reach the specified limit, it can return a smaller number.
2525
If you use ``limit()`` with the ``skip()`` instance method, the skip applies
2626
first and the limit only applies to the documents left over after
2727
the skip. For more information about the ``skip()`` method, see our
28-
:doc:`guide on Skipping Returned Documents </crud/read-operations/skip/>`.
28+
:ref:`guide on Skipping Returned Documents <java-fundamentals-skip>`.
2929

3030
The following examples demonstrate, respectively, how to insert data into
3131
a collection, how to use ``limit()`` to restrict the number of returned documents,

source/crud/read-operations/retrieve.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -53,8 +53,8 @@ to retrieve, in what order to retrieve them, and how many to retrieve.
5353
To perform a find operation, call the ``find()`` method on an instance
5454
of a ``MongoCollection``. This method searches a collection for documents that
5555
match the query filter you provide. For more information about how to
56-
specify a query, see our :doc:`Specify a Query
57-
</crud/query-document>` guide.
56+
specify a query, see our :ref:`Specify a Query
57+
<java-query>` guide.
5858

5959
Example
6060
~~~~~~~
@@ -70,8 +70,8 @@ To address this scenario, the owner finds orders to match the criteria:
7070
:start-after: begin findExample
7171
:end-before: end findExample
7272

73-
For more information about how to build filters, see our :doc:`Filters Builders
74-
</builders/filters>` guide.
73+
For more information about how to build filters, see our :ref:`Filters Builders
74+
<filters-builders>` guide.
7575

7676
The following shows the output of the preceding query:
7777

@@ -84,8 +84,8 @@ The following shows the output of the preceding query:
8484
After the owner runs this query, they find two orders that matched the
8585
criteria.
8686

87-
For a runnable ``find()`` example, see our :doc:`Find Multiple
88-
Documents </usage-examples/find>` page.
87+
For a runnable ``find()`` example, see our :ref:`Find Multiple
88+
Documents <retrieve-find>` page.
8989

9090
.. _retrieve-aggregate:
9191

@@ -101,7 +101,7 @@ instance of a ``MongoCollection``. This method accepts aggregation
101101
expressions to run in sequence. To perform aggregations, you can
102102
define aggregation stages that specify how to match documents, rename
103103
fields, and group values. For more information, see our
104-
:doc:`Aggregation </fundamentals/aggregation>` guide.
104+
:ref:`Aggregation <java-aggregation>` guide.
105105

106106
Example
107107
~~~~~~~

source/crud/read-operations/sort.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ builder class. While it is possible to specify sort criteria using any class
9797
that implements the ``Bson`` interface, we recommend that you specify sort
9898
criteria through the ``Sorts`` builder. For more information about the ``Sorts``
9999
builder class, see our
100-
:doc:`guide on the Sorts builder </builders/sort/>`.
100+
:ref:`guide on the Sorts builder <sorts-builders>`.
101101

102102
For more information about the classes and interfaces in this section, see the
103103
following API Documentation:
@@ -328,9 +328,9 @@ sort by the text score.
328328
In the following code example, we show how you can use the
329329
``Sorts.metaTextScore()`` method to sort the results of a text
330330
search on the :ref:`sample collection <sorts-crud-sort-sample>`.
331-
The code example uses the :doc:`Filters </builders/filters>`,
332-
:doc:`Indexes </builders/indexes>`, and
333-
:doc:`Projections </builders/projections>` builders.
331+
The code example uses the :ref:`Filters <filters-builders>`,
332+
:ref:`Indexes <indexes-builders>`, and
333+
:ref:`Projections <projections-builders>` builders.
334334
The code example performs the following actions:
335335

336336
#. Creates a text index for your

source/crud/read-operations/text.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,8 @@ Text Search
8282

8383
Use the ``Filters.text()`` method to specify a text search.
8484

85-
The ``Filters.text()`` method uses the :doc:`Filters builder
86-
</builders/filters>` to define a query filter specifying
85+
The ``Filters.text()`` method uses the :ref:`Filters builder
86+
<filters-builders>` to define a query filter specifying
8787
what to search for during the text search. The query filter is
8888
represented by a :ref:`BSON <bson>` instance. Pass the query filter to the
8989
``find()`` method to run a text search.

source/crud/write-operations/embedded-arrays.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ The examples on this page use the ``findOneAndUpdate()`` method of the
3939
example uses an instance of the ``FindOneAndUpdateOptions`` class to
4040
have MongoDB retrieve the document after the update occurs. For
4141
more information on the ``findOneAndUpdate()`` method, see our
42-
:doc:`Compound Operations guide </crud/compound-operations/>`.
42+
:ref:`Compound Operations guide <java-compound-operations>`.
4343

4444
Specifying an Update
4545
--------------------

0 commit comments

Comments
 (0)