From 68f291be36b7ca356fbe192e87db386182c87cf8 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Wed, 22 Oct 2025 13:23:19 +0200 Subject: [PATCH 1/5] Document the updated `include-metadata=users` for backup command --- .../ROOT/pages/backup-restore/online-backup.adoc | 13 +++++++------ .../ROOT/pages/changes-deprecations-removals.adoc | 12 +++++++++++- 2 files changed, 18 insertions(+), 7 deletions(-) diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index 995d65cc7..d4abf3f1e 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -68,9 +68,10 @@ neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [ [--compress[=true|false]] [--keep-failed[=true|false]] [--parallel-recovery[=true|false]] [--remote-address-resolution [=true|false]] [--additional-config=] - [--include-metadata=none|all|users|roles] [--inspect-path=] - [--pagecache=] [--temp-path=] [--to-path=] - [--type=] [--from=[,...]]... [...] + [--include-metadata=none|all|users[=user1,user2]|roles] + [--inspect-path=] [--pagecache=] [--temp-path=] + [--to-path=] [--type=] [--from=[,...]]... [...] ---- === Description @@ -128,11 +129,11 @@ If 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] diff --git a/modules/ROOT/pages/changes-deprecations-removals.adoc b/modules/ROOT/pages/changes-deprecations-removals.adoc index f494a6e0a..e388819d9 100644 --- a/modules/ROOT/pages/changes-deprecations-removals.adoc +++ b/modules/ROOT/pages/changes-deprecations-removals.adoc @@ -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 and their role assignments 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=` 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. From 2dd4000f5156105829fa63758b4535d22fe1318b Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Wed, 22 Oct 2025 13:32:20 +0200 Subject: [PATCH 2/5] Update modules/ROOT/pages/backup-restore/online-backup.adoc --- modules/ROOT/pages/backup-restore/online-backup.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index d4abf3f1e..ed8ac7226 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -68,7 +68,7 @@ neo4j-admin database backup [-h] [--expand-commands] [--prefer-diff-as-parent] [ [--compress[=true|false]] [--keep-failed[=true|false]] [--parallel-recovery[=true|false]] [--remote-address-resolution [=true|false]] [--additional-config=] - [--include-metadata=none|all|users[=user1,user2]|roles] + [--include-metadata=none|all|users[=user1,user2] |roles] [--inspect-path=] [--pagecache=] [--temp-path=] [--to-path=] [--type=] [--from=[,...]]... [...] From 6c6584416467af51407ee7fb0195e747e71272fe Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Wed, 22 Oct 2025 14:40:50 +0200 Subject: [PATCH 3/5] Update online-backup.adoc From 3d257479838c47574f9a0318d460201b66e6d6d7 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:27:36 +0200 Subject: [PATCH 4/5] Update syntax according to the help output --- .../ROOT/pages/backup-restore/online-backup.adoc | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/modules/ROOT/pages/backup-restore/online-backup.adoc b/modules/ROOT/pages/backup-restore/online-backup.adoc index ed8ac7226..67c6445d8 100644 --- a/modules/ROOT/pages/backup-restore/online-backup.adoc +++ b/modules/ROOT/pages/backup-restore/online-backup.adoc @@ -64,14 +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=] - [--include-metadata=none|all|users[=user1,user2] |roles] - [--inspect-path=] [--pagecache=] [--temp-path=] - [--to-path=] [--type=] [--from=[,...]]... [...] +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=] [--include-metadata=none|all|users[=user1,user2] + |roles] [--inspect-path=] [--pagecache=] [--temp-path=] + [--to-path=] [--type=] [--from=[,...]]... [...] ---- === Description From f52669b2f65ed138ceda08a03784bd7f75b80e73 Mon Sep 17 00:00:00 2001 From: Natalia Ivakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Wed, 22 Oct 2025 15:35:50 +0200 Subject: [PATCH 5/5] Update modules/ROOT/pages/changes-deprecations-removals.adoc Co-authored-by: Phil Wright <95368282+phil198@users.noreply.github.com> --- modules/ROOT/pages/changes-deprecations-removals.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/modules/ROOT/pages/changes-deprecations-removals.adoc b/modules/ROOT/pages/changes-deprecations-removals.adoc index e388819d9..d6d4ee7c4 100644 --- a/modules/ROOT/pages/changes-deprecations-removals.adoc +++ b/modules/ROOT/pages/changes-deprecations-removals.adoc @@ -605,7 +605,7 @@ Neo4j 2025.10:: 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 and their role assignments are included in the backup. +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::