Skip to content

Document Cypher Shell --transaction-timeout #2748

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

Open
loveleif wants to merge 9 commits into
base: dev
Choose a base branch
from
Open

Document Cypher Shell --transaction-timeout #2748

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
565c48a
Document Cypher Shell --transaction-timeout
loveleif Dec 1, 2025
d7f22ba
Fix
loveleif Dec 1, 2025
3b07119
Fix
loveleif Dec 1, 2025
366d654
Add example
loveleif Dec 3, 2025
ce81b77
Remove label
loveleif Dec 3, 2025
46b293a
Move section
loveleif Dec 3, 2025
7477579
Update modules/ROOT/pages/cypher-shell.adoc
loveleif Dec 3, 2025
36d6d27
Update modules/ROOT/pages/cypher-shell.adoc
loveleif Dec 3, 2025
d89b8cc
Update modules/ROOT/pages/cypher-shell.adoc
loveleif Dec 3, 2025
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
39 changes: 38 additions & 1 deletion modules/ROOT/pages/cypher-shell.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ cypher-shell [-h] [-a ADDRESS] [-u USERNAME] [--impersonate IMPERSONATE] [-p PAS
[--non-interactive] [--sample-rows SAMPLE-ROWS] [--wrap {true,false}] [-v]
[--driver-version] [-f FILE] [--change-password] [--log [LOG-FILE]]
[--history HISTORY-BEHAVIOUR] [--notifications] [--idle-timeout IDLE-TIMEOUT]
[--error-format {gql,legacy,stacktrace}] [--fail-fast | --fail-at-end] [cypher]
[--error-format {gql,legacy,stacktrace}]
[--transaction-timeout TRANSACTION-TIMEOUT] [--fail-fast | --fail-at-end]
[cypher]
----

== Positional arguments
Expand Down Expand Up @@ -123,6 +125,10 @@ Can also be set using the environment variable `NEO4J_CYPHER_SHELL_HISTORY`.
|--error-format {gql,legacy,stacktrace}
|Controls how errors are displayed.
|gql label:new[Changed in 2025.06]

|--transaction-timeout TRANSACTION-TIMEOUT
|Transaction timeout. You can specify the duration using the format `<hours>h<minutes>m<seconds>s`, for example `1h` (1 hour), `1h30m` (1 hour 30 minutes), or `30m` (30 minutes).
|disable
|===

== Connection arguments
Expand Down Expand Up @@ -567,6 +573,37 @@ ready to start consuming query after 1 ms, results consumed after another 1 ms
----
====

[[cypher-shell-transaction-timeout]]
== Transaction Timeout

You can start Cypher Shell with a specific transaction timeout, which will apply to all transactions during the session.

.Start with transaction timeout argument
====

[source, shell]
----
bin/cypher-shell -u neo4j -p <password> --transaction-timeout 10m
----

Execute a very long running query.

[source, shell]
----
UNWIND range(0, 90_000) AS x
CALL apoc.util.sleep(100)
RETURN sum(x) AS sum;
----

After ~10 minutes, the transaction times out.

[queryresult]
----
25N14: invalid transaction state - transaction termination client error. The transaction has been terminated. Retry your operation in a new transaction, and you should see a successful result. Reason: The transaction has not completed within the timeout specified at its start by the client. You may want to retry with a longer timeout.
----
====


[[cypher-shell-procedures]]
== Procedures

Expand Down