Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ intersphinx = [
]

toc_landing_pages = [
"/fundamentals/connection",
"/fundamentals/crud",
"/connection",
"/crud",
"/fundamentals/builders",
"/fundamentals/aggregation",
"/usage-examples",
Expand Down
21 changes: 21 additions & 0 deletions source/atlas-search.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _java-atlas-search:

============
Atlas Search
============

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: full text, text analyzer, meta, pipeline, scoring, Lucene
:description: Learn about how to use Atlas Search in the {+driver-long+}.

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

See :atlas:`Atlas Search </atlas-search/>` in the MongoDB Atlas Manual.
22 changes: 22 additions & 0 deletions source/atlas-vector-search.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. _java-atlas-vector-search:

===================
Atlas Vector Search
===================

.. facet::
:name: genre
:values: reference

.. meta::
:keywords: full text, text analyzer, meta, pipeline, scoring, Lucene, AI, artificial intelligence
:description: Learn about how to use Atlas Vector Search in the {+driver-long+}.

.. contents:: On this page
:local:
:backlinks: none
:depth: 2
:class: singlecol

See :atlas:`Atlas Vector Search </atlas-vector-search/vector-search-overview/>`
in the MongoDB Atlas Manual.
2 changes: 0 additions & 2 deletions source/usage-examples/command.txt → source/command.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
Run a Command
=============



You can run all raw database operations using the
``MongoDatabase.runCommand()`` method. A raw database operation is a
command you can execute directly on the {+mdb-server+} CLI. These
Expand Down
13 changes: 6 additions & 7 deletions source/fundamentals/connection.txt → source/connection.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ Connection Guide

.. toctree::

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

.. contents:: On this page
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ parameters of the connection URI to specify the behavior of the client.
* - **authMechanism**
- string
- Specifies the :doc:`authentication mechanism
</fundamentals/auth>` that the driver uses if a credential
</security/auth>` that the driver uses if a credential
was supplied.

| **Default**: By default, the client picks the most secure
Expand Down
File renamed without changes.
File renamed without changes.
25 changes: 25 additions & 0 deletions source/crud.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
.. _java-crud-operations:

===============
CRUD Operations
===============

.. toctree::
:caption: CRUD Operations

Read </crud/read-operations>
Write </crud/write-operations>
Query </crud/query-document>
Compound Operations </crud/compound-operations>

CRUD (Create, Read, Update, Delete) operations enable you to work with
data stored in MongoDB.

- :doc:`Read Operations </crud/read-operations>` find and return
documents stored in your database.
- :doc:`Write Operations </crud/write-operations>` insert, modify,
or delete documents in your database.

Some operations combine aspects of read and write operations. See our
guide on :doc:`compound operations </crud/compound-operations>`
to learn more about these hybrid methods.
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,10 @@ The output of the preceding code resembles the following:
{"food": "pizza", "color": "green"}

For more information about the ``Projections`` class, see our
:doc:`guide on the Projections builder </fundamentals/builders/projections/>`.
:doc:`guide on the Projections builder </builders/projections/>`.

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

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

For more information about the ``Sorts`` class, see our
:doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
:doc:`guide on the Sorts builder </builders/sort/>`.

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

For information on the ``Updates`` class, see our
:doc:`guide on the Updates builder </fundamentals/builders/updates/>`.
:doc:`guide on the Updates builder </builders/updates/>`.

For more information of the ``Filters`` class, see our
:doc:`guide on the Filters builder </fundamentals/builders/filters/>`.
:doc:`guide on the Filters builder </builders/filters/>`.

For more information about the ``findOneAndUpdate()`` method, see
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)>`__.
28 changes: 28 additions & 0 deletions source/crud/read-operations.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
===============
Read Operations
===============

.. meta::
:description: Learn about the commands for running read operations on MongoDB by using the {+driver-long+}.

.. toctree::
:caption: Read Operations

Retrieve Data </crud/read-operations/retrieve>
Data from a Cursor </crud/read-operations/cursor>
Sort Results </crud/read-operations/sort>
Skip Returned Results </crud/read-operations/skip>
Limit Returned Results </crud/read-operations/limit>
Specify Fields to Return </crud/read-operations/project>
Geospatial Data </crud/read-operations/geo>
Search Text </crud/read-operations/text>

- :doc:`/crud/read-operations/retrieve`
- :doc:`/crud/read-operations/cursor`
- :doc:`/crud/read-operations/change-streams`
- :doc:`/crud/read-operations/sort`
- :doc:`/crud/read-operations/skip`
- :doc:`/crud/read-operations/limit`
- :doc:`/crud/read-operations/project`
- :doc:`/crud/read-operations/geo`
- :doc:`/crud/read-operations/text`
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ GeoJSON data to a ``2dsphere`` index. The following snippet creates a
collection.createIndex(Indexes.geo2dsphere("location.geo"));

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

.. guide resource

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

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

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

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

Query Parameters
~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -293,7 +293,7 @@ For more information about the ``$near`` operator, see
:manual:`the reference documentation for $near </reference/operator/query/near/#mongodb-query-op.-near>`.

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

Query Within a Range
~~~~~~~~~~~~~~~~~~~~
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ to reach the specified limit, it can return a smaller number.
If you use ``limit()`` with the ``skip()`` instance method, the skip applies
first and the limit only applies to the documents left over after
the skip. For more information about the ``skip()`` method, see our
:doc:`guide on Skipping Returned Documents </fundamentals/crud/read-operations/skip/>`.
:doc:`guide on Skipping Returned Documents </crud/read-operations/skip/>`.

The following examples demonstrate, respectively, how to insert data into
a collection, how to use ``limit()`` to restrict the number of returned documents,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ To perform a find operation, call the ``find()`` method on an instance
of a ``MongoCollection``. This method searches a collection for documents that
match the query filter you provide. For more information about how to
specify a query, see our :doc:`Specify a Query
</fundamentals/crud/query-document>` guide.
</crud/query-document>` guide.

Example
~~~~~~~
Expand All @@ -71,7 +71,7 @@ To address this scenario, the owner finds orders to match the criteria:
:end-before: end findExample

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

The following shows the output of the preceding query:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ builder class. While it is possible to specify sort criteria using any class
that implements the ``Bson`` interface, we recommend that you specify sort
criteria through the ``Sorts`` builder. For more information about the ``Sorts``
builder class, see our
:doc:`guide on the Sorts builder </fundamentals/builders/sort/>`.
:doc:`guide on the Sorts builder </builders/sort/>`.

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

#. Creates a text index for your
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Text Search
Use the ``Filters.text()`` method to specify a text search.

The ``Filters.text()`` method uses the :doc:`Filters builder
</fundamentals/builders/filters>` to define a query filter specifying
</builders/filters>` to define a query filter specifying
what to search for during the text search. The query filter is
represented by a :ref:`BSON <bson>` instance. Pass the query filter to the
``find()`` method to run a text search.
Expand Down
23 changes: 23 additions & 0 deletions source/crud/write-operations.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
================
Write Operations
================

.. meta::
:description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}.

.. toctree::
:caption: Write Operations

Insert </crud/write-operations/insert>
Delete </crud/write-operations/delete>
Modify </crud/write-operations/modify>
Update Array Elements </crud/write-operations/embedded-arrays>
Upsert </crud/write-operations/upsert>
Bulk Operations </crud/write-operations/bulk>

- :doc:`/crud/write-operations/insert`
- :doc:`/crud/write-operations/delete`
- :doc:`/crud/write-operations/modify`
- :doc:`/crud/write-operations/embedded-arrays`
- :doc:`/crud/write-operations/upsert`
- :doc:`/crud/write-operations/bulk`
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The examples on this page use the ``findOneAndUpdate()`` method of the
example uses an instance of the ``FindOneAndUpdateOptions`` class to
have MongoDB retrieve the document after the update occurs. For
more information on the ``findOneAndUpdate()`` method, see our
:doc:`Compound Operations guide </fundamentals/crud/compound-operations/>`.
:doc:`Compound Operations guide </crud/compound-operations/>`.

Specifying an Update
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ methods.
The following sections focus on ``insertOne()`` and
``insertMany()``. For information on how to use the ``bulkWrite()``
method, see our
:doc:`guide on Bulk Operations </fundamentals/crud/write-operations/bulk/>`.
:doc:`guide on Bulk Operations </crud/write-operations/bulk/>`.

A Note About ``_id``
--------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ The following shows the updated documents in the ``paint_inventory`` collection:

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

Expand Down Expand Up @@ -245,7 +245,7 @@ shown in the following code:

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

Expand Down
25 changes: 25 additions & 0 deletions source/data-formats.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
============
Data Formats
============

.. meta::
:description: Learn how to convert between MongoDB and Java data formats by using the {+driver-long+}.

.. toctree::
:caption: Data Formats

BSON </data-formats/document-data-format-bson>
Extended JSON </data-formats/document-data-format-extended-json>
Documents </data-formats/documents>
POJOs </data-formats/document-data-format-pojo>
Records </data-formats/document-data-format-record>
POJO Customization </data-formats/pojo-customization>
Codecs </data-formats/codecs>

- :doc:`/data-formats/document-data-format-bson`
- :doc:`/data-formats/document-data-format-extended-json`
- :doc:`/data-formats/documents`
- :doc:`/data-formats/document-data-format-pojo`
- :doc:`/data-formats/document-data-format-record`
- :doc:`/data-formats/pojo-customization`
- :doc:`/data-formats/codecs`
31 changes: 0 additions & 31 deletions source/fundamentals.txt

This file was deleted.

Loading
Loading