Skip to content

Commit 99febd2

Browse files
authored
API docs: add CALL {...} IN TRANSACTIONS (#712)
Just like auto-commit transactions are required for `PERIODIC COMMIT` queries (Neo4j <= 4.4) they are required for the new `CALL {...} IN TRANSACTIONS` queries (Neo4j >= 5.0).
1 parent 743aae6 commit 99febd2

File tree

2 files changed

+18
-10
lines changed

2 files changed

+18
-10
lines changed

docs/source/api.rst

+8-4
Original file line numberDiff line numberDiff line change
@@ -653,10 +653,14 @@ Each has pros and cons but if in doubt, use a managed transaction with a `transa
653653

654654
Auto-commit Transactions
655655
========================
656-
Auto-commit transactions are the simplest form of transaction, available via :py:meth:`neo4j.Session.run`.
657-
658-
These are easy to use but support only one statement per transaction and are not automatically retried on failure.
659-
Auto-commit transactions are also the only way to run ``PERIODIC COMMIT`` statements, since this Cypher clause manages its own transactions internally.
656+
Auto-commit transactions are the simplest form of transaction, available via
657+
:py:meth:`neo4j.Session.run`. These are easy to use but support only one
658+
statement per transaction and are not automatically retried on failure.
659+
660+
Auto-commit transactions are also the only way to run ``PERIODIC COMMIT``
661+
(only Neo4j 4.4 and earlier) or ``CALL {...} IN TRANSACTIONS`` (Neo4j 5.0 and
662+
newer) statements, since those Cypher clauses manage their own transactions
663+
internally.
660664

661665
Example:
662666

docs/source/async_api.rst

+10-6
Original file line numberDiff line numberDiff line change
@@ -351,12 +351,16 @@ Each has pros and cons but if in doubt, use a managed transaction with a `transa
351351

352352
.. _async-auto-commit-transactions-ref:
353353

354-
Async Auto-commit Transactions
355-
==============================
356-
Auto-commit transactions are the simplest form of transaction, available via :py:meth:`neo4j.AsyncSession.run`.
357-
358-
These are easy to use but support only one statement per transaction and are not automatically retried on failure.
359-
Auto-commit transactions are also the only way to run ``PERIODIC COMMIT`` statements, since this Cypher clause manages its own transactions internally.
354+
Auto-commit Transactions
355+
========================
356+
Auto-commit transactions are the simplest form of transaction, available via
357+
:py:meth:`neo4j.Session.run`. These are easy to use but support only one
358+
statement per transaction and are not automatically retried on failure.
359+
360+
Auto-commit transactions are also the only way to run ``PERIODIC COMMIT``
361+
(only Neo4j 4.4 and earlier) or ``CALL {...} IN TRANSACTIONS`` (Neo4j 5.0 and
362+
newer) statements, since those Cypher clauses manage their own transactions
363+
internally.
360364

361365
Example:
362366

0 commit comments

Comments
 (0)