diff --git a/config/redirects b/config/redirects index cb2697e3e..dffea446a 100644 --- a/config/redirects +++ b/config/redirects @@ -1,19 +1,19 @@ define: prefix docs/drivers/java/sync define: base https://www.mongodb.com/${prefix} -define: versions v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v5.0 v5.1 v5.2 v5.3 master +define: versions v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v5.0 v5.1 v5.2 v5.3 v5.4 master -symlink: current -> v5.3 +symlink: current -> v5.4 symlink: upcoming -> master raw: ${prefix}/ -> ${base}/current/ raw: ${prefix}/master -> ${base}/upcoming/ [*-v5.2]: ${prefix}/${version}/fundamentals/versioned-api/ -> ${base}/${version}/fundamentals/stable-api/ -[*-v4.6]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/fundamentals/crud/read-operations/retrieve/ [*-master]: ${prefix}/${version}/fundamentals/csfle/ -> ${base}/${version}/fundamentals/encrypt-fields/ [*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/change-a-document/ -> ${base}/${version}/fundamentals/crud/write-operations/modify/ -[*-v4.10]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/ -[*-v4.8]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/ + +# TOC evolution redirects + [v5.0-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/ [v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/query-documents/ [v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/query-documents/find/ diff --git a/snooty.toml b/snooty.toml index 34305fdbd..0ce4c77b3 100644 --- a/snooty.toml +++ b/snooty.toml @@ -17,7 +17,7 @@ toc_landing_pages = [ "/logging-monitoring", "/api-documentation", "/security", - "/security/auth" + "/security/auth", ] sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" @@ -26,7 +26,7 @@ sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" driver = "java" driver-long = "MongoDB Java Driver" driver-short = "Java driver" -version = "5.3" +version = "5.4" full-version = "{+version+}.0" mdb-server = "MongoDB Server" package-name-org = "mongodb-org" diff --git a/source/connection/connection-troubleshooting.txt b/source/connection/connection-troubleshooting.txt index 5aee84cb4..ae2d905eb 100644 --- a/source/connection/connection-troubleshooting.txt +++ b/source/connection/connection-troubleshooting.txt @@ -250,7 +250,7 @@ against the connected secondary node if you set the read preference to You can also specify the ``serverSelectionTimeoutMS`` connection option to adjust the amount of time in which the driver must select a server. To -learn more, see the :ref:`java-connection-uri-options` guide. +learn more, see the :ref:`mcs-cluster-settings` guide. .. _java-miscellaneous-errors: diff --git a/source/connection/specify-connection-options.txt b/source/connection/specify-connection-options.txt index 624773a4c..73bdad749 100644 --- a/source/connection/specify-connection-options.txt +++ b/source/connection/specify-connection-options.txt @@ -63,4 +63,4 @@ You can learn how to using logging and monitoring with the {+driver-short+} in the :ref:`Logging and Monitoring section `, which includes the following pages: -.. include:: /includes/logging-monitoring/logging-monitoring-pages.rst \ No newline at end of file +.. include:: /includes/logging-monitoring/logging-monitoring-pages.rst diff --git a/source/connection/specify-connection-options/security-connection-options.txt b/source/connection/specify-connection-options/security-connection-options.txt deleted file mode 100644 index 22af0fdb9..000000000 --- a/source/connection/specify-connection-options/security-connection-options.txt +++ /dev/null @@ -1,21 +0,0 @@ -.. _security-connection-settings: - -============================ -Connection Security Settings -============================ - -.. facet:: - :name: genre - :values: reference - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: singlecol - -MongoDB supports many options for securing your data before and during -transportation. For information about security options, see our :ref:`Security -section `, which includes the following: - -.. include:: /includes/security/security-pages.rst \ No newline at end of file diff --git a/source/crud/query-documents/find.txt b/source/crud/query-documents/find.txt index b86ca6871..96d4238bf 100644 --- a/source/crud/query-documents/find.txt +++ b/source/crud/query-documents/find.txt @@ -56,7 +56,8 @@ retrieve. Call the ``find()`` method on an instance of a ``MongoCollection`` to filter for documents that match the provided query. For more information about how to -specify a query, see our :doc:`Specify a Query ` guide. +specify a query, see our :ref:`java-query` guide. + You can then use methods such as ``forEach()`` or ``cursor()`` to retrieve matching documents. For more information, see the `FindIterable <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/FindIterable.html>`__ diff --git a/source/includes/crud/example-intro.rst b/source/includes/crud/example-intro.rst index 653f8277b..4cb388032 100644 --- a/source/includes/crud/example-intro.rst +++ b/source/includes/crud/example-intro.rst @@ -1,10 +1,10 @@ .. note:: Example Setup - This example connects to an instance of MongoDB by using a connection URI. To learn - more about connecting to your MongoDB instance, see the :ref:`connection guide - `. This example also uses the ``movies`` collection in the - ``sample_mflix`` database included in the :atlas:`Atlas sample datasets - `. You can load them into - your database on the free tier of MongoDB Atlas by following the :atlas:`Get - Started with Atlas Guide - `. + This example connects to an instance of MongoDB by using a + connection URI. To learn more about connecting to your MongoDB + instance, see the :ref:`java-connect-to-mongodb` guide. This example + also uses the ``movies`` collection in the ``sample_mflix`` database + included in the :atlas:`Atlas sample datasets `. You + can load them into your database on the free tier of MongoDB Atlas + by following the :atlas:`Get Started with Atlas Guide + `. diff --git a/source/includes/language-compatibility-table-java.rst b/source/includes/language-compatibility-table-java.rst index 46119cc07..7118145c5 100644 --- a/source/includes/language-compatibility-table-java.rst +++ b/source/includes/language-compatibility-table-java.rst @@ -12,7 +12,7 @@ - Java 6 - Java 5 - * - 4.11 to 5.3 + * - 4.11 to 5.4 - ✓ - ✓ - ✓ @@ -57,4 +57,5 @@ - ✓ - -.. [#virtual-threads-note] This driver version is not compatible with virtual threads. \ No newline at end of file +.. [#virtual-threads-note] This driver version is not compatible with + virtual threads. diff --git a/source/includes/mongodb-compatibility-table-java.rst b/source/includes/mongodb-compatibility-table-java.rst index f684011e2..503ce6cc7 100644 --- a/source/includes/mongodb-compatibility-table-java.rst +++ b/source/includes/mongodb-compatibility-table-java.rst @@ -14,7 +14,7 @@ - MongoDB 4.0 - MongoDB 3.6 - * - 5.2 to 5.3 + * - 5.2 to 5.4 - ✓ - ✓ - ✓ diff --git a/source/includes/security/security-pages.rst b/source/includes/security/security-pages.rst index e0e9116f1..2325461f5 100644 --- a/source/includes/security/security-pages.rst +++ b/source/includes/security/security-pages.rst @@ -2,4 +2,4 @@ - :ref:`In-Use Encryption ` - :ref:`TLS/SSL ` - :ref:`SOCKS5 Proxy ` -- :ref:`Validate Driver Artifact Signatures ` \ No newline at end of file +- :ref:`Validate Driver Artifact Signatures ` diff --git a/source/index.txt b/source/index.txt index b266d7c95..74724e476 100644 --- a/source/index.txt +++ b/source/index.txt @@ -27,7 +27,7 @@ MongoDB Java Driver Data Formats Indexes Run a Command - Atlas Search + Atlas Search Atlas Vector Search Logging and Monitoring Security diff --git a/source/logging-monitoring/change-streams.txt b/source/logging-monitoring/change-streams.txt index 9f245d497..d84b41f49 100644 --- a/source/logging-monitoring/change-streams.txt +++ b/source/logging-monitoring/change-streams.txt @@ -1,6 +1,5 @@ .. _java-fundamentals-change-streams: .. _retrieve-watch: -.. _java-usage-watch: =================== Open Change Streams @@ -109,12 +108,12 @@ You can call ``forEach()`` on the ``ChangeStreamIterable`` to handle events as they occur, or you can use the ``iterator()`` method which returns a ``MongoChangeStreamCursor`` instance that you can use to traverse the results. -You can call the following methods on the ``MongoChangeStreamCursor`: +You can call the following methods on a ``MongoChangeStreamCursor`` instance: - - ``hasNext()``: checks if there are more results. - - ``next()`` returns the next document in the collection. - - ``tryNext()`` immediately returns either the next available element in the - change stream or ``null``. +- ``hasNext()``: Checks if there are more results +- ``next()``: Returns the next document in the collection +- ``tryNext()``: Immediately returns either the next available element in the + change stream or ``null`` .. important:: Iterating the Cursor Blocks the Current Thread @@ -513,4 +512,5 @@ Server Manual Entries - :manual:`Change Streams ` - :manual:`Change Events ` - :manual:`Aggregation Pipeline ` -- :manual:`Aggregation Stages ` \ No newline at end of file +- :manual:`Aggregation Stages + ` diff --git a/source/reference.txt b/source/reference.txt index 303f41879..03b761d03 100644 --- a/source/reference.txt +++ b/source/reference.txt @@ -11,6 +11,5 @@ Reference Release Notes Compatibility - Third-Party Integrations Upgrade - Migrate from the Legacy API \ No newline at end of file + Migrate from the Legacy API diff --git a/source/references/whats-new.txt b/source/references/whats-new.txt index 7af6dc3f2..b65f7f8b9 100644 --- a/source/references/whats-new.txt +++ b/source/references/whats-new.txt @@ -52,6 +52,10 @@ and features: the :ref:`java-oidc-kubernetes` section of the OIDC (Workload Identity Federation) guide + .. replacement:: atlas-query-operators + + the :ref:`java-atlas-search` guide + .. _java-version-5.3: What's New in 5.3 @@ -132,6 +136,12 @@ and features: :ref:`java-atlas-vector-search` in the Aggregates Builders guide + .. replacement:: csot-link + + the `MongoClientSettings.Builder.timeout() + <{+core-api+}/com/mongodb/MongoClientSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__ + API documentation + .. _java-version-5.1.3: What's New in 5.1.3 diff --git a/source/security/socks.txt b/source/security/socks.txt index bbbdfc8a7..134949341 100644 --- a/source/security/socks.txt +++ b/source/security/socks.txt @@ -29,8 +29,8 @@ SOCKS5 Proxy Settings The proxy settings specify the SOCKS5 proxy server address and your authentication credentials. You can specify your settings in an instance of -:ref:`MongoClientSettings ` or in your :ref:`connection -string `. +`MongoClientSettings <{+api+}/apidocs/mongodb-driver-core/com/mongodb/MongoClientSettings.html>`__ +or in your :ref:`connection string `. .. important::