Skip to content

[4.4] API docs: be more explicit about driver factory parameters #884

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.

Sign up for GitHub

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 3 commits into from
Jan 9, 2023
Merged

[4.4] API docs: be more explicit about driver factory parameters #884

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c4d8ece
API docs: cannot combine +s/+ssc schemes with some settings
robsdedude Jan 3, 2023
e6d476c
API docs: be more explicit about driver factory parameters
robsdedude Jan 3, 2023
f63eada
Merge branch '4.4' into api-docs-driver-config-4.4
robsdedude Jan 3, 2023
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
4 changes: 4 additions & 0 deletions docs/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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``

Expand Down Expand Up @@ -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``
Expand Down
12 changes: 9 additions & 3 deletions neo4j/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`
"""
Expand Down