diff --git a/docs/source/api.rst b/docs/source/api.rst index 9a1b4aed5..87044784d 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -262,6 +262,8 @@ connection can be used to perform database related work. ------------- Specify whether to use an encrypted connection between the driver and server. +This setting is only available for URI schemes ``bolt://`` and ``neo4j://`` (:ref:`uri-ref`). + :Type: ``bool`` :Default: ``False`` @@ -346,6 +348,8 @@ For example: --------- Specify how to determine the authenticity of encryption certificates provided by the Neo4j instance on connection. +This setting is only available for URI schemes ``bolt://`` and ``neo4j://`` (:ref:`uri-ref`). + This setting does not have any effect if ``encrypted`` is set to ``False``. :Type: ``neo4j.TRUST_SYSTEM_CA_SIGNED_CERTIFICATES``, ``neo4j.TRUST_ALL_CERTIFICATES`` diff --git a/neo4j/__init__.py b/neo4j/__init__.py index 20fb0d1ca..90774427d 100644 --- a/neo4j/__init__.py +++ b/neo4j/__init__.py @@ -126,9 +126,15 @@ class GraphDatabase: def driver(cls, uri, *, auth=None, **config): """Create a driver. - :param uri: the connection URI for the driver, see :ref:`uri-ref` for available URIs. - :param auth: the authentication details, see :ref:`auth-ref` for available authentication details. - :param config: driver configuration key-word arguments, see :ref:`driver-configuration-ref` for available key-word arguments. + :param uri: the connection URI for the driver, + see :ref:`uri-ref` for available URIs. + :type uri: str + :param auth: the authentication details, + see :ref:`auth-ref` for available authentication details. + :type auth: None or typing.Tuple[typing.Any, typing.Any] or Auth + :param config: driver configuration key-word arguments, + see :ref:`driver-configuration-ref` for available + key-word arguments. :return: :ref:`neo4j-driver-ref` or :ref:`bolt-driver-ref` """