From 5eff431822404807a1422ce5179dab2f5bbc4f61 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> Date: Tue, 11 Feb 2025 13:23:06 -0500 Subject: [PATCH 1/7] [Java Sync] P1 - Shift Java ToC (#615) --- config/redirects | 36 +++++++++++++++++++ snooty.toml | 4 +-- source/atlas-search.txt | 21 +++++++++++ source/atlas-vector-search.txt | 22 ++++++++++++ source/{usage-examples => }/command.txt | 0 source/{fundamentals => }/connection.txt | 13 ++++--- .../{fundamentals => }/connection/connect.txt | 0 .../connection/connection-options.txt | 2 +- source/{fundamentals => }/connection/jndi.txt | 0 .../connection/mongoclientsettings.txt | 0 .../connection/network-compression.txt | 0 .../{fundamentals => }/connection/socks.txt | 0 source/crud.txt | 25 +++++++++++++ .../crud/compound-operations.txt | 12 ++++--- .../crud/query-document.txt | 0 source/crud/read-operations.txt | 29 +++++++++++++++ .../crud/read-operations/cursor.txt | 0 .../crud/read-operations/geo.txt | 8 ++--- .../crud/read-operations/limit.txt | 2 +- .../crud/read-operations/project.txt | 0 .../crud/read-operations/retrieve.txt | 4 +-- .../crud/read-operations/skip.txt | 0 .../crud/read-operations/sort.txt | 8 ++--- .../crud/read-operations/text.txt | 2 +- source/crud/write-operations.txt | 25 +++++++++++++ .../crud/write-operations/bulk.txt | 0 .../crud/write-operations/delete.txt | 0 .../crud/write-operations/embedded-arrays.txt | 2 +- .../crud/write-operations/insert.txt | 2 +- .../crud/write-operations/modify.txt | 4 +-- .../crud/write-operations/upsert.txt | 0 source/data-formats.txt | 25 +++++++++++++ .../data-formats/codecs.txt | 0 .../document-data-format-bson.txt | 0 .../document-data-format-extended-json.txt | 0 .../document-data-format-pojo.txt | 0 .../document-data-format-record.txt | 0 .../data-formats/documents.txt | 0 .../data-formats/pojo-customization.txt | 0 source/fundamentals.txt | 31 ---------------- source/fundamentals/builders.txt | 12 +++---- source/fundamentals/builders/aggregates.txt | 6 +++- source/fundamentals/builders/filters.txt | 2 +- source/fundamentals/builders/indexes.txt | 2 +- source/fundamentals/builders/projections.txt | 2 +- source/fundamentals/builders/sort.txt | 6 ++-- source/fundamentals/crud.txt | 27 -------------- source/fundamentals/crud/read-operations.txt | 29 --------------- source/fundamentals/crud/write-operations.txt | 23 ------------ source/fundamentals/data-formats.txt | 25 ------------- source/fundamentals/gridfs.txt | 4 +-- source/fundamentals/time-series.txt | 2 +- source/index.txt | 18 ++++++---- source/{fundamentals => }/indexes.txt | 0 source/logging-monitoring.txt | 14 ++++++++ .../change-streams.txt | 0 .../logging.txt | 2 +- .../monitoring.txt | 2 +- source/quick-start.txt | 4 +-- source/security.txt | 15 ++++++++ source/{fundamentals => security}/auth.txt | 2 +- .../encrypt-fields.txt | 0 .../connection => security}/tls.txt | 0 source/security/validate-signatures.txt | 3 ++ source/usage-examples.txt | 2 +- source/usage-examples/find.txt | 6 ++-- source/usage-examples/findOne.txt | 6 ++-- source/usage-examples/updateMany.txt | 2 +- source/usage-examples/updateOne.txt | 2 +- source/versioning.txt | 15 ++++++++ source/{ => versioning}/compatibility.txt | 0 source/{ => versioning}/legacy.txt | 0 source/{ => versioning}/upgrade.txt | 0 source/{ => versioning}/whats-new.txt | 0 74 files changed, 307 insertions(+), 203 deletions(-) create mode 100644 source/atlas-search.txt create mode 100644 source/atlas-vector-search.txt rename source/{usage-examples => }/command.txt (100%) rename source/{fundamentals => }/connection.txt (73%) rename source/{fundamentals => }/connection/connect.txt (100%) rename source/{fundamentals => }/connection/connection-options.txt (99%) rename source/{fundamentals => }/connection/jndi.txt (100%) rename source/{fundamentals => }/connection/mongoclientsettings.txt (100%) rename source/{fundamentals => }/connection/network-compression.txt (100%) rename source/{fundamentals => }/connection/socks.txt (100%) create mode 100644 source/crud.txt rename source/{fundamentals => }/crud/compound-operations.txt (96%) rename source/{fundamentals => }/crud/query-document.txt (100%) create mode 100644 source/crud/read-operations.txt rename source/{fundamentals => }/crud/read-operations/cursor.txt (100%) rename source/{fundamentals => }/crud/read-operations/geo.txt (97%) rename source/{fundamentals => }/crud/read-operations/limit.txt (98%) rename source/{fundamentals => }/crud/read-operations/project.txt (100%) rename source/{fundamentals => }/crud/read-operations/retrieve.txt (98%) rename source/{fundamentals => }/crud/read-operations/skip.txt (100%) rename source/{fundamentals => }/crud/read-operations/sort.txt (98%) rename source/{fundamentals => }/crud/read-operations/text.txt (99%) create mode 100644 source/crud/write-operations.txt rename source/{fundamentals => }/crud/write-operations/bulk.txt (100%) rename source/{fundamentals => }/crud/write-operations/delete.txt (100%) rename source/{fundamentals => }/crud/write-operations/embedded-arrays.txt (98%) rename source/{fundamentals => }/crud/write-operations/insert.txt (98%) rename source/{fundamentals => }/crud/write-operations/modify.txt (97%) rename source/{fundamentals => }/crud/write-operations/upsert.txt (100%) create mode 100644 source/data-formats.txt rename source/{fundamentals => }/data-formats/codecs.txt (100%) rename source/{fundamentals => }/data-formats/document-data-format-bson.txt (100%) rename source/{fundamentals => }/data-formats/document-data-format-extended-json.txt (100%) rename source/{fundamentals => }/data-formats/document-data-format-pojo.txt (100%) rename source/{fundamentals => }/data-formats/document-data-format-record.txt (100%) rename source/{fundamentals => }/data-formats/documents.txt (100%) rename source/{fundamentals => }/data-formats/pojo-customization.txt (100%) delete mode 100644 source/fundamentals.txt delete mode 100644 source/fundamentals/crud.txt delete mode 100644 source/fundamentals/crud/read-operations.txt delete mode 100644 source/fundamentals/crud/write-operations.txt delete mode 100644 source/fundamentals/data-formats.txt rename source/{fundamentals => }/indexes.txt (100%) create mode 100644 source/logging-monitoring.txt rename source/{fundamentals/crud/read-operations => logging-monitoring}/change-streams.txt (100%) rename source/{fundamentals => logging-monitoring}/logging.txt (99%) rename source/{fundamentals => logging-monitoring}/monitoring.txt (99%) create mode 100644 source/security.txt rename source/{fundamentals => security}/auth.txt (99%) rename source/{fundamentals => security}/encrypt-fields.txt (100%) rename source/{fundamentals/connection => security}/tls.txt (100%) create mode 100644 source/security/validate-signatures.txt create mode 100644 source/versioning.txt rename source/{ => versioning}/compatibility.txt (100%) rename source/{ => versioning}/legacy.txt (100%) rename source/{ => versioning}/upgrade.txt (100%) rename source/{ => versioning}/whats-new.txt (100%) diff --git a/config/redirects b/config/redirects index 9cda1d0f0..d5b62edd6 100644 --- a/config/redirects +++ b/config/redirects @@ -11,3 +11,39 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-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}/ +[*-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/ +[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/ +[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/ +[*-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/ +[*-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ +[*-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ +[*-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ +[*-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ +[*-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ +[*-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ +[*-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ +[*-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/ +[*-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/ +[*-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/ diff --git a/snooty.toml b/snooty.toml index f43aa3845..054a31f90 100644 --- a/snooty.toml +++ b/snooty.toml @@ -7,8 +7,8 @@ intersphinx = [ ] toc_landing_pages = [ - "/fundamentals/connection", - "/fundamentals/crud", + "/connection", + "/crud", "/fundamentals/builders", "/fundamentals/aggregation", "/usage-examples", diff --git a/source/atlas-search.txt b/source/atlas-search.txt new file mode 100644 index 000000000..a21049881 --- /dev/null +++ b/source/atlas-search.txt @@ -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 ` in the MongoDB Atlas documentation. \ No newline at end of file diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt new file mode 100644 index 000000000..7cd53247e --- /dev/null +++ b/source/atlas-vector-search.txt @@ -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 ` +in the MongoDB Atlas documentation. \ No newline at end of file diff --git a/source/usage-examples/command.txt b/source/command.txt similarity index 100% rename from source/usage-examples/command.txt rename to source/command.txt diff --git a/source/fundamentals/connection.txt b/source/connection.txt similarity index 73% rename from source/fundamentals/connection.txt rename to source/connection.txt index 63969b0f1..ef4975990 100644 --- a/source/fundamentals/connection.txt +++ b/source/connection.txt @@ -6,13 +6,12 @@ Connection Guide .. toctree:: - Connect to MongoDB - Connection Options - MongoClient Settings - Network Compression - TLS/SSL - SOCKS5 Proxy - JNDI Datasource + Connect to MongoDB + Connection Options + MongoClient Settings + Network Compression + SOCKS5 Proxy + JNDI Datasource AWS Lambda .. contents:: On this page diff --git a/source/fundamentals/connection/connect.txt b/source/connection/connect.txt similarity index 100% rename from source/fundamentals/connection/connect.txt rename to source/connection/connect.txt diff --git a/source/fundamentals/connection/connection-options.txt b/source/connection/connection-options.txt similarity index 99% rename from source/fundamentals/connection/connection-options.txt rename to source/connection/connection-options.txt index e022b530f..5ed031c49 100644 --- a/source/fundamentals/connection/connection-options.txt +++ b/source/connection/connection-options.txt @@ -194,7 +194,7 @@ parameters of the connection URI to specify the behavior of the client. * - **authMechanism** - string - Specifies the :doc:`authentication mechanism - ` that the driver uses if a credential + ` that the driver uses if a credential was supplied. | **Default**: By default, the client picks the most secure diff --git a/source/fundamentals/connection/jndi.txt b/source/connection/jndi.txt similarity index 100% rename from source/fundamentals/connection/jndi.txt rename to source/connection/jndi.txt diff --git a/source/fundamentals/connection/mongoclientsettings.txt b/source/connection/mongoclientsettings.txt similarity index 100% rename from source/fundamentals/connection/mongoclientsettings.txt rename to source/connection/mongoclientsettings.txt diff --git a/source/fundamentals/connection/network-compression.txt b/source/connection/network-compression.txt similarity index 100% rename from source/fundamentals/connection/network-compression.txt rename to source/connection/network-compression.txt diff --git a/source/fundamentals/connection/socks.txt b/source/connection/socks.txt similarity index 100% rename from source/fundamentals/connection/socks.txt rename to source/connection/socks.txt diff --git a/source/crud.txt b/source/crud.txt new file mode 100644 index 000000000..55dded691 --- /dev/null +++ b/source/crud.txt @@ -0,0 +1,25 @@ +.. _java-crud-operations: + +=============== +CRUD Operations +=============== + +.. toctree:: + :caption: CRUD Operations + + Read + Write + Query + Compound Operations + +CRUD (Create, Read, Update, Delete) operations enable you to work with +data stored in MongoDB. + +- :ref:`Read Operations ` find and return + documents stored in your database. +- :ref:`Write Operations ` insert, modify, + or delete documents in your database. + +Some operations combine aspects of read and write operations. See our +guide on :ref:`compound operations ` +to learn more about these hybrid methods. diff --git a/source/fundamentals/crud/compound-operations.txt b/source/crud/compound-operations.txt similarity index 96% rename from source/fundamentals/crud/compound-operations.txt rename to source/crud/compound-operations.txt index 9cc4277fc..d8c7a0b86 100644 --- a/source/fundamentals/crud/compound-operations.txt +++ b/source/crud/compound-operations.txt @@ -1,3 +1,5 @@ +.. _java-compound-operations: + =================== Compound Operations =================== @@ -101,10 +103,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 `. +:doc:`guide on the Projections builder `. For more information about the upsert operation, see our -:doc:`guide on upserts `. +:doc:`guide on upserts `. For more information about the methods and classes mentioned in this section, see the following API Documentation: @@ -187,7 +189,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 `. +:doc:`guide on the Sorts builder `. For more information about the methods and classes mentioned in this section, see the following API Documentation: @@ -318,10 +320,10 @@ instance: for the duration of your compound operation. For information on the ``Updates`` class, see our -:doc:`guide on the Updates builder `. +:doc:`guide on the Updates builder `. For more information of the ``Filters`` class, see our -:doc:`guide on the Filters builder `. +:doc:`guide on the Filters builder `. 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)>`__. diff --git a/source/fundamentals/crud/query-document.txt b/source/crud/query-document.txt similarity index 100% rename from source/fundamentals/crud/query-document.txt rename to source/crud/query-document.txt diff --git a/source/crud/read-operations.txt b/source/crud/read-operations.txt new file mode 100644 index 000000000..1c9183ea0 --- /dev/null +++ b/source/crud/read-operations.txt @@ -0,0 +1,29 @@ +.. _java-read-operations: + +=============== +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 + Data from a Cursor + Sort Results + Skip Returned Results + Limit Returned Results + Specify Fields to Return + Geospatial Data + Search Text + +- :doc:`/crud/read-operations/retrieve` +- :doc:`/crud/read-operations/cursor` +- :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` diff --git a/source/fundamentals/crud/read-operations/cursor.txt b/source/crud/read-operations/cursor.txt similarity index 100% rename from source/fundamentals/crud/read-operations/cursor.txt rename to source/crud/read-operations/cursor.txt diff --git a/source/fundamentals/crud/read-operations/geo.txt b/source/crud/read-operations/geo.txt similarity index 97% rename from source/fundamentals/crud/read-operations/geo.txt rename to source/crud/read-operations/geo.txt index a0f5f400e..58f7e8e57 100644 --- a/source/fundamentals/crud/read-operations/geo.txt +++ b/source/crud/read-operations/geo.txt @@ -98,7 +98,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 `. +:doc:`guide on the Indexes builder `. .. guide resource @@ -131,7 +131,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 `. +:doc:`guide on the Indexes builder `. For more information about legacy coordinate pairs, see the :manual:`{+mdb-server+} manual page on legacy coordinate pairs `. @@ -173,7 +173,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 `. +:doc:`guide on the Filters builder `. Query Parameters ~~~~~~~~~~~~~~~~ @@ -258,7 +258,7 @@ For more information about the ``$near`` operator, see :manual:`the reference documentation for $near `. For more information about ``Filters``, -:doc:`see our guide on the Filters builder `. +:doc:`see our guide on the Filters builder `. Query Within a Range ~~~~~~~~~~~~~~~~~~~~ diff --git a/source/fundamentals/crud/read-operations/limit.txt b/source/crud/read-operations/limit.txt similarity index 98% rename from source/fundamentals/crud/read-operations/limit.txt rename to source/crud/read-operations/limit.txt index cac0b5f8f..49d384106 100644 --- a/source/fundamentals/crud/read-operations/limit.txt +++ b/source/crud/read-operations/limit.txt @@ -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 `. +:doc:`guide on Skipping Returned Documents `. The following examples demonstrate, respectively, how to insert data into a collection, how to use ``limit()`` to restrict the number of returned documents, diff --git a/source/fundamentals/crud/read-operations/project.txt b/source/crud/read-operations/project.txt similarity index 100% rename from source/fundamentals/crud/read-operations/project.txt rename to source/crud/read-operations/project.txt diff --git a/source/fundamentals/crud/read-operations/retrieve.txt b/source/crud/read-operations/retrieve.txt similarity index 98% rename from source/fundamentals/crud/read-operations/retrieve.txt rename to source/crud/read-operations/retrieve.txt index 806e60b91..02dba978d 100644 --- a/source/fundamentals/crud/read-operations/retrieve.txt +++ b/source/crud/read-operations/retrieve.txt @@ -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 -` guide. +` guide. Example ~~~~~~~ @@ -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 -` guide. +` guide. The following shows the output of the preceding query: diff --git a/source/fundamentals/crud/read-operations/skip.txt b/source/crud/read-operations/skip.txt similarity index 100% rename from source/fundamentals/crud/read-operations/skip.txt rename to source/crud/read-operations/skip.txt diff --git a/source/fundamentals/crud/read-operations/sort.txt b/source/crud/read-operations/sort.txt similarity index 98% rename from source/fundamentals/crud/read-operations/sort.txt rename to source/crud/read-operations/sort.txt index aa31654bb..b0cccdbad 100644 --- a/source/fundamentals/crud/read-operations/sort.txt +++ b/source/crud/read-operations/sort.txt @@ -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 `. +:doc:`guide on the Sorts builder `. For more information about the classes and interfaces in this section, see the following API Documentation: @@ -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 `. -The code example uses the :doc:`Filters `, -:doc:`Indexes `, and -:doc:`Projections ` builders. +The code example uses the :doc:`Filters `, +:doc:`Indexes `, and +:doc:`Projections ` builders. The code example performs the following actions: #. Creates a text index for your diff --git a/source/fundamentals/crud/read-operations/text.txt b/source/crud/read-operations/text.txt similarity index 99% rename from source/fundamentals/crud/read-operations/text.txt rename to source/crud/read-operations/text.txt index 8dc7b200b..3618366f7 100644 --- a/source/fundamentals/crud/read-operations/text.txt +++ b/source/crud/read-operations/text.txt @@ -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 -` to define a query filter specifying +` to define a query filter specifying what to search for during the text search. The query filter is represented by a :ref:`BSON ` instance. Pass the query filter to the ``find()`` method to run a text search. diff --git a/source/crud/write-operations.txt b/source/crud/write-operations.txt new file mode 100644 index 000000000..aa0b2d86a --- /dev/null +++ b/source/crud/write-operations.txt @@ -0,0 +1,25 @@ +.. _java-write-operations: + +================ +Write Operations +================ + +.. meta:: + :description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}. + +.. toctree:: + :caption: Write Operations + + Insert + Delete + Modify + Update Array Elements + Upsert + Bulk Operations + +- :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` diff --git a/source/fundamentals/crud/write-operations/bulk.txt b/source/crud/write-operations/bulk.txt similarity index 100% rename from source/fundamentals/crud/write-operations/bulk.txt rename to source/crud/write-operations/bulk.txt diff --git a/source/fundamentals/crud/write-operations/delete.txt b/source/crud/write-operations/delete.txt similarity index 100% rename from source/fundamentals/crud/write-operations/delete.txt rename to source/crud/write-operations/delete.txt diff --git a/source/fundamentals/crud/write-operations/embedded-arrays.txt b/source/crud/write-operations/embedded-arrays.txt similarity index 98% rename from source/fundamentals/crud/write-operations/embedded-arrays.txt rename to source/crud/write-operations/embedded-arrays.txt index bde25f636..0a9c2d921 100644 --- a/source/fundamentals/crud/write-operations/embedded-arrays.txt +++ b/source/crud/write-operations/embedded-arrays.txt @@ -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 `. +:doc:`Compound Operations guide `. Specifying an Update -------------------- diff --git a/source/fundamentals/crud/write-operations/insert.txt b/source/crud/write-operations/insert.txt similarity index 98% rename from source/fundamentals/crud/write-operations/insert.txt rename to source/crud/write-operations/insert.txt index 5bedc1340..39a4c8051 100644 --- a/source/fundamentals/crud/write-operations/insert.txt +++ b/source/crud/write-operations/insert.txt @@ -30,7 +30,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 `. +:doc:`guide on Bulk Operations `. A Note About ``_id`` -------------------- diff --git a/source/fundamentals/crud/write-operations/modify.txt b/source/crud/write-operations/modify.txt similarity index 97% rename from source/fundamentals/crud/write-operations/modify.txt rename to source/crud/write-operations/modify.txt index 42c4f6081..991066be2 100644 --- a/source/fundamentals/crud/write-operations/modify.txt +++ b/source/crud/write-operations/modify.txt @@ -118,7 +118,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 ` to +our :doc:`upsert guide ` to learn how to insert a new document instead of updating one if no documents match. @@ -194,7 +194,7 @@ The following shows the updated document: 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 ` to +our :doc:`upsert guide ` to learn how to insert a new document instead of replacing one if no documents match. diff --git a/source/fundamentals/crud/write-operations/upsert.txt b/source/crud/write-operations/upsert.txt similarity index 100% rename from source/fundamentals/crud/write-operations/upsert.txt rename to source/crud/write-operations/upsert.txt diff --git a/source/data-formats.txt b/source/data-formats.txt new file mode 100644 index 000000000..2ef94ed67 --- /dev/null +++ b/source/data-formats.txt @@ -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 + Extended JSON + Documents + POJOs + Records + POJO Customization + 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` diff --git a/source/fundamentals/data-formats/codecs.txt b/source/data-formats/codecs.txt similarity index 100% rename from source/fundamentals/data-formats/codecs.txt rename to source/data-formats/codecs.txt diff --git a/source/fundamentals/data-formats/document-data-format-bson.txt b/source/data-formats/document-data-format-bson.txt similarity index 100% rename from source/fundamentals/data-formats/document-data-format-bson.txt rename to source/data-formats/document-data-format-bson.txt diff --git a/source/fundamentals/data-formats/document-data-format-extended-json.txt b/source/data-formats/document-data-format-extended-json.txt similarity index 100% rename from source/fundamentals/data-formats/document-data-format-extended-json.txt rename to source/data-formats/document-data-format-extended-json.txt diff --git a/source/fundamentals/data-formats/document-data-format-pojo.txt b/source/data-formats/document-data-format-pojo.txt similarity index 100% rename from source/fundamentals/data-formats/document-data-format-pojo.txt rename to source/data-formats/document-data-format-pojo.txt diff --git a/source/fundamentals/data-formats/document-data-format-record.txt b/source/data-formats/document-data-format-record.txt similarity index 100% rename from source/fundamentals/data-formats/document-data-format-record.txt rename to source/data-formats/document-data-format-record.txt diff --git a/source/fundamentals/data-formats/documents.txt b/source/data-formats/documents.txt similarity index 100% rename from source/fundamentals/data-formats/documents.txt rename to source/data-formats/documents.txt diff --git a/source/fundamentals/data-formats/pojo-customization.txt b/source/data-formats/pojo-customization.txt similarity index 100% rename from source/fundamentals/data-formats/pojo-customization.txt rename to source/data-formats/pojo-customization.txt diff --git a/source/fundamentals.txt b/source/fundamentals.txt deleted file mode 100644 index 019c88bd7..000000000 --- a/source/fundamentals.txt +++ /dev/null @@ -1,31 +0,0 @@ -============ -Fundamentals -============ - -.. meta:: - :description: Learn how to use the (+driver-long+} to run commands on MongoDB. - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - Connection Guide - Authentication - Enterprise Authentication - Stable API - Databases & Collections - Data Formats - CRUD Operations - Builders - Aggregation - Aggregation Expressions - Indexes - Transactions - Collations - Logging - Monitoring - GridFS - In-Use Encryption - Time Series Collections - -.. include:: /includes/fundamentals-sections.rst diff --git a/source/fundamentals/builders.txt b/source/fundamentals/builders.txt index ee1e92425..1bcd498e3 100644 --- a/source/fundamentals/builders.txt +++ b/source/fundamentals/builders.txt @@ -8,12 +8,12 @@ Builders .. toctree:: - Aggregation - Filters - Indexes - Projection - Sort - Update + Aggregation + Filters + Indexes + Projection + Sort + Update .. contents:: On this page :local: diff --git a/source/fundamentals/builders/aggregates.txt b/source/fundamentals/builders/aggregates.txt index 4b9b2b58f..f0c8dd495 100644 --- a/source/fundamentals/builders/aggregates.txt +++ b/source/fundamentals/builders/aggregates.txt @@ -15,6 +15,10 @@ Aggregates Builders :depth: 2 :class: singlecol +.. toctree:: + + Atlas Vector Search + .. _aggregates-builders: Overview @@ -86,7 +90,7 @@ Project Use the ``project()`` method to create a :manual:`$project ` pipeline stage that project specified document fields. Field projection -in aggregation follows the same rules as :doc:`field projection in queries `. +in aggregation follows the same rules as :doc:`field projection in queries `. .. tip:: diff --git a/source/fundamentals/builders/filters.txt b/source/fundamentals/builders/filters.txt index 71ed5a209..2681e9150 100644 --- a/source/fundamentals/builders/filters.txt +++ b/source/fundamentals/builders/filters.txt @@ -20,7 +20,7 @@ In this guide, you can learn how to use **builders** to specify Builders are classes provided by the MongoDB Java driver that help you construct :ref:`BSON ` objects. To learn more, see our :doc:`guide -on builders `. +on builders `. Filters are the operations MongoDB uses to limit your results to what you want to see. diff --git a/source/fundamentals/builders/indexes.txt b/source/fundamentals/builders/indexes.txt index cf650829b..888b15f9a 100644 --- a/source/fundamentals/builders/indexes.txt +++ b/source/fundamentals/builders/indexes.txt @@ -16,7 +16,7 @@ Overview -------- In this guide, you can learn how to specify **indexes** using -:doc:`builders ` in the MongoDB Java driver. +:doc:`builders ` in the MongoDB Java driver. The ``Indexes`` builder provides helper methods for constructing the following types of indexes: diff --git a/source/fundamentals/builders/projections.txt b/source/fundamentals/builders/projections.txt index e4e321ca8..f11815add 100644 --- a/source/fundamentals/builders/projections.txt +++ b/source/fundamentals/builders/projections.txt @@ -16,7 +16,7 @@ Overview -------- In this guide, you can learn how to specify **projections** using -:doc:`builders ` in the MongoDB Java driver. +:doc:`builders ` in the MongoDB Java driver. MongoDB supports **field projection**, specifying which fields to include and exclude when returning results from a query. Projection in MongoDB follows some basic rules: diff --git a/source/fundamentals/builders/sort.txt b/source/fundamentals/builders/sort.txt index 59b1e9e97..f73f01b2e 100644 --- a/source/fundamentals/builders/sort.txt +++ b/source/fundamentals/builders/sort.txt @@ -32,14 +32,14 @@ examples of sort criteria are: Builders are classes provided by the MongoDB Java driver that help you construct :ref:`BSON ` objects. To learn more, see our :doc:`guide -on builders `. +on builders `. You should read this guide if you would like to use builders to specify sort criteria for your queries. If you want to learn the fundamentals of sorting in the MongoDB Java driver, consider reading our -:doc:`guide on sorting `. +:doc:`guide on sorting `. .. _sorts-builders-sort-sample: @@ -63,7 +63,7 @@ criteria operators supported by MongoDB. These methods return a ``Bson`` object that you can pass to the ``sort()`` method of a ``FindIterable`` instance or to ``Aggregates.sort()``. If you want to learn more about the ``Aggregates`` class, see our -:doc:`guide on the Aggregates builder `. +:doc:`guide on the Aggregates builder `. For more information about the classes and interfaces in this section, see the following API Documentation: diff --git a/source/fundamentals/crud.txt b/source/fundamentals/crud.txt deleted file mode 100644 index 3417cd5e0..000000000 --- a/source/fundamentals/crud.txt +++ /dev/null @@ -1,27 +0,0 @@ -.. _java-crud-operations: - -=============== -CRUD Operations -=============== - -.. default-domain:: mongodb - -.. toctree:: - :caption: CRUD Operations - - Read - Write - Query - Compound Operations - -CRUD (Create, Read, Update, Delete) operations enable you to work with -data stored in MongoDB. - -- :doc:`Read Operations ` find and return - documents stored in your database. -- :doc:`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 ` -to learn more about these hybrid methods. diff --git a/source/fundamentals/crud/read-operations.txt b/source/fundamentals/crud/read-operations.txt deleted file mode 100644 index 0eb147951..000000000 --- a/source/fundamentals/crud/read-operations.txt +++ /dev/null @@ -1,29 +0,0 @@ -=============== -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 - Data from a Cursor - Open Change Streams - Sort Results - Skip Returned Results - Limit Returned Results - Specify Fields to Return - Geospatial Data - Search Text - -- :doc:`/fundamentals/crud/read-operations/retrieve` -- :doc:`/fundamentals/crud/read-operations/cursor` -- :doc:`/fundamentals/crud/read-operations/change-streams` -- :doc:`/fundamentals/crud/read-operations/sort` -- :doc:`/fundamentals/crud/read-operations/skip` -- :doc:`/fundamentals/crud/read-operations/limit` -- :doc:`/fundamentals/crud/read-operations/project` -- :doc:`/fundamentals/crud/read-operations/geo` -- :doc:`/fundamentals/crud/read-operations/text` diff --git a/source/fundamentals/crud/write-operations.txt b/source/fundamentals/crud/write-operations.txt deleted file mode 100644 index fd4e57d6a..000000000 --- a/source/fundamentals/crud/write-operations.txt +++ /dev/null @@ -1,23 +0,0 @@ -================ -Write Operations -================ - -.. meta:: - :description: Learn about the commands for running MongoDB write operations by using the {+driver-long+}. - -.. toctree:: - :caption: Write Operations - - Insert - Delete - Modify - Update Array Elements - Upsert - Bulk Operations - -- :doc:`/fundamentals/crud/write-operations/insert` -- :doc:`/fundamentals/crud/write-operations/delete` -- :doc:`/fundamentals/crud/write-operations/modify` -- :doc:`/fundamentals/crud/write-operations/embedded-arrays` -- :doc:`/fundamentals/crud/write-operations/upsert` -- :doc:`/fundamentals/crud/write-operations/bulk` diff --git a/source/fundamentals/data-formats.txt b/source/fundamentals/data-formats.txt deleted file mode 100644 index a26dfd099..000000000 --- a/source/fundamentals/data-formats.txt +++ /dev/null @@ -1,25 +0,0 @@ -============ -Data Formats -============ - -.. meta:: - :description: Learn how to convert between MongoDB and Java data formats by using the {+driver-long+}. - -.. toctree:: - :caption: Data Formats - - BSON - Extended JSON - Documents - POJOs - Records - POJO Customization - Codecs - -- :doc:`/fundamentals/data-formats/document-data-format-bson` -- :doc:`/fundamentals/data-formats/document-data-format-extended-json` -- :doc:`/fundamentals/data-formats/documents` -- :doc:`/fundamentals/data-formats/document-data-format-pojo` -- :doc:`/fundamentals/data-formats/document-data-format-record` -- :doc:`/fundamentals/data-formats/pojo-customization` -- :doc:`/fundamentals/data-formats/codecs` diff --git a/source/fundamentals/gridfs.txt b/source/fundamentals/gridfs.txt index e3ba3d562..7ddf890a7 100644 --- a/source/fundamentals/gridfs.txt +++ b/source/fundamentals/gridfs.txt @@ -257,8 +257,8 @@ see the following resources: - `GridFSFindIterable <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/gridfs/GridFSFindIterable.html>`__ API Documentation - `GridFSBucket.find() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/gridfs/GridFSBucket.html#find(org.bson.conversions.Bson)>`__ API Documentation -- :doc:`Sort Results ` -- :doc:`Limit the Number of Returned Results ` +- :doc:`Sort Results ` +- :doc:`Limit the Number of Returned Results ` .. _gridfs-download-files: diff --git a/source/fundamentals/time-series.txt b/source/fundamentals/time-series.txt index fb963c114..dc485ba37 100644 --- a/source/fundamentals/time-series.txt +++ b/source/fundamentals/time-series.txt @@ -95,7 +95,7 @@ Query a Time Series Collection ------------------------------ To query in a time series collection, use the same conventions as you -would for :doc:`retrieving ` +would for :doc:`retrieving ` and :ref:`aggregating data `. .. note:: Window Functions diff --git a/source/index.txt b/source/index.txt index 1879a6042..bbf40f307 100644 --- a/source/index.txt +++ b/source/index.txt @@ -17,14 +17,18 @@ MongoDB Java Driver :titlesonly: :maxdepth: 1 - Quick Start - Quick Reference - What's New - Usage Examples - Fundamentals + Getting Started + Connect + CRUD Operations + Data Formats + Indexes + Run a Command + Atlas Search + Atlas Vector Search + Logging and Monitoring + Security + Versioning API Documentation - FAQ - Connection Troubleshooting Issues & Help Driver Integrations Compatibility diff --git a/source/fundamentals/indexes.txt b/source/indexes.txt similarity index 100% rename from source/fundamentals/indexes.txt rename to source/indexes.txt diff --git a/source/logging-monitoring.txt b/source/logging-monitoring.txt new file mode 100644 index 000000000..af9de0f1b --- /dev/null +++ b/source/logging-monitoring.txt @@ -0,0 +1,14 @@ +====================== +Logging and Monitoring +====================== + +.. meta:: + :description: Learn how to use the {+driver-long+} logging and monitoring tools. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Logging + Monitoring + Change Streams \ No newline at end of file diff --git a/source/fundamentals/crud/read-operations/change-streams.txt b/source/logging-monitoring/change-streams.txt similarity index 100% rename from source/fundamentals/crud/read-operations/change-streams.txt rename to source/logging-monitoring/change-streams.txt diff --git a/source/fundamentals/logging.txt b/source/logging-monitoring/logging.txt similarity index 99% rename from source/fundamentals/logging.txt rename to source/logging-monitoring/logging.txt index 3b11c9bc4..d7dc66097 100644 --- a/source/fundamentals/logging.txt +++ b/source/logging-monitoring/logging.txt @@ -38,7 +38,7 @@ You will learn how to: This guide shows how to record events in the driver. If you would like to learn how to use information about the activity of the driver in code, consider reading our -:doc:`guide on monitoring `. +:doc:`guide on monitoring `. Set Up a Logger --------------- diff --git a/source/fundamentals/monitoring.txt b/source/logging-monitoring/monitoring.txt similarity index 99% rename from source/fundamentals/monitoring.txt rename to source/logging-monitoring/monitoring.txt index 33d17e71e..2d784bbbd 100644 --- a/source/fundamentals/monitoring.txt +++ b/source/logging-monitoring/monitoring.txt @@ -37,7 +37,7 @@ In this guide you will learn how to perform these tasks: This guide shows how to use information about the activity of the driver in code. If you would like to learn how to record events in the driver, -consider reading our :doc:`guide on logging `. +consider reading our :doc:`guide on logging `. .. _monitoring-monitor-events: diff --git a/source/quick-start.txt b/source/quick-start.txt index 1aeb7ab4e..ee95b28b2 100644 --- a/source/quick-start.txt +++ b/source/quick-start.txt @@ -127,8 +127,8 @@ the password you created for your user that has **atlasAdmin** permissions: See the following links For more information about using POJOs to store and retrieve data: -- :doc:`Guide on using POJOs to store and retrieve data` -- :doc:`Guide on custom serialization of POJOs ` +- :doc:`Guide on using POJOs to store and retrieve data` +- :doc:`Guide on custom serialization of POJOs ` Next steps ---------- diff --git a/source/security.txt b/source/security.txt new file mode 100644 index 000000000..f4bb3b42c --- /dev/null +++ b/source/security.txt @@ -0,0 +1,15 @@ +======== +Security +======== + +.. meta:: + :description: Learn how to use security features with the {+driver-long+}. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Authentication + In-Use Encryption + TLS/SSL + Validate Driver Artifact Signatures \ No newline at end of file diff --git a/source/fundamentals/auth.txt b/source/security/auth.txt similarity index 99% rename from source/fundamentals/auth.txt rename to source/security/auth.txt index 3a0eb360d..263473b85 100644 --- a/source/fundamentals/auth.txt +++ b/source/security/auth.txt @@ -574,4 +574,4 @@ mechanism: For additional information on configuring your application to use certificates as well as TLS/SSL options, see our -:doc:`TLS/SSL guide `. +:doc:`TLS/SSL guide `. diff --git a/source/fundamentals/encrypt-fields.txt b/source/security/encrypt-fields.txt similarity index 100% rename from source/fundamentals/encrypt-fields.txt rename to source/security/encrypt-fields.txt diff --git a/source/fundamentals/connection/tls.txt b/source/security/tls.txt similarity index 100% rename from source/fundamentals/connection/tls.txt rename to source/security/tls.txt diff --git a/source/security/validate-signatures.txt b/source/security/validate-signatures.txt new file mode 100644 index 000000000..14fd28ee1 --- /dev/null +++ b/source/security/validate-signatures.txt @@ -0,0 +1,3 @@ +.. _java-validate-signatures: + +.. sharedinclude:: dbx/jvm/validate-artifacts.rst diff --git a/source/usage-examples.txt b/source/usage-examples.txt index 208b025ec..f35cc0ecc 100644 --- a/source/usage-examples.txt +++ b/source/usage-examples.txt @@ -69,4 +69,4 @@ to learn how to allow connections to your instance of Atlas and to find the ```` with the IP address or URL of your instance. For more information about connecting to your MongoDB instance, see our -:doc:`Connection Guide `. +:doc:`Connection Guide `. diff --git a/source/usage-examples/find.txt b/source/usage-examples/find.txt index ee9c93969..742732ba5 100644 --- a/source/usage-examples/find.txt +++ b/source/usage-examples/find.txt @@ -13,7 +13,7 @@ the collection. If you do not include a filter, MongoDB returns all the documents in the collection. For more information about querying MongoDB with the Java driver, see our -:doc:`guide on Querying Documents `. +:doc:`guide on Querying Documents `. You can also chain methods to the ``find()`` method such as ``sort()`` which organizes the matched documents in a specified order and @@ -21,9 +21,9 @@ organizes the matched documents in a specified order and returned documents. For more information about the ``sort()`` method, see our -:doc:`guide on Sorting `. +:doc:`guide on Sorting `. For more information about the ``projection()`` method, see our -:doc:`guide on Projections ` +:doc:`guide on Projections ` The ``find()`` method returns an instance of ``FindIterable``, a class that offers several methods to access, organize, and traverse the results. diff --git a/source/usage-examples/findOne.txt b/source/usage-examples/findOne.txt index ca275c2ee..7270c2f00 100644 --- a/source/usage-examples/findOne.txt +++ b/source/usage-examples/findOne.txt @@ -14,16 +14,16 @@ include a filter, MongoDB returns all the documents in the collection. The ``first()`` method returns the first matching document. For more information about querying MongoDB with the Java driver, see our -:doc:`guide on Querying Documents `. +:doc:`guide on Querying Documents `. You can also chain other methods to the ``find()`` method such as ``sort()`` which organizes the matched documents in a specified order, and ``projection()`` which configures the fields included in the returned documents. For more information about the ``sort()`` method, see our -:doc:`guide on Sorting `. +:doc:`guide on Sorting `. For more information about the ``projection()`` method, see our -:doc:`guide on Projections ` +:doc:`guide on Projections ` The ``find()`` method returns an instance of ``FindIterable``, a class that offers several methods to access, organize, and traverse the results. diff --git a/source/usage-examples/updateMany.txt b/source/usage-examples/updateMany.txt index ce791efec..8385a1451 100644 --- a/source/usage-examples/updateMany.txt +++ b/source/usage-examples/updateMany.txt @@ -70,7 +70,7 @@ We use the ``Updates`` builder, a factory class that contains static helper methods to construct the update document. While you can pass an update document instead of using the builder, the builder provides type checking and simplified syntax. Read our -:doc:`guide on Updates ` in the Builders +:doc:`guide on Updates ` in the Builders section for more information. .. include:: /includes/connect-guide-note.rst diff --git a/source/usage-examples/updateOne.txt b/source/usage-examples/updateOne.txt index e8ce7eba2..f2696177f 100644 --- a/source/usage-examples/updateOne.txt +++ b/source/usage-examples/updateOne.txt @@ -69,7 +69,7 @@ We use the ``Updates`` builder, a factory class that contains static helper methods, to construct the update document. While you can pass an update document instead of using the builder, the builder provides type checking and simplified syntax. For more information about the ``Updates`` builder, see our -:doc:`guide on the Updates builder `. +:doc:`guide on the Updates builder `. .. include:: /includes/connect-guide-note.rst diff --git a/source/versioning.txt b/source/versioning.txt new file mode 100644 index 000000000..90c9e35b6 --- /dev/null +++ b/source/versioning.txt @@ -0,0 +1,15 @@ +========== +Versioning +========== + +.. meta:: + :description: Learn about versioning in the {+driver-long+}. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Release Notes + Compatibility + Upgrade + Migrate from the Legacy API \ No newline at end of file diff --git a/source/compatibility.txt b/source/versioning/compatibility.txt similarity index 100% rename from source/compatibility.txt rename to source/versioning/compatibility.txt diff --git a/source/legacy.txt b/source/versioning/legacy.txt similarity index 100% rename from source/legacy.txt rename to source/versioning/legacy.txt diff --git a/source/upgrade.txt b/source/versioning/upgrade.txt similarity index 100% rename from source/upgrade.txt rename to source/versioning/upgrade.txt diff --git a/source/whats-new.txt b/source/versioning/whats-new.txt similarity index 100% rename from source/whats-new.txt rename to source/versioning/whats-new.txt From 4df955afb537182adc226f28a8113a8af013f0d8 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> Date: Tue, 11 Feb 2025 13:33:43 -0500 Subject: [PATCH 2/7] fix redirects (#616) --- config/redirects | 72 ++++++++++++++++++++++++------------------------ 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/config/redirects b/config/redirects index d5b62edd6..ffce4eb81 100644 --- a/config/redirects +++ b/config/redirects @@ -11,39 +11,39 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-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}/ -[*-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/ -[*-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/ -[*-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/ -[*-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/ -[*-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ -[*-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ -[*-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ -[*-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ -[*-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ -[*-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ -[*-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ -[*-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/ -[*-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/ -[*-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/ +[v5.3-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ +[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/ +[v5.3-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/ From 791d27df9de3d62636b72bb7552ea330edfacefd Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh <148898879+rachel-mack@users.noreply.github.com> Date: Wed, 12 Feb 2025 14:06:12 -0500 Subject: [PATCH 3/7] [Java Sync] P2 - Shift Java ToC (#617) --- config/redirects | 24 ++++- snooty.toml | 9 +- source/atlas-vector-search.txt | 91 ++++++++++++++++++- source/connection.txt | 3 +- source/connection/connect.txt | 4 +- .../connection-troubleshooting.txt | 7 -- .../stable-api.txt | 0 source/crud.txt | 6 ++ .../aggregation-expression-operations.txt | 0 source/{fundamentals => crud}/aggregation.txt | 0 source/{fundamentals => crud}/builders.txt | 12 +-- .../builders/aggregates.txt | 0 .../builders/filters.txt | 0 .../builders/indexes.txt | 0 .../builders/projections.txt | 0 .../{fundamentals => crud}/builders/sort.txt | 0 .../builders/updates.txt | 0 source/{fundamentals => crud}/collations.txt | 0 source/{fundamentals => crud}/gridfs.txt | 13 ++- .../{fundamentals => crud}/transactions.txt | 0 source/data-formats.txt | 3 +- .../time-series.txt | 0 .../{quick-start.txt => getting-started.txt} | 14 ++- .../databases-collections.txt | 0 source/{ => getting-started}/integrations.txt | 0 .../{ => getting-started}/quick-reference.txt | 0 source/index.txt | 9 +- source/security.txt | 2 + .../enterprise-auth.txt | 0 source/{connection => security}/socks.txt | 0 30 files changed, 158 insertions(+), 39 deletions(-) rename source/{ => connection}/connection-troubleshooting.txt (97%) rename source/{fundamentals => connection}/stable-api.txt (100%) rename source/{fundamentals => crud}/aggregation-expression-operations.txt (100%) rename source/{fundamentals => crud}/aggregation.txt (100%) rename source/{fundamentals => crud}/builders.txt (92%) rename source/{fundamentals => crud}/builders/aggregates.txt (100%) rename source/{fundamentals => crud}/builders/filters.txt (100%) rename source/{fundamentals => crud}/builders/indexes.txt (100%) rename source/{fundamentals => crud}/builders/projections.txt (100%) rename source/{fundamentals => crud}/builders/sort.txt (100%) rename source/{fundamentals => crud}/builders/updates.txt (100%) rename source/{fundamentals => crud}/collations.txt (100%) rename source/{fundamentals => crud}/gridfs.txt (98%) rename source/{fundamentals => crud}/transactions.txt (100%) rename source/{fundamentals => data-formats}/time-series.txt (100%) rename source/{quick-start.txt => getting-started.txt} (94%) rename source/{fundamentals => getting-started}/databases-collections.txt (100%) rename source/{ => getting-started}/integrations.txt (100%) rename source/{ => getting-started}/quick-reference.txt (100%) rename source/{fundamentals => security}/enterprise-auth.txt (100%) rename source/{connection => security}/socks.txt (100%) diff --git a/config/redirects b/config/redirects index ffce4eb81..128aa1151 100644 --- a/config/redirects +++ b/config/redirects @@ -5,7 +5,7 @@ define: versions v4.3 v4.4 v4.5 v4.6 v4.7 v4.8 v4.9 v4.10 v4.11 v5.0 master raw: ${prefix}/ -> ${base}/current/ raw: ${prefix}/master -> ${base}/upcoming/ -[*-master]: ${prefix}/${version}/fundamentals/versioned-api/ -> ${base}/${version}/fundamentals/stable-api/ +[*-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/ @@ -47,3 +47,25 @@ raw: ${prefix}/master -> ${base}/upcoming/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/ [v5.3-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/ -> ${base}/${version}/crud/builders/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/aggregates/ -> ${base}/${version}/crud/builders/aggregates/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/filters/ -> ${base}/${version}/crud/builders/filters/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/indexes/ -> ${base}/${version}/crud/builders/indexes/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/projections/ -> ${base}/${version}/crud/builders/projections/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/sort/ -> ${base}/${version}/crud/builders/sort/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/updates/ -> ${base}/${version}/crud/builders/updates/ +[v5.3-master]: ${prefix}/${version}/fundamentals/builders/vector-search -> ${base}/${version}/atlas-vector-search/ +[v5.3-master]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/crud/aggregation/ +[v5.3-master]: ${prefix}/${version}/fundamentals/aggregation-expression-operations/ -> ${base}/${version}/crud/aggregation-expression-operations/ +[v5.3-master]: ${prefix}/${version}/fundamentals/collations/ -> ${base}/${version}/crud/collations/ +[v5.3-master]: ${prefix}/${version}/fundamentals/stable-api/ -> ${base}/${version}/connection/stable-api/ +[v5.3-master]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connection/connection-troubleshooting/ +[v5.3-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/ +[v5.3-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/ +[v5.3-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/data-formats/time-series/ +[v5.3-master]: ${prefix}/${version}/quick-start/ -> ${base}/${version}/getting-started/ +[v5.3-master]: ${prefix}/${version}/fundamentals/databases-collections/ -> ${base}/${version}/getting-started/databases-collections/ +[v5.3-master]: ${prefix}/${version}/integrations/ -> ${base}/${version}/getting-started/integrations/ +[v5.3-master]: ${prefix}/${version}/quick-reference/ -> ${base}/${version}/getting-started/quick-reference/ +[v5.3-master]: ${prefix}/${version}/fundamentals/enterprise-auth/ -> ${base}/${version}/security/enterprise-auth/ +[v5.3-master]: ${prefix}/${version}/connection/socks/ -> ${base}/${version}/security/socks/ diff --git a/snooty.toml b/snooty.toml index 054a31f90..afd4ddc2e 100644 --- a/snooty.toml +++ b/snooty.toml @@ -7,11 +7,14 @@ intersphinx = [ ] toc_landing_pages = [ + "/getting-started", "/connection", "/crud", - "/fundamentals/builders", - "/fundamentals/aggregation", - "/usage-examples", + "/aggregation", + "/builders", + "/data-formats", + "reference", + "/api-documentation" ] sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" diff --git a/source/atlas-vector-search.txt b/source/atlas-vector-search.txt index 7cd53247e..e60a1d487 100644 --- a/source/atlas-vector-search.txt +++ b/source/atlas-vector-search.txt @@ -9,7 +9,7 @@ Atlas Vector Search :values: reference .. meta:: - :keywords: full text, text analyzer, meta, pipeline, scoring, Lucene, AI, artificial intelligence + :keywords: full text, text analyzer, meta, pipeline, scoring, Lucene, AI, artificial intelligence, code example, semantic, nearest :description: Learn about how to use Atlas Vector Search in the {+driver-long+}. .. contents:: On this page @@ -18,5 +18,90 @@ Atlas Vector Search :depth: 2 :class: singlecol -See :atlas:`Atlas Vector Search ` -in the MongoDB Atlas documentation. \ No newline at end of file +Overview +-------- + +In this guide, you can learn how to use the :atlas:`Atlas Vector Search +` feature +in the {+driver-short+}. The ``Aggregates`` builders class provides the +the ``vectorSearch()`` helper method that you can use to +create a :atlas:`$vectorSearch ` +pipeline stage. This pipeline stage allows you to perform a **semantic +search** on your documents. A semantic search is a type of search which +locates information that is similar in meaning, but not necessarily +identical, to your provided search term or phrase. + +.. important:: Feature Compatibility + + To learn what versions of MongoDB Atlas support this feature, see + :atlas:`Limitations ` + in the MongoDB Atlas documentation. + +Perform a Vector Search +----------------------- + +To use this feature, you must create a vector search index and index your +vector embeddings. To learn about how to programmatically create a +vector search index, see the :ref:`java-search-indexes` section in the +Indexes guide. To learn more about vector embeddings, see +:atlas:`How to Index Vector Embeddings for Vector Search +` in the Atlas documentation. + +After you create a vector search index on your vector embeddings, you +can reference this index in your pipeline stage, as shown in the +following section. + +Vector Search Example +~~~~~~~~~~~~~~~~~~~~~ + +The following example shows how to build an aggregation pipeline that uses the +``vectorSearch()`` and ``project()`` methods to compute a vector search score: + +.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java + :start-after: // begin vectorSearch + :end-before: // end vectorSearch + :language: java + :dedent: + +.. tip:: Query Vector Type + + The preceding example creates an instance of ``BinaryVector`` to + serve as the query vector, but you can also create a ``List`` of + ``Double`` instances. However, we recommend that you use the + ``BinaryVector`` type to improve storage efficiency. + +The following example shows how you can run the aggregation and print +the vector search meta-score from the result of the preceding +aggregation pipeline: + +.. literalinclude:: /includes/fundamentals/code-snippets/builders/AggBuilders.java + :start-after: // begin vectorSearch-output + :end-before: // end vectorSearch-output + :language: java + :dedent: + +.. tip:: Java Driver Vector Search Examples + + Visit the :atlas:`Atlas documentation ` + to find more tutorials on using the {+driver-short+} to perform Atlas + Vector Searches. + +API Documentation +----------------- + +To learn more about the methods and types mentioned in this +guide, see the following API documentation: + +- `Aggregates.vectorSearch() + <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Aggregates.html#vectorSearch(com.mongodb.client.model.search.FieldSearchPath,java.lang.Iterable,java.lang.String,long,com.mongodb.client.model.search.VectorSearchOptions)>`__ + +- `FieldSearchPath + <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/FieldSearchPath.html>`__ + +- `VectorSearchOptions + <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/search/VectorSearchOptions.html>`__ + +- `Projections.metaVectorSearchScore() + <{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/Projections.html#metaVectorSearchScore(java.lang.String)>`__ + +- `BinaryVector <{+api+}/apidocs/bson/org/bson/BinaryVector.html>`__ \ No newline at end of file diff --git a/source/connection.txt b/source/connection.txt index ef4975990..d34dc63f2 100644 --- a/source/connection.txt +++ b/source/connection.txt @@ -9,9 +9,10 @@ Connection Guide Connect to MongoDB Connection Options MongoClient Settings + Stable API Network Compression - SOCKS5 Proxy JNDI Datasource + Connection Troubleshooting AWS Lambda .. contents:: On this page diff --git a/source/connection/connect.txt b/source/connection/connect.txt index 713a350bb..6e122095a 100644 --- a/source/connection/connect.txt +++ b/source/connection/connect.txt @@ -26,9 +26,7 @@ Use the ``MongoClients.create()`` method to construct a ``MongoClient``. As each ``MongoClient`` represents a thread-safe pool of connections to the database, most applications only require a single instance of a - ``MongoClient``, even across multiple threads. To learn more about - how connection pools work in the driver, see the :ref:`FAQ page `. - + ``MongoClient``, even across multiple threads. All resource usage limits, such as max connections, apply to individual ``MongoClient`` instances. diff --git a/source/connection-troubleshooting.txt b/source/connection/connection-troubleshooting.txt similarity index 97% rename from source/connection-troubleshooting.txt rename to source/connection/connection-troubleshooting.txt index b05ba4ce5..a4a79c6bd 100644 --- a/source/connection-troubleshooting.txt +++ b/source/connection/connection-troubleshooting.txt @@ -31,8 +31,6 @@ Connection Troubleshooting finding more resources - The `MongoDB Community Forums <{+communityForums+}>`__ for questions, discussions, or general technical support - - The :ref:`Frequently Asked Questions (FAQ) ` page for - answers to common questions about the {+driver-short+} .. replacement:: server-selection-timeout-error @@ -150,11 +148,6 @@ Connection Troubleshooting ``maxIdleTimeMS`` - .. replacement:: connection-pools-learn-more - - To learn more about how connection pooling works in the driver, see - :ref:`java-faq-connection-pool` in the FAQ. - .. replacement:: scram-failure-error .. code-block:: diff --git a/source/fundamentals/stable-api.txt b/source/connection/stable-api.txt similarity index 100% rename from source/fundamentals/stable-api.txt rename to source/connection/stable-api.txt diff --git a/source/crud.txt b/source/crud.txt index 55dded691..3fc0b0fde 100644 --- a/source/crud.txt +++ b/source/crud.txt @@ -11,6 +11,12 @@ CRUD Operations Write Query Compound Operations + Transactions + Builders + Aggregation + Aggregation Expressions + Collations + Large File Storage with GridFS CRUD (Create, Read, Update, Delete) operations enable you to work with data stored in MongoDB. diff --git a/source/fundamentals/aggregation-expression-operations.txt b/source/crud/aggregation-expression-operations.txt similarity index 100% rename from source/fundamentals/aggregation-expression-operations.txt rename to source/crud/aggregation-expression-operations.txt diff --git a/source/fundamentals/aggregation.txt b/source/crud/aggregation.txt similarity index 100% rename from source/fundamentals/aggregation.txt rename to source/crud/aggregation.txt diff --git a/source/fundamentals/builders.txt b/source/crud/builders.txt similarity index 92% rename from source/fundamentals/builders.txt rename to source/crud/builders.txt index 1bcd498e3..e2074404a 100644 --- a/source/fundamentals/builders.txt +++ b/source/crud/builders.txt @@ -8,12 +8,12 @@ Builders .. toctree:: - Aggregation - Filters - Indexes - Projection - Sort - Update + Aggregation + Filters + Indexes + Projection + Sort + Update .. contents:: On this page :local: diff --git a/source/fundamentals/builders/aggregates.txt b/source/crud/builders/aggregates.txt similarity index 100% rename from source/fundamentals/builders/aggregates.txt rename to source/crud/builders/aggregates.txt diff --git a/source/fundamentals/builders/filters.txt b/source/crud/builders/filters.txt similarity index 100% rename from source/fundamentals/builders/filters.txt rename to source/crud/builders/filters.txt diff --git a/source/fundamentals/builders/indexes.txt b/source/crud/builders/indexes.txt similarity index 100% rename from source/fundamentals/builders/indexes.txt rename to source/crud/builders/indexes.txt diff --git a/source/fundamentals/builders/projections.txt b/source/crud/builders/projections.txt similarity index 100% rename from source/fundamentals/builders/projections.txt rename to source/crud/builders/projections.txt diff --git a/source/fundamentals/builders/sort.txt b/source/crud/builders/sort.txt similarity index 100% rename from source/fundamentals/builders/sort.txt rename to source/crud/builders/sort.txt diff --git a/source/fundamentals/builders/updates.txt b/source/crud/builders/updates.txt similarity index 100% rename from source/fundamentals/builders/updates.txt rename to source/crud/builders/updates.txt diff --git a/source/fundamentals/collations.txt b/source/crud/collations.txt similarity index 100% rename from source/fundamentals/collations.txt rename to source/crud/collations.txt diff --git a/source/fundamentals/gridfs.txt b/source/crud/gridfs.txt similarity index 98% rename from source/fundamentals/gridfs.txt rename to source/crud/gridfs.txt index 7ddf890a7..bd47e7dc2 100644 --- a/source/fundamentals/gridfs.txt +++ b/source/crud/gridfs.txt @@ -1,8 +1,15 @@ -====== -GridFS -====== +============================== +Large File Storage with GridFS +============================== .. default-domain:: mongodb +.. facet:: + :name: genre + :values: reference + +.. meta:: + :keywords: retrieve, size limit + :description: Store large files with GridFS in the {+driver-long+}. .. contents:: On this page :local: diff --git a/source/fundamentals/transactions.txt b/source/crud/transactions.txt similarity index 100% rename from source/fundamentals/transactions.txt rename to source/crud/transactions.txt diff --git a/source/data-formats.txt b/source/data-formats.txt index 2ef94ed67..f553fbc97 100644 --- a/source/data-formats.txt +++ b/source/data-formats.txt @@ -12,9 +12,10 @@ Data Formats Extended JSON Documents POJOs - Records POJO Customization + Records Codecs + Time Series Collections - :doc:`/data-formats/document-data-format-bson` - :doc:`/data-formats/document-data-format-extended-json` diff --git a/source/fundamentals/time-series.txt b/source/data-formats/time-series.txt similarity index 100% rename from source/fundamentals/time-series.txt rename to source/data-formats/time-series.txt diff --git a/source/quick-start.txt b/source/getting-started.txt similarity index 94% rename from source/quick-start.txt rename to source/getting-started.txt index ee95b28b2..9120522de 100644 --- a/source/quick-start.txt +++ b/source/getting-started.txt @@ -1,8 +1,8 @@ .. _java-sync-quickstart: -======================= -Java Driver Quick Start -======================= +=============== +Getting Started +=============== .. facet:: :name: genre @@ -17,6 +17,14 @@ Java Driver Quick Start :depth: 2 :class: singlecol +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Quick Reference + Databases and Collections + Integrations + Introduction ------------ diff --git a/source/fundamentals/databases-collections.txt b/source/getting-started/databases-collections.txt similarity index 100% rename from source/fundamentals/databases-collections.txt rename to source/getting-started/databases-collections.txt diff --git a/source/integrations.txt b/source/getting-started/integrations.txt similarity index 100% rename from source/integrations.txt rename to source/getting-started/integrations.txt diff --git a/source/quick-reference.txt b/source/getting-started/quick-reference.txt similarity index 100% rename from source/quick-reference.txt rename to source/getting-started/quick-reference.txt diff --git a/source/index.txt b/source/index.txt index bbf40f307..974fd14e3 100644 --- a/source/index.txt +++ b/source/index.txt @@ -17,7 +17,7 @@ MongoDB Java Driver :titlesonly: :maxdepth: 1 - Getting Started + Getting Started Connect CRUD Operations Data Formats @@ -117,13 +117,6 @@ and links to the API documentation. * - `Legacy Java Driver <{+api+}/apidocs/mongodb-driver-legacy/index.html>`__ - Legacy API -FAQ ---- - -For answers to commonly asked questions about the MongoDB -Java Driver, see the :doc:`Frequently Asked Questions (FAQ) ` -section. - Connection Troubleshooting -------------------------- diff --git a/source/security.txt b/source/security.txt index f4bb3b42c..4414a7ffb 100644 --- a/source/security.txt +++ b/source/security.txt @@ -10,6 +10,8 @@ Security :maxdepth: 1 Authentication + Enterprise Authentication In-Use Encryption TLS/SSL + SOCKS5 Proxy Validate Driver Artifact Signatures \ No newline at end of file diff --git a/source/fundamentals/enterprise-auth.txt b/source/security/enterprise-auth.txt similarity index 100% rename from source/fundamentals/enterprise-auth.txt rename to source/security/enterprise-auth.txt diff --git a/source/connection/socks.txt b/source/security/socks.txt similarity index 100% rename from source/connection/socks.txt rename to source/security/socks.txt From 48e6fa311ee90b7a4ee07c28644fe4f9eea264f8 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Mon, 24 Mar 2025 11:54:15 -0400 Subject: [PATCH 4/7] toc tweaks --- config/redirects | 116 +++++++++--------- snooty.toml | 2 +- source/{crud => }/aggregation.txt | 4 + .../aggregation-expression-operations.txt | 0 source/{crud => }/builders.txt | 12 +- source/{crud => }/builders/aggregates.txt | 0 source/{crud => }/builders/filters.txt | 0 source/{crud => }/builders/indexes.txt | 0 source/{crud => }/builders/projections.txt | 0 source/{crud => }/builders/sort.txt | 0 source/{crud => }/builders/updates.txt | 0 source/crud.txt | 3 - source/getting-started.txt | 1 - source/index.txt | 9 +- source/{getting-started => }/integrations.txt | 6 +- source/reference.txt | 15 +++ .../compatibility.txt | 0 source/{versioning => reference}/legacy.txt | 0 source/{versioning => reference}/upgrade.txt | 0 .../{versioning => reference}/whats-new.txt | 0 source/versioning.txt | 15 --- 21 files changed, 91 insertions(+), 92 deletions(-) rename source/{crud => }/aggregation.txt (99%) rename source/{crud => aggregation}/aggregation-expression-operations.txt (100%) rename source/{crud => }/builders.txt (92%) rename source/{crud => }/builders/aggregates.txt (100%) rename source/{crud => }/builders/filters.txt (100%) rename source/{crud => }/builders/indexes.txt (100%) rename source/{crud => }/builders/projections.txt (100%) rename source/{crud => }/builders/sort.txt (100%) rename source/{crud => }/builders/updates.txt (100%) rename source/{getting-started => }/integrations.txt (98%) create mode 100644 source/reference.txt rename source/{versioning => reference}/compatibility.txt (100%) rename source/{versioning => reference}/legacy.txt (100%) rename source/{versioning => reference}/upgrade.txt (100%) rename source/{versioning => reference}/whats-new.txt (100%) delete mode 100644 source/versioning.txt diff --git a/config/redirects b/config/redirects index 128aa1151..b5fbfd6aa 100644 --- a/config/redirects +++ b/config/redirects @@ -11,61 +11,61 @@ raw: ${prefix}/master -> ${base}/upcoming/ [*-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}/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/ -[v5.3-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ -[v5.3-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/ -[v5.3-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/ -> ${base}/${version}/crud/builders/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/aggregates/ -> ${base}/${version}/crud/builders/aggregates/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/filters/ -> ${base}/${version}/crud/builders/filters/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/indexes/ -> ${base}/${version}/crud/builders/indexes/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/projections/ -> ${base}/${version}/crud/builders/projections/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/sort/ -> ${base}/${version}/crud/builders/sort/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/updates/ -> ${base}/${version}/crud/builders/updates/ -[v5.3-master]: ${prefix}/${version}/fundamentals/builders/vector-search -> ${base}/${version}/atlas-vector-search/ -[v5.3-master]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/crud/aggregation/ -[v5.3-master]: ${prefix}/${version}/fundamentals/aggregation-expression-operations/ -> ${base}/${version}/crud/aggregation-expression-operations/ -[v5.3-master]: ${prefix}/${version}/fundamentals/collations/ -> ${base}/${version}/crud/collations/ -[v5.3-master]: ${prefix}/${version}/fundamentals/stable-api/ -> ${base}/${version}/connection/stable-api/ -[v5.3-master]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connection/connection-troubleshooting/ -[v5.3-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/ -[v5.3-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/ -[v5.3-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/data-formats/time-series/ -[v5.3-master]: ${prefix}/${version}/quick-start/ -> ${base}/${version}/getting-started/ -[v5.3-master]: ${prefix}/${version}/fundamentals/databases-collections/ -> ${base}/${version}/getting-started/databases-collections/ -[v5.3-master]: ${prefix}/${version}/integrations/ -> ${base}/${version}/getting-started/integrations/ -[v5.3-master]: ${prefix}/${version}/quick-reference/ -> ${base}/${version}/getting-started/quick-reference/ -[v5.3-master]: ${prefix}/${version}/fundamentals/enterprise-auth/ -> ${base}/${version}/security/enterprise-auth/ -[v5.3-master]: ${prefix}/${version}/connection/socks/ -> ${base}/${version}/security/socks/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/ -> ${base}/${version}/crud/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/ -> ${base}/${version}/crud/read-operations/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/retrieve/ -> ${base}/${version}/crud/read-operations/retrieve/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/cursor/ -> ${base}/${version}/crud/read-operations/cursor/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/change-streams/ -> ${base}/${version}/logging-monitoring/change-streams/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/sort/ -> ${base}/${version}/crud/read-operations/sort/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/skip/ -> ${base}/${version}/crud/read-operations/skip/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/limit/ -> ${base}/${version}/crud/read-operations/limit/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/project/ -> ${base}/${version}/crud/read-operations/project/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/geo/ -> ${base}/${version}/crud/read-operations/geo/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/read-operations/text/ -> ${base}/${version}/crud/read-operations/text/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/ -> ${base}/${version}/crud/write-operations/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/insert/ -> ${base}/${version}/crud/write-operations/insert/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/delete/ -> ${base}/${version}/crud/write-operations/delete/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/modify/ -> ${base}/${version}/crud/write-operations/modify/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/embedded-arrays/ -> ${base}/${version}/crud/write-operations/embedded-arrays/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/upsert/ -> ${base}/${version}/crud/write-operations/upsert/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/write-operations/bulk/ -> ${base}/${version}/crud/write-operations/bulk/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/query-document/ -> ${base}/${version}/crud/query-document/ +[v5.0-master]: ${prefix}/${version}/fundamentals/crud/compound-operations/ -> ${base}/${version}/crud/compound-operations/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/ -> ${base}/${version}/data-formats/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-bson/ -> ${base}/${version}/data-formats/document-data-format-bson/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-extended-json/ -> ${base}/${version}/data-formats/document-data-format-extended-json/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/documents/ -> ${base}/${version}/data-formats/documents/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-pojo/ -> ${base}/${version}/data-formats/document-data-format-pojo/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/document-data-format-record/ -> ${base}/${version}/data-formats/document-data-format-record/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/pojo-customization/ -> ${base}/${version}/data-formats/pojo-customization/ +[v5.0-master]: ${prefix}/${version}/fundamentals/data-formats/codecs/ -> ${base}/${version}/data-formats/codecs/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/ -> ${base}/${version}/connection/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/connect/ -> ${base}/${version}/connection/connect/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/connection-options/ -> ${base}/${version}/connection/connection-options/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/mongoclientsettings/ -> ${base}/${version}/connection/mongoclientsettings/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/network-compression/ -> ${base}/${version}/connection/network-compression/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/socks/ -> ${base}/${version}/connection/socks/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/tls/ -> ${base}/${version}/security/tls/ +[v5.0-master]: ${prefix}/${version}/fundamentals/connection/jndi/ -> ${base}/${version}/connection/jndi/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/ -> ${base}/${version}/crud/builders/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/aggregates/ -> ${base}/${version}/crud/builders/aggregates/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/filters/ -> ${base}/${version}/crud/builders/filters/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/indexes/ -> ${base}/${version}/crud/builders/indexes/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/projections/ -> ${base}/${version}/crud/builders/projections/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/sort/ -> ${base}/${version}/crud/builders/sort/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/updates/ -> ${base}/${version}/crud/builders/updates/ +[v5.0-master]: ${prefix}/${version}/fundamentals/builders/vector-search -> ${base}/${version}/atlas-vector-search/ +[v5.0-master]: ${prefix}/${version}/fundamentals/aggregation/ -> ${base}/${version}/crud/aggregation/ +[v5.0-master]: ${prefix}/${version}/fundamentals/aggregation-expression-operations/ -> ${base}/${version}/crud/aggregation-expression-operations/ +[v5.0-master]: ${prefix}/${version}/fundamentals/collations/ -> ${base}/${version}/crud/collations/ +[v5.0-master]: ${prefix}/${version}/fundamentals/stable-api/ -> ${base}/${version}/connection/stable-api/ +[v5.0-master]: ${prefix}/${version}/connection-troubleshooting/ -> ${base}/${version}/connection/connection-troubleshooting/ +[v5.0-master]: ${prefix}/${version}/fundamentals/gridfs/ -> ${base}/${version}/crud/gridfs/ +[v5.0-master]: ${prefix}/${version}/fundamentals/transactions/ -> ${base}/${version}/crud/transactions/ +[v5.0-master]: ${prefix}/${version}/fundamentals/time-series/ -> ${base}/${version}/data-formats/time-series/ +[v5.0-master]: ${prefix}/${version}/quick-start/ -> ${base}/${version}/getting-started/ +[v5.0-master]: ${prefix}/${version}/fundamentals/databases-collections/ -> ${base}/${version}/getting-started/databases-collections/ +[v5.0-master]: ${prefix}/${version}/integrations/ -> ${base}/${version}/getting-started/integrations/ +[v5.0-master]: ${prefix}/${version}/quick-reference/ -> ${base}/${version}/getting-started/quick-reference/ +[v5.0-master]: ${prefix}/${version}/fundamentals/enterprise-auth/ -> ${base}/${version}/security/enterprise-auth/ +[v5.0-master]: ${prefix}/${version}/connection/socks/ -> ${base}/${version}/security/socks/ diff --git a/snooty.toml b/snooty.toml index afd4ddc2e..e558f7882 100644 --- a/snooty.toml +++ b/snooty.toml @@ -13,7 +13,7 @@ toc_landing_pages = [ "/aggregation", "/builders", "/data-formats", - "reference", + "/reference", "/api-documentation" ] sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" diff --git a/source/crud/aggregation.txt b/source/aggregation.txt similarity index 99% rename from source/crud/aggregation.txt rename to source/aggregation.txt index 0b6f5d247..732d7da24 100644 --- a/source/crud/aggregation.txt +++ b/source/aggregation.txt @@ -17,6 +17,10 @@ Aggregation :depth: 2 :class: singlecol +.. toctree:: + + Aggregation Expressions + Overview -------- diff --git a/source/crud/aggregation-expression-operations.txt b/source/aggregation/aggregation-expression-operations.txt similarity index 100% rename from source/crud/aggregation-expression-operations.txt rename to source/aggregation/aggregation-expression-operations.txt diff --git a/source/crud/builders.txt b/source/builders.txt similarity index 92% rename from source/crud/builders.txt rename to source/builders.txt index e2074404a..1bcd498e3 100644 --- a/source/crud/builders.txt +++ b/source/builders.txt @@ -8,12 +8,12 @@ Builders .. toctree:: - Aggregation - Filters - Indexes - Projection - Sort - Update + Aggregation + Filters + Indexes + Projection + Sort + Update .. contents:: On this page :local: diff --git a/source/crud/builders/aggregates.txt b/source/builders/aggregates.txt similarity index 100% rename from source/crud/builders/aggregates.txt rename to source/builders/aggregates.txt diff --git a/source/crud/builders/filters.txt b/source/builders/filters.txt similarity index 100% rename from source/crud/builders/filters.txt rename to source/builders/filters.txt diff --git a/source/crud/builders/indexes.txt b/source/builders/indexes.txt similarity index 100% rename from source/crud/builders/indexes.txt rename to source/builders/indexes.txt diff --git a/source/crud/builders/projections.txt b/source/builders/projections.txt similarity index 100% rename from source/crud/builders/projections.txt rename to source/builders/projections.txt diff --git a/source/crud/builders/sort.txt b/source/builders/sort.txt similarity index 100% rename from source/crud/builders/sort.txt rename to source/builders/sort.txt diff --git a/source/crud/builders/updates.txt b/source/builders/updates.txt similarity index 100% rename from source/crud/builders/updates.txt rename to source/builders/updates.txt diff --git a/source/crud.txt b/source/crud.txt index 3fc0b0fde..f64c94fe0 100644 --- a/source/crud.txt +++ b/source/crud.txt @@ -12,9 +12,6 @@ CRUD Operations Query Compound Operations Transactions - Builders - Aggregation - Aggregation Expressions Collations Large File Storage with GridFS diff --git a/source/getting-started.txt b/source/getting-started.txt index 9120522de..c8b01b996 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -23,7 +23,6 @@ Getting Started Quick Reference Databases and Collections - Integrations Introduction ------------ diff --git a/source/index.txt b/source/index.txt index 974fd14e3..75b3cf23a 100644 --- a/source/index.txt +++ b/source/index.txt @@ -20,6 +20,8 @@ MongoDB Java Driver Getting Started Connect CRUD Operations + Aggregation + Builders Data Formats Indexes Run a Command @@ -27,13 +29,10 @@ MongoDB Java Driver Atlas Vector Search Logging and Monitoring Security - Versioning + Third-Party Integrations + Reference API Documentation Issues & Help - Driver Integrations - Compatibility - Upgrade - Migrate from the Legacy API View the Source Introduction diff --git a/source/getting-started/integrations.txt b/source/integrations.txt similarity index 98% rename from source/getting-started/integrations.txt rename to source/integrations.txt index d8929a1ca..16b47d06d 100644 --- a/source/getting-started/integrations.txt +++ b/source/integrations.txt @@ -1,8 +1,8 @@ .. _java-integrations: -=================== -Driver Integrations -=================== +========================= +Third-Party Integrations +========================= .. facet:: :name: genre diff --git a/source/reference.txt b/source/reference.txt new file mode 100644 index 000000000..3380ae0db --- /dev/null +++ b/source/reference.txt @@ -0,0 +1,15 @@ +========= +Reference +========= + +.. meta:: + :description: Learn about versioning in the {+driver-long+}. + +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Release Notes + Compatibility + Upgrade + Migrate from the Legacy API \ No newline at end of file diff --git a/source/versioning/compatibility.txt b/source/reference/compatibility.txt similarity index 100% rename from source/versioning/compatibility.txt rename to source/reference/compatibility.txt diff --git a/source/versioning/legacy.txt b/source/reference/legacy.txt similarity index 100% rename from source/versioning/legacy.txt rename to source/reference/legacy.txt diff --git a/source/versioning/upgrade.txt b/source/reference/upgrade.txt similarity index 100% rename from source/versioning/upgrade.txt rename to source/reference/upgrade.txt diff --git a/source/versioning/whats-new.txt b/source/reference/whats-new.txt similarity index 100% rename from source/versioning/whats-new.txt rename to source/reference/whats-new.txt diff --git a/source/versioning.txt b/source/versioning.txt deleted file mode 100644 index 90c9e35b6..000000000 --- a/source/versioning.txt +++ /dev/null @@ -1,15 +0,0 @@ -========== -Versioning -========== - -.. meta:: - :description: Learn about versioning in the {+driver-long+}. - -.. toctree:: - :titlesonly: - :maxdepth: 1 - - Release Notes - Compatibility - Upgrade - Migrate from the Legacy API \ No newline at end of file From a0765b6ac7a82c4e3f3ed9bf0507b4df889259b8 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Mon, 24 Mar 2025 11:56:04 -0400 Subject: [PATCH 5/7] databases adn collections --- source/{getting-started => }/databases-collections.txt | 0 source/getting-started.txt | 1 - source/index.txt | 1 + 3 files changed, 1 insertion(+), 1 deletion(-) rename source/{getting-started => }/databases-collections.txt (100%) diff --git a/source/getting-started/databases-collections.txt b/source/databases-collections.txt similarity index 100% rename from source/getting-started/databases-collections.txt rename to source/databases-collections.txt diff --git a/source/getting-started.txt b/source/getting-started.txt index c8b01b996..f76d668b1 100644 --- a/source/getting-started.txt +++ b/source/getting-started.txt @@ -22,7 +22,6 @@ Getting Started :maxdepth: 1 Quick Reference - Databases and Collections Introduction ------------ diff --git a/source/index.txt b/source/index.txt index 75b3cf23a..11e30cfc7 100644 --- a/source/index.txt +++ b/source/index.txt @@ -20,6 +20,7 @@ MongoDB Java Driver Getting Started Connect CRUD Operations + Databases and Collections Aggregation Builders Data Formats From f408675fa80e60901116e5a1209b5a3dddd34b86 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Mon, 24 Mar 2025 12:11:05 -0400 Subject: [PATCH 6/7] rm reference landing --- snooty.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/snooty.toml b/snooty.toml index e558f7882..849e68624 100644 --- a/snooty.toml +++ b/snooty.toml @@ -13,7 +13,6 @@ toc_landing_pages = [ "/aggregation", "/builders", "/data-formats", - "/reference", "/api-documentation" ] sharedinclude_root = "https://raw.githubusercontent.com/10gen/docs-shared/main/" From 7dc18eba1e3a9ee8daad871d06d62fe380156ef0 Mon Sep 17 00:00:00 2001 From: Rachel Mackintosh Date: Mon, 24 Mar 2025 12:15:29 -0400 Subject: [PATCH 7/7] vale error --- .github/workflows/vale-tdbx.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/vale-tdbx.yml b/.github/workflows/vale-tdbx.yml index 284033abe..8e4b6f491 100644 --- a/.github/workflows/vale-tdbx.yml +++ b/.github/workflows/vale-tdbx.yml @@ -12,6 +12,9 @@ jobs: - name: checkout uses: actions/checkout@master + - name: Install docutils + run: sudo apt-get install -y docutils + - id: files uses: masesgroup/retrieve-changed-files@v2 with: