Skip to content

API docs: add CALL {...} IN TRANSACTIONS #712

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.

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 1 commit into from
Apr 25, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 8 additions & 4 deletions docs/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -653,10 +653,14 @@ Each has pros and cons but if in doubt, use a managed transaction with a `transa

Auto-commit Transactions
========================
Auto-commit transactions are the simplest form of transaction, available via :py:meth:`neo4j.Session.run`.

These are easy to use but support only one statement per transaction and are not automatically retried on failure.
Auto-commit transactions are also the only way to run ``PERIODIC COMMIT`` statements, since this Cypher clause manages its own transactions internally.
Auto-commit transactions are the simplest form of transaction, available via
:py:meth:`neo4j.Session.run`. These are easy to use but support only one
statement per transaction and are not automatically retried on failure.

Auto-commit transactions are also the only way to run ``PERIODIC COMMIT``
(only Neo4j 4.4 and earlier) or ``CALL {...} IN TRANSACTIONS`` (Neo4j 5.0 and
Copy link
Contributor

@fbiville fbiville Apr 25, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

newer) statements, since those Cypher clauses manage their own transactions
internally.

Example:

Expand Down
16 changes: 10 additions & 6 deletions docs/source/async_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -351,12 +351,16 @@ Each has pros and cons but if in doubt, use a managed transaction with a `transa

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

Async Auto-commit Transactions
==============================
Auto-commit transactions are the simplest form of transaction, available via :py:meth:`neo4j.AsyncSession.run`.

These are easy to use but support only one statement per transaction and are not automatically retried on failure.
Auto-commit transactions are also the only way to run ``PERIODIC COMMIT`` statements, since this Cypher clause manages its own transactions internally.
Auto-commit Transactions
========================
Auto-commit transactions are the simplest form of transaction, available via
:py:meth:`neo4j.Session.run`. These are easy to use but support only one
statement per transaction and are not automatically retried on failure.

Auto-commit transactions are also the only way to run ``PERIODIC COMMIT``
(only Neo4j 4.4 and earlier) or ``CALL {...} IN TRANSACTIONS`` (Neo4j 5.0 and
newer) statements, since those Cypher clauses manage their own transactions
internally.

Example:

Expand Down