Skip to content

Commit 26f4bca

Browse files
adding clarification to neo4j-admin backup command description (#1227) (#1237)
Cherry-picked from #1227 Co-authored-by: Phil Wright <[email protected]>
1 parent ed68bbd commit 26f4bca

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

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

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -128,11 +128,14 @@ With a single `*` as a value, you can back up all the databases of the DBMS.
128128
|
129129

130130
|--include-metadata=none\|all\|users\|roles
131-
|Include metadata in file. Can't be used for backing system database.
132-
- roles - commands to create the roles and privileges (for both database and graph) that affect the use of the database
133-
- users - commands to create the users that can use the database and their role assignments
134-
- all - include roles and users
135-
- none - don't include any metadata
131+
|Include metadata in the file. This cannot be used for backing up the `system` database. Possible values are:
132+
133+
- `roles` - include commands to create the roles and privileges (for both database and graph) that affect the use of the database.
134+
- `users` - include commands to create the users that can use the database and their role assignments.
135+
- `all` - include both `roles` and `users`.
136+
- `none` - does not include any metadata.
137+
[NOTE]
138+
`roles` and `users` that do not have database-related privileges are not included in the backup (e.g. those with only DBMS or no privileges). It is recommended to use `SHOW USERS` and `SHOW ROLES` to get the complete list of users and roles in these situations.
136139
|all
137140

138141
|--inspect-path=<path>

0 commit comments

Comments
 (0)