Skip to content

Commit 719c0c5

Browse files
authored
[v5.5] DOCSP-45102 Document lack of support for domain socket connections (#141) (#142)
1 parent 697a69d commit 719c0c5

File tree

5 files changed

+14
-9
lines changed

5 files changed

+14
-9
lines changed

source/connect.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,8 @@ You can connect to multiple ``mongos`` instances in the following ways:
144144
new ServerAddress("<second hostname", <second port>))))
145145
.build());
146146

147+
.. include:: /includes/connect/domain-socket.rst
148+
147149
Connection Options
148150
~~~~~~~~~~~~~~~~~~
149151

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
.. important::
2+
3+
The {+driver-short+} does not support `UnixServerAddress
4+
<{+core-api+}/UnixServerAddress.html>`__ objects or domain socket
5+
connections. To use a domain socket to connect, use the :driver:`Java Sync
6+
driver. </java/sync/current/>` Otherwise, use a `ServerAddress
7+
<{+core-api+}/ServerAddress.html>`__ object to connect from the
8+
{+driver-short+}.

source/security/auth.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ credential by using the ``createCredential()`` static factory method:
6161
.credential(credential)
6262
.build());
6363

64+
.. include:: /includes/connect/domain-socket.rst
65+
6466
Or, you can use a connection string without explicitly specifying the
6567
authentication mechanism:
6668

source/security/enterprise-authentication.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ connection settings. Select the
5252
:guilabel:`MongoCredential` tab in the following sections to see the syntax for
5353
authenticating using a ``MongoCredential``.
5454

55+
.. include:: /includes/connect/domain-socket.rst
56+
5557
Mechanisms
5658
----------
5759

source/upgrade.txt

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -178,15 +178,6 @@ This driver version introduces the following breaking changes:
178178
Instead of ``getSocketAddresses()``, use the ``getAllByName()`` instance
179179
method of ``java.net.InetAddress``.
180180

181-
- Removes the `UnixServerAddress <{+core-api+}/UnixServerAddress.html>`__
182-
methods ``getSocketAddress()`` and ``getUnixSocketAddress()``.
183-
184-
Instead of ``getUnixSocketAddress()``, construct an instance of
185-
``jnr.unixsocket.UnixSocketAddress``. Pass the full path of the UNIX
186-
socket file to the constructor. By default, MongoDB creates a UNIX
187-
socket file located at ``"/tmp/mongodb-27017.sock"``. To learn more
188-
about the ``UnixSocketAddress``, see the `UnixSocketAddress <https://www.javadoc.io/doc/com.github.jnr/jnr-unixsocket/latest/jnr/unixsocket/UnixSocketAddress.html>`__ API documentation.
189-
190181
- Removes the ``Parameterizable`` interface. Instead of
191182
implementing this interface on a custom ``Codec`` type,
192183
override the ``CodecProvider.get()`` method on the

0 commit comments

Comments
 (0)