Skip to content

[Java Sync] Connection Section Reorg #648

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Mar 12, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ raw: ${prefix}/master -> ${base}/upcoming/
[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/connect/ -> ${base}/${version}/connection/mongoclient
[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/
Expand Down
2 changes: 2 additions & 0 deletions snooty.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ intersphinx = [
toc_landing_pages = [
"/get-started",
"/connection",
"/connection/specify-connection-options",
"/crud",
"/crud/builders",
"/data-formats",
"/api-documentation",
"/security",
"/security/auth"
]

Expand Down
23 changes: 6 additions & 17 deletions source/connection.txt
Original file line number Diff line number Diff line change
@@ -1,20 +1,14 @@
.. _java-connection-guide:
.. _java-connection-uri-guide:

================
Connection Guide
================

.. toctree::

Connect to MongoDB </connection/connect>
Connection Options </connection/connection-options>
MongoClient Settings </connection/mongoclientsettings>
Stable API </connection/stable-api>
Connection Pools </connection/connection-pools>
Network Compression </connection/network-compression>
JNDI Datasource </connection/jndi>
Create a MongoClient </connection/mongoclient>
Specify Connection Options </connection/specify-connection-options>
Connection Troubleshooting </connection/connection-troubleshooting>
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>

.. contents:: On this page
:local:
Expand All @@ -29,14 +23,9 @@ Learn how to set up a connection and specify connection behavior from your
application to a MongoDB deployment using the driver in the following
sections:

- :ref:`Connect to MongoDB <java-connect-to-mongodb>`
- :ref:`View a List of Connection Options <connection-options>`
- :ref:`Specify Connection Behavior with the MongoClient Class <specify-mongoclient-settings>`
- :ref:`Enable Network Compression <java-compression>`
- :ref:`Enable TLS/SSL on a Connection <tls-ssl>`
- :ref:`Connect to MongoDB by Using a SOCKS5 Proxy <java-connect-socks>`
- :ref:`Connect to MongoDB by Using a JNDI Datasource <jndi>`
- :atlas:`Connect to MongoDB Atlas from AWS Lambda </manage-connections-aws-lambda/>`
- :ref:`Create a MongoClient <java-mongoclient>`
- :ref:`Specify Connection Options <java-specify-connection-options>`
- :ref:`Connection Troubleshooting <java-connection-troubleshooting>`

For information about authenticating with a MongoDB instance,
see the :ref:`<java-authentication-mechanisms>` section.
2 changes: 1 addition & 1 deletion source/connection/connection-troubleshooting.txt
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@ against the connected secondary node if you set the read preference to

You can also specify the ``serverSelectionTimeoutMS`` connection option
to adjust the amount of time in which the driver must select a server. To
learn more, see the :ref:`java-connection-options` guide.
learn more, see the :ref:`java-connection-uri-options` guide.

.. _java-miscellaneous-errors:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.. _java-connect-to-mongodb:
.. _java-mongoclient:

==================
Connect to MongoDB
==================
====================
Create a MongoClient
====================

.. contents:: On this page
:local:
Expand Down
31 changes: 31 additions & 0 deletions source/connection/specify-connection-options.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
.. _java-specify-connection-options:

==========================
Specify Connection Options
==========================

.. toctree::

MongoClient Settings </connection/specify-connection-options/mongoclientsettings>
Connection URI Options </connection/specify-connection-options/connection-options.txt>
Stable API </connection/specify-connection-options/stable-api>
Network Compression </connection/specify-connection-options/network-compression>
JNDI Datasource </connection/specify-connection-options/jndi>
AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>
Connection Security Settings </connection/specify-connection-options/security-connection-options>

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

.. meta::
:keywords: connection string, URI, Atlas, code example


- :ref:`MongoClient Settings <mongoclientsettings>`
- :ref:`Connection URI Options <connection-options>`
- :ref:`Stable API <stable-api-java>`
- :ref:`Network Compression <network-compression>`
- :ref:`JNDI Datasource <jndi>`
- `AWS Lambda <https://www.mongodb.com/docs/atlas/manage-connections-aws-lambda/>`__
- :ref:`Connection Security Options <security-connection-settings>`
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
.. _java-connection-options:
.. _java-connection-uri-options:
.. _connection-options:

==================
Connection Options
==================
======================
Connection URI Options
======================

This section explains MongoDB connection and authentication options
supported by the driver. You can pass the connection options as
supported by the {+driver-short+}. You can pass the connection options as
parameters of the connection URI to specify the behavior of the client.

.. list-table::
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _security-connection-settings:

============================
Connection Security Settings
============================

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

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

MongoDB supports many options for securing your data before and during
transportation. For information about security options, see our :ref:`Security
section <java-security>`, which includes the following:

.. include:: /includes/security/security-pages.rst
5 changes: 5 additions & 0 deletions source/includes/security/security-pages.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
- :ref:`Authentication <authentication-mechanisms>`
- :ref:`In-Use Encryption <java-fle>`
- :ref:`TLS/SSL <tls-ssl>`
- :ref:`SOCKS5 Proxy <java-connect-socks>`
- :ref:`Validate Driver Artifact Signatures <java-validate-signatures>`
12 changes: 11 additions & 1 deletion source/security.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _java-security:

========
Security
========
Expand All @@ -13,4 +15,12 @@ Security
In-Use Encryption </security/encrypt-fields>
TLS/SSL </security/tls>
SOCKS5 Proxy </security/socks>
Validate Driver Artifact Signatures </security/validate-signatures>
Validate Driver Artifact Signatures </security/validate-signatures>

Overview
--------

Learn how to set up security options for your application in the following
sections:

.. include:: /includes/security/security-pages.rst
Loading