Skip to content

Commit 3873dfd

Browse files
authored
API docs: remove options that were removed in 5.0 (#838)
`session_connection_timeout` and `update_routing_table_timeout` were introduced in 4.4.5, deprecated in 4.4.6, and removed in 5.0.0 as they were deemed to be superfluous. However, the 5.x docs did not reflect this.
1 parent a1abf24 commit 3873dfd

File tree

1 file changed

+0
-49
lines changed

1 file changed

+0
-49
lines changed

docs/source/api.rst

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -161,8 +161,6 @@ Driver Configuration
161161

162162
Additional configuration can be provided via the :class:`neo4j.Driver` constructor.
163163

164-
+ :ref:`session-connection-timeout-ref`
165-
+ :ref:`update-routing-table-timeout-ref`
166164
+ :ref:`connection-acquisition-timeout-ref`
167165
+ :ref:`connection-timeout-ref`
168166
+ :ref:`encrypted-ref`
@@ -177,53 +175,6 @@ Additional configuration can be provided via the :class:`neo4j.Driver` construct
177175
+ :ref:`user-agent-ref`
178176

179177

180-
.. _session-connection-timeout-ref:
181-
182-
``session_connection_timeout``
183-
------------------------------
184-
The maximum amount of time in seconds the session will wait when trying to
185-
establish a usable read/write connection to the remote host.
186-
This encompasses *everything* that needs to happen for this, including,
187-
if necessary, updating the routing table, fetching a connection from the pool,
188-
and, if necessary fully establishing a new connection with the reader/writer.
189-
190-
Since this process may involve updating the routing table, acquiring a
191-
connection from the pool, or establishing a new connection, it should be chosen
192-
larger than :ref:`update-routing-table-timeout-ref`,
193-
:ref:`connection-acquisition-timeout-ref`, and :ref:`connection-timeout-ref`.
194-
195-
:Type: ``float``
196-
:Default: ``120.0``
197-
198-
.. versionadded:: 4.4.5
199-
200-
.. versionchanged:: 5.0
201-
202-
The default value was changed from ``float("inf")`` to ``120.0``.
203-
204-
205-
.. _update-routing-table-timeout-ref:
206-
207-
``update_routing_table_timeout``
208-
--------------------------------
209-
The maximum amount of time in seconds the driver will attempt to fetch a new
210-
routing table. This encompasses *everything* that needs to happen for this,
211-
including fetching connections from the pool, performing handshakes, and
212-
requesting and receiving a fresh routing table.
213-
214-
Since this process may involve acquiring a connection from the pool, or
215-
establishing a new connection, it should be chosen larger than
216-
:ref:`connection-acquisition-timeout-ref` and :ref:`connection-timeout-ref`.
217-
218-
This setting only has an effect for :ref:`neo4j-driver-ref`, but not for
219-
:ref:`bolt-driver-ref` as it does no routing at all.
220-
221-
:Type: ``float``
222-
:Default: ``90.0``
223-
224-
.. versionadded:: 4.4.5
225-
226-
227178
.. _connection-acquisition-timeout-ref:
228179

229180
``connection_acquisition_timeout``

0 commit comments

Comments
 (0)