diff --git a/src/neo4j/_async/work/session.py b/src/neo4j/_async/work/session.py index 51610e1da..fb3233157 100644 --- a/src/neo4j/_async/work/session.py +++ b/src/neo4j/_async/work/session.py @@ -468,14 +468,15 @@ async def begin_transaction( the transaction timeout in seconds. Transactions that execute longer than the configured timeout will be terminated by the database. - This functionality allows to limit query/transaction execution - time. - The Specified timeout overrides the default timeout configured in + This functionality allows user code to limit query/transaction + execution time. + The specified timeout overrides the default timeout configured in the database using the ``db.transaction.timeout`` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than ``db.transaction.timeout`` will be ignored and - will fall back to the default for server versions 4.2 to including - 5.2. The value should not represent a negative duration. + will fall back to the default for server versions between 4.2 and + 5.2 (inclusive). + The value should not represent a negative duration. A ``0`` duration will make the transaction execute indefinitely. :data:`None` will use the default timeout configured on the server. diff --git a/src/neo4j/_sync/work/session.py b/src/neo4j/_sync/work/session.py index a0217662a..8869078bf 100644 --- a/src/neo4j/_sync/work/session.py +++ b/src/neo4j/_sync/work/session.py @@ -468,14 +468,15 @@ def begin_transaction( the transaction timeout in seconds. Transactions that execute longer than the configured timeout will be terminated by the database. - This functionality allows to limit query/transaction execution - time. - The Specified timeout overrides the default timeout configured in + This functionality allows user code to limit query/transaction + execution time. + The specified timeout overrides the default timeout configured in the database using the ``db.transaction.timeout`` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than ``db.transaction.timeout`` will be ignored and - will fall back to the default for server versions 4.2 to including - 5.2. The value should not represent a negative duration. + will fall back to the default for server versions between 4.2 and + 5.2 (inclusive). + The value should not represent a negative duration. A ``0`` duration will make the transaction execute indefinitely. :data:`None` will use the default timeout configured on the server. diff --git a/src/neo4j/_work/query.py b/src/neo4j/_work/query.py index addb3aba6..b54df2284 100644 --- a/src/neo4j/_work/query.py +++ b/src/neo4j/_work/query.py @@ -51,14 +51,15 @@ class Query: the transaction timeout in seconds. Transactions that execute longer than the configured timeout will be terminated by the database. - This functionality allows to limit query/transaction execution - time. - The Specified timeout overrides the default timeout configured in + This functionality allows user code to limit query/transaction + execution time. + The specified timeout overrides the default timeout configured in the database using the ``db.transaction.timeout`` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than ``db.transaction.timeout`` will be ignored and - will fall back to the default for server versions 4.2 to including - 5.2. The value should not represent a negative duration. + will fall back to the default for server versions between 4.2 and + 5.2 (inclusive). + The value should not represent a negative duration. A ``0`` duration will make the transaction execute indefinitely. :data:`None` will use the default timeout configured on the server. :type timeout: float | None @@ -114,14 +115,15 @@ def count_people_tx(tx): the transaction timeout in seconds. Transactions that execute longer than the configured timeout will be terminated by the database. - This functionality allows to limit query/transaction execution - time. - The Specified timeout overrides the default timeout configured in + This functionality allows user code to limit query/transaction + execution time. + The specified timeout overrides the default timeout configured in the database using the ``db.transaction.timeout`` setting (``dbms.transaction.timeout`` before Neo4j 5.0). Values higher than ``db.transaction.timeout`` will be ignored and - will fall back to the default for server versions 4.2 to including - 5.2. The value should not represent a negative duration. + will fall back to the default for server versions between 4.2 and + 5.2 (inclusive). + The value should not represent a negative duration. A ``0`` duration will make the transaction execute indefinitely. :data:`None` will use the default timeout configured on the server. :type timeout: float | None