Skip to content

Update the description of the history option #2543

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 4 commits into from
Aug 19, 2025
Merged

Update the description of the history option #2543

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15e2097
Update the description of the history option
NataliaIvakina Aug 18, 2025
a8c7815
Update changes-deprecations-removals.adoc
NataliaIvakina Aug 18, 2025
68908fb
Update modules/ROOT/pages/changes-deprecations-removals.adoc
NataliaIvakina Aug 18, 2025
a9a093e
Update modules/ROOT/pages/cypher-shell.adoc
NataliaIvakina Aug 19, 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
4 changes: 4 additions & 0 deletions modules/ROOT/pages/changes-deprecations-removals.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,10 @@ For details, refer to the xref:backup-restore/copy-database.adoc#off-heap-memory

=== Cypher Shell

Neo4j 2025.07::

A new argument `disable` is added to the `--history` option.

Neo4j 2025.06::

The default value of the `--error-format` option is changed from `legacy` to `gql`.
Expand Down
2 changes: 1 addition & 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 @@ -106,7 +106,7 @@ After executing all statements, Cypher Shell shuts down.
|

|--history HISTORY-BEHAVIOUR
|File path of a query and a command history file or `in-memory` for in-memory history.
|File path of a query and a command history file, `in-memory` for in-memory history or `disable` to disable history.
Copy link
Collaborator Author

@NataliaIvakina NataliaIvakina Aug 18, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I assume we also need to say a few words about the newly added argument --history disable.
To add a note?
If we add just a label 'Changed in 2025.08`, it won't be informative.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's a very small thing requested by a specific customer, personally I would be fine with the change label.

If the option is omitted, history is saved to `<user home>/.neo4j/.cypher_shell_history`.
Can also be set using the environment variable `NEO4J_CYPHER_SHELL_HISTORY`.
|
Expand Down