Skip to content

Docs: improve wording around transaction timeout #970

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
Sep 28, 2023
Merged

Docs: improve wording around transaction timeout #970

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
8666efa
Docs: improve wording around transaction timeout
robsdedude Sep 27, 2023
905abf6
Fix capitalization
robsdedude Sep 27, 2023
c8624b3
Fix docs in sync code as well
robsdedude Sep 27, 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
11 changes: 6 additions & 5 deletions src/neo4j/_async/work/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
11 changes: 6 additions & 5 deletions src/neo4j/_sync/work/session.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
22 changes: 12 additions & 10 deletions src/neo4j/_work/query.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down