From bca823ead667dd752789b1967cad70f230349bce Mon Sep 17 00:00:00 2001 From: Robsdedude Date: Fri, 21 Oct 2022 09:17:34 +0200 Subject: [PATCH] API docs: remove options that were removed in 5.0 `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. --- docs/source/api.rst | 49 --------------------------------------------- 1 file changed, 49 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index 3de8da15..2e484ac6 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -161,8 +161,6 @@ Driver Configuration Additional configuration can be provided via the :class:`neo4j.Driver` constructor. -+ :ref:`session-connection-timeout-ref` -+ :ref:`update-routing-table-timeout-ref` + :ref:`connection-acquisition-timeout-ref` + :ref:`connection-timeout-ref` + :ref:`encrypted-ref` @@ -177,53 +175,6 @@ Additional configuration can be provided via the :class:`neo4j.Driver` construct + :ref:`user-agent-ref` -.. _session-connection-timeout-ref: - -``session_connection_timeout`` ------------------------------- -The maximum amount of time in seconds the session will wait when trying to -establish a usable read/write connection to the remote host. -This encompasses *everything* that needs to happen for this, including, -if necessary, updating the routing table, fetching a connection from the pool, -and, if necessary fully establishing a new connection with the reader/writer. - -Since this process may involve updating the routing table, acquiring a -connection from the pool, or establishing a new connection, it should be chosen -larger than :ref:`update-routing-table-timeout-ref`, -:ref:`connection-acquisition-timeout-ref`, and :ref:`connection-timeout-ref`. - -:Type: ``float`` -:Default: ``120.0`` - -.. versionadded:: 4.4.5 - -.. versionchanged:: 5.0 - - The default value was changed from ``float("inf")`` to ``120.0``. - - -.. _update-routing-table-timeout-ref: - -``update_routing_table_timeout`` --------------------------------- -The maximum amount of time in seconds the driver will attempt to fetch a new -routing table. This encompasses *everything* that needs to happen for this, -including fetching connections from the pool, performing handshakes, and -requesting and receiving a fresh routing table. - -Since this process may involve acquiring a connection from the pool, or -establishing a new connection, it should be chosen larger than -:ref:`connection-acquisition-timeout-ref` and :ref:`connection-timeout-ref`. - -This setting only has an effect for :ref:`neo4j-driver-ref`, but not for -:ref:`bolt-driver-ref` as it does no routing at all. - -:Type: ``float`` -:Default: ``90.0`` - -.. versionadded:: 4.4.5 - - .. _connection-acquisition-timeout-ref: ``connection_acquisition_timeout``