Skip to content

Commit 71f3dd0

Browse files
committed
[Java Sync] P1 - Shift Java ToC (mongodb#615)
1 parent dfae779 commit 71f3dd0

Some content is hidden

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

74 files changed

+307
-209
lines changed

config/redirects

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,39 @@ raw: ${prefix}/master -> ${base}/upcoming/
1111
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/change-a-document/ -> ${base}/${version}/fundamentals/crud/write-operations/modify/
1212
[*-v4.10]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/
1313
[*-v4.8]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/
14+
[*-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/
15+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/
16+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/
17+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/
18+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/
19+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/
20+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/
21+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/
22+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/
23+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/
24+
[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/
25+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/
26+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/
27+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/
28+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/
29+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/
30+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/
31+
[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/
32+
[*-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/
33+
[*-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/
34+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/
35+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/
36+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/
37+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/
38+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/
39+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/
40+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/
41+
[*-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/
42+
[*-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/
43+
[*-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/
44+
[*-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/
45+
[*-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/
46+
[*-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/
47+
[*-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/
48+
[*-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/
49+
[*-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/

snooty.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ intersphinx = [
77
]
88

99
toc_landing_pages = [
10-
"/fundamentals/connection",
11-
"/fundamentals/crud",
10+
"/connection",
11+
"/crud",
1212
"/fundamentals/builders",
1313
"/fundamentals/aggregation",
1414
"/usage-examples",

source/atlas-search.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _java-atlas-search:
2+
3+
============
4+
Atlas Search
5+
============
6+
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: full text, text analyzer, meta, pipeline, scoring, Lucene
13+
:description: Learn about how to use Atlas Search in the {+driver-long+}.
14+
15+
.. contents:: On this page
16+
:local:
17+
:backlinks: none
18+
:depth: 2
19+
:class: singlecol
20+
21+
See :atlas:`Atlas Search </atlas-search/>` in the MongoDB Atlas documentation.

source/atlas-vector-search.txt

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
.. _java-atlas-vector-search:
2+
3+
===================
4+
Atlas Vector Search
5+
===================
6+
7+
.. facet::
8+
:name: genre
9+
:values: reference
10+
11+
.. meta::
12+
:keywords: full text, text analyzer, meta, pipeline, scoring, Lucene, AI, artificial intelligence
13+
:description: Learn about how to use Atlas Vector Search in the {+driver-long+}.
14+
15+
.. contents:: On this page
16+
:local:
17+
:backlinks: none
18+
:depth: 2
19+
:class: singlecol
20+
21+
See :atlas:`Atlas Vector Search </atlas-vector-search/vector-search-overview/>`
22+
in the MongoDB Atlas documentation.

source/usage-examples/command.txt renamed to source/command.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,11 @@
22
Run a Command
33
=============
44

5+
<<<<<<< HEAD:source/usage-examples/command.txt
56
.. default-domain:: mongodb
67

8+
=======
9+
>>>>>>> 215c9aa ([Java Sync] P1 - Shift Java ToC (#615)):source/command.txt
710
You can run all raw database operations using the
811
``MongoDatabase.runCommand()`` method. A raw database operation is a
912
command you can execute directly on the {+mdb-server+} CLI. These

source/fundamentals/connection.txt renamed to source/connection.txt

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,12 @@ Connection Guide
66

77
.. toctree::
88

9-
Connect to MongoDB </fundamentals/connection/connect>
10-
Connection Options </fundamentals/connection/connection-options>
11-
MongoClient Settings </fundamentals/connection/mongoclientsettings>
12-
Network Compression </fundamentals/connection/network-compression>
13-
TLS/SSL </fundamentals/connection/tls>
14-
SOCKS5 Proxy </fundamentals/connection/socks>
15-
JNDI Datasource </fundamentals/connection/jndi>
9+
Connect to MongoDB </connection/connect>
10+
Connection Options </connection/connection-options>
11+
MongoClient Settings </connection/mongoclientsettings>
12+
Network Compression </connection/network-compression>
13+
SOCKS5 Proxy </connection/socks>
14+
JNDI Datasource </connection/jndi>
1615
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
1716

1817
.. contents:: On this page

source/fundamentals/connection/connection-options.txt renamed to source/connection/connection-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ parameters of the connection URI to specify the behavior of the client.
194194
* - **authMechanism**
195195
- string
196196
- Specifies the :doc:`authentication mechanism
197-
</fundamentals/auth>` that the driver uses if a credential
197+
</security/auth>` that the driver uses if a credential
198198
was supplied.
199199

200200
| **Default**: By default, the client picks the most secure
File renamed without changes.

source/crud.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _java-crud-operations:
2+
3+
===============
4+
CRUD Operations
5+
===============
6+
7+
.. toctree::
8+
:caption: CRUD Operations
9+
10+
Read </crud/read-operations>
11+
Write </crud/write-operations>
12+
Query </crud/query-document>
13+
Compound Operations </crud/compound-operations>
14+
15+
CRUD (Create, Read, Update, Delete) operations enable you to work with
16+
data stored in MongoDB.
17+
18+
- :ref:`Read Operations <java-read-operations>` find and return
19+
documents stored in your database.
20+
- :ref:`Write Operations <java-write-operations>` insert, modify,
21+
or delete documents in your database.
22+
23+
Some operations combine aspects of read and write operations. See our
24+
guide on :ref:`compound operations <java-compound-operations>`
25+
to learn more about these hybrid methods.

source/fundamentals/crud/compound-operations.txt renamed to source/crud/compound-operations.txt

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _java-compound-operations:
2+
13
===================
24
Compound Operations
35
===================
@@ -101,10 +103,10 @@ The output of the preceding code resembles the following:
101103
{"food": "pizza", "color": "green"}
102104

103105
For more information about the ``Projections`` class, see our
104-
:doc:`guide on the Projections builder </fundamentals/builders/projections/>`.
106+
:doc:`guide on the Projections builder </builders/projections/>`.
105107

106108
For more information about the upsert operation, see our
107-
:doc:`guide on upserts </fundamentals/crud/write-operations/upsert/>`.
109+
:doc:`guide on upserts </crud/write-operations/upsert/>`.
108110

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

189191
For more information about the ``Sorts`` class, see our
190-
:doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
192+
:doc:`guide on the Sorts builder </builders/sort/>`.
191193

192194
For more information about the methods and classes mentioned in this section,
193195
see the following API Documentation:
@@ -318,10 +320,10 @@ instance:
318320
for the duration of your compound operation.
319321

320322
For information on the ``Updates`` class, see our
321-
:doc:`guide on the Updates builder </fundamentals/builders/updates/>`.
323+
:doc:`guide on the Updates builder </builders/updates/>`.
322324

323325
For more information of the ``Filters`` class, see our
324-
:doc:`guide on the Filters builder </fundamentals/builders/filters/>`.
326+
:doc:`guide on the Filters builder </builders/filters/>`.
325327

326328
For more information about the ``findOneAndUpdate()`` method, see
327329
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/read-operations.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. _java-read-operations:
2+
3+
===============
4+
Read Operations
5+
===============
6+
7+
.. meta::
8+
:description: Learn about the commands for running read operations on MongoDB by using the {+driver-long+}.
9+
10+
.. toctree::
11+
:caption: Read Operations
12+
13+
Retrieve Data </crud/read-operations/retrieve>
14+
Data from a Cursor </crud/read-operations/cursor>
15+
Sort Results </crud/read-operations/sort>
16+
Skip Returned Results </crud/read-operations/skip>
17+
Limit Returned Results </crud/read-operations/limit>
18+
Specify Fields to Return </crud/read-operations/project>
19+
Geospatial Data </crud/read-operations/geo>
20+
Search Text </crud/read-operations/text>
21+
22+
- :doc:`/crud/read-operations/retrieve`
23+
- :doc:`/crud/read-operations/cursor`
24+
- :doc:`/crud/read-operations/sort`
25+
- :doc:`/crud/read-operations/skip`
26+
- :doc:`/crud/read-operations/limit`
27+
- :doc:`/crud/read-operations/project`
28+
- :doc:`/crud/read-operations/geo`
29+
- :doc:`/crud/read-operations/text`

source/fundamentals/crud/read-operations/geo.txt renamed to source/crud/read-operations/geo.txt

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

100100
For more information about the ``Indexes`` builder, see our
101-
:doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
101+
:doc:`guide on the Indexes builder </builders/indexes>`.
102102

103103
.. guide resource
104104

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

133133
For more information about the ``Indexes`` builder, see our
134-
:doc:`guide on the Indexes builder </fundamentals/builders/indexes>`.
134+
:doc:`guide on the Indexes builder </builders/indexes>`.
135135

136136
For more information about legacy coordinate pairs, see the
137137
:manual:`{+mdb-server+} manual page on legacy coordinate pairs </geospatial-queries/#legacy-coordinate-pairs>`.
@@ -173,7 +173,7 @@ For more information about geospatial query operators, see the
173173
.. external resource
174174

175175
For more information about ``Filters``, see our
176-
:doc:`guide on the Filters builder </fundamentals/builders/filters>`.
176+
:doc:`guide on the Filters builder </builders/filters>`.
177177

178178
Query Parameters
179179
~~~~~~~~~~~~~~~~
@@ -258,7 +258,7 @@ For more information about the ``$near`` operator, see
258258
:manual:`the reference documentation for $near </reference/operator/query/near/#mongodb-query-op.-near>`.
259259

260260
For more information about ``Filters``,
261-
:doc:`see our guide on the Filters builder </fundamentals/builders/filters>`.
261+
:doc:`see our guide on the Filters builder </builders/filters>`.
262262

263263
Query Within a Range
264264
~~~~~~~~~~~~~~~~~~~~

source/fundamentals/crud/read-operations/limit.txt renamed to 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 </fundamentals/crud/read-operations/skip/>`.
28+
:doc:`guide on Skipping Returned Documents </crud/read-operations/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/fundamentals/crud/read-operations/retrieve.txt renamed to source/crud/read-operations/retrieve.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ 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
5656
specify a query, see our :doc:`Specify a Query
57-
</fundamentals/crud/query-document>` guide.
57+
</crud/query-document>` guide.
5858

5959
Example
6060
~~~~~~~
@@ -71,7 +71,7 @@ To address this scenario, the owner finds orders to match the criteria:
7171
:end-before: end findExample
7272

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

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

source/fundamentals/crud/read-operations/sort.txt renamed to 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 </fundamentals/builders/sort/>`.
100+
:doc:`guide on the Sorts builder </builders/sort/>`.
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 </fundamentals/builders/filters>`,
332-
:doc:`Indexes </fundamentals/builders/indexes>`, and
333-
:doc:`Projections </fundamentals/builders/projections>` builders.
331+
The code example uses the :doc:`Filters </builders/filters>`,
332+
:doc:`Indexes </builders/indexes>`, and
333+
:doc:`Projections </builders/projections>` builders.
334334
The code example performs the following actions:
335335

336336
#. Creates a text index for your

source/fundamentals/crud/read-operations/text.txt renamed to source/crud/read-operations/text.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ Text Search
8383
Use the ``Filters.text()`` method to specify a text search.
8484

8585
The ``Filters.text()`` method uses the :doc:`Filters builder
86-
</fundamentals/builders/filters>` to define a query filter specifying
86+
</builders/filters>` 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.txt

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
.. _java-write-operations:
2+
3+
================
4+
Write Operations
5+
================
6+
7+
.. meta::
8+
:description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}.
9+
10+
.. toctree::
11+
:caption: Write Operations
12+
13+
Insert </crud/write-operations/insert>
14+
Delete </crud/write-operations/delete>
15+
Modify </crud/write-operations/modify>
16+
Update Array Elements </crud/write-operations/embedded-arrays>
17+
Upsert </crud/write-operations/upsert>
18+
Bulk Operations </crud/write-operations/bulk>
19+
20+
- :doc:`/crud/write-operations/insert`
21+
- :doc:`/crud/write-operations/delete`
22+
- :doc:`/crud/write-operations/modify`
23+
- :doc:`/crud/write-operations/embedded-arrays`
24+
- :doc:`/crud/write-operations/upsert`
25+
- :doc:`/crud/write-operations/bulk`

source/fundamentals/crud/write-operations/embedded-arrays.txt renamed to 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 </fundamentals/crud/compound-operations/>`.
42+
:doc:`Compound Operations guide </crud/compound-operations/>`.
4343

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

source/fundamentals/crud/write-operations/insert.txt renamed to source/crud/write-operations/insert.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ methods.
3030
The following sections focus on ``insertOne()`` and
3131
``insertMany()``. For information on how to use the ``bulkWrite()``
3232
method, see our
33-
:doc:`guide on Bulk Operations </fundamentals/crud/write-operations/bulk/>`.
33+
:doc:`guide on Bulk Operations </crud/write-operations/bulk/>`.
3434

3535
A Note About ``_id``
3636
--------------------

source/fundamentals/crud/write-operations/modify.txt renamed to source/crud/write-operations/modify.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ The following shows the updated documents in the ``paint_inventory`` collection:
118118

119119
If zero documents match the query filter in the update operation,
120120
``updateMany()`` makes no changes to documents in the collection. See
121-
our :doc:`upsert guide </fundamentals/crud/write-operations/upsert>` to
121+
our :doc:`upsert guide </crud/write-operations/upsert>` to
122122
learn how to insert a new document instead of updating one if no
123123
documents match.
124124

@@ -194,7 +194,7 @@ The following shows the updated document:
194194

195195
If zero documents match the query filter in the replace operation,
196196
``replaceOne()`` makes no changes to documents in the collection. See
197-
our :doc:`upsert guide </fundamentals/crud/write-operations/upsert>` to
197+
our :doc:`upsert guide </crud/write-operations/upsert>` to
198198
learn how to insert a new document instead of replacing one if no
199199
documents match.
200200

0 commit comments

Comments
 (0)