Skip to content

Document the updated include-metadata=users for backup command #2683

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 5 commits into from
Oct 23, 2025
Merged

Document the updated include-metadata=users for backup command #2683

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
68f291b
Document the updated `include-metadata=users` for backup command
NataliaIvakina Oct 22, 2025
2dd4000
Update modules/ROOT/pages/backup-restore/online-backup.adoc
NataliaIvakina Oct 22, 2025
6c65844
Update online-backup.adoc
NataliaIvakina Oct 22, 2025
3d25747
Update syntax according to the help output
NataliaIvakina Oct 22, 2025
f52669b
Update modules/ROOT/pages/changes-deprecations-removals.adoc
NataliaIvakina Oct 22, 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
18 changes: 8 additions & 10 deletions modules/ROOT/pages/backup-restore/online-backup.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,11 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c

[source,role=noheader]
----
neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [--verbose]
[--compress[=true|false]] [--keep-failed[=true|false]]
[--parallel-recovery[=true|false]] [--remote-address-resolution
[=true|false]] [--additional-config=<file>]
[--include-metadata=none|all|users|roles] [--inspect-path=<path>]
[--pagecache=<size>] [--temp-path=<path>] [--to-path=<path>]
[--type=<type>] [--from=<host:port>[,<host:port>...]]... [<database>...]
neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [--verbose] [--compress[=true|false]]
[--keep-failed[=true|false]] [--parallel-recovery[=true|false]] [--remote-address-resolution
[=true|false]] [--additional-config=<file>] [--include-metadata=none|all|users[=user1,user2]
|roles] [--inspect-path=<path>] [--pagecache=<size>] [--temp-path=<path>]
[--to-path=<path>] [--type=<type>] [--from=<host:port>[,<host:port>...]]... [<database>...]
----

=== Description
Expand Down Expand Up @@ -128,11 +126,11 @@ If <database> is "*", `neo4j-admin` will attempt to back up all databases of the
|Show this help message and exit.
|

|--include-metadata=none\|all\|users\|roles
|Include metadata in the file. This cannot be used for backing up the `system` database. Possible values are:
|--include-metadata=none\|all\|users[=user1,user2]\|roles
|label:new[Changed in 2025.10] Include metadata in the file. This cannot be used for backing up the `system` database. Possible values are:

- `roles` - include commands to create the roles and privileges (for both database and graph) that affect the use of the database.
- `users` - include commands to create the users that can use the database and their role assignments.
- `users` - include commands to create the users that can use the database and their role assignments. If a list of users is specified (e.g. `users=alice,bob,charlie`), only those users are included in the backup.
- `all` - include both `roles` and `users`.
- `none` - does not include any metadata.
[NOTE]
Expand Down
12 changes: 11 additions & 1 deletion modules/ROOT/pages/changes-deprecations-removals.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,9 +598,19 @@ The section covers changes to Neo4j server functionality across different areas.

=== Neo4j-admin tool

Neo4j 2025.10::

* label:enterprise[Enterprise Edition] The `neo4j-admin database backup` command.
+
The `--include-metadata=none|all|users[=user1,user2]|roles` option is changed.
Now it allows filtering users when performing a database backup. +
Previously, if you specified `users` with `--include-metadata`, the backup file would include commands to create the users that can use the database and their role assignments.
Starting from 2025.10, you can define a list of specific users (e.g., `users=alice,bob,charlie`), which means only those users are included in the backup.
For details, refer to xref:backup-restore/online-backup.adoc[].

Neo4j 2025.01::

* The `neo4j-admin database copy` command.
* label:enterprise[Enterprise Edition] The `neo4j-admin database copy` command.
+
The functionality of the `--from-pagecache=<size>` option is changed. +
Instead of specifying how much cache to allocate when reading the source, now you can control the maximum amount of off-heap memory used for the copy operation, both for reading and writing.
Expand Down