Skip to content

Commit ca614f7

Browse files
Document the updated include-metadata=users for backup command (#2683)
Co-authored-by: Phil Wright <[email protected]>
1 parent 6cf9a21 commit ca614f7

File tree

2 files changed

+19
-11
lines changed

2 files changed

+19
-11
lines changed

modules/ROOT/pages/backup-restore/online-backup.adoc

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -64,13 +64,11 @@ For more information, see xref:backup-restore/online-backup.adoc#online-backup-c
6464

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

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

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

134132
- `roles` - include commands to create the roles and privileges (for both database and graph) that affect the use of the database.
135-
- `users` - include commands to create the users that can use the database and their role assignments.
133+
- `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.
136134
- `all` - include both `roles` and `users`.
137135
- `none` - does not include any metadata.
138136
[NOTE]

modules/ROOT/pages/changes-deprecations-removals.adoc

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -598,9 +598,19 @@ The section covers changes to Neo4j server functionality across different areas.
598598

599599
=== Neo4j-admin tool
600600

601+
Neo4j 2025.10::
602+
603+
* label:enterprise[Enterprise Edition] The `neo4j-admin database backup` command.
604+
+
605+
The `--include-metadata=none|all|users[=user1,user2]|roles` option is changed.
606+
Now it allows filtering users when performing a database backup. +
607+
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.
608+
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.
609+
For details, refer to xref:backup-restore/online-backup.adoc[].
610+
601611
Neo4j 2025.01::
602612

603-
* The `neo4j-admin database copy` command.
613+
* label:enterprise[Enterprise Edition] The `neo4j-admin database copy` command.
604614
+
605615
The functionality of the `--from-pagecache=<size>` option is changed. +
606616
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.

0 commit comments

Comments
 (0)