-
Notifications
You must be signed in to change notification settings - Fork 82
DOCCORE-54 Clarify that dump cmd does not support backing up db metadata #2769
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.
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
base: dev
Are you sure you want to change the base?
Changes from all commits
1aea8b0
df50354
f03c23c
39ec57c
b79f45a
8cc2457
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -2,19 +2,20 @@ | |||||||
| [[backup-modes]] | ||||||||
| = Backup modes | ||||||||
|
|
||||||||
| The backup client can operate in two different modes – a _full backup_ and an _differential backup_. | ||||||||
| The backup client can operate in two different modes – a _full backup_ and a _differential backup_. | ||||||||
|
|
||||||||
| [[full-backup]] | ||||||||
| == Full backup | ||||||||
|
|
||||||||
| A full backup is always required initially for the very first backup into a target location. | ||||||||
|
|
||||||||
| [NOTE] | ||||||||
| ==== | ||||||||
| The full backup can be run against both an *online* (using `neo4j-admin database backup`) and an *offline* (using `neo4j-admin database dump`) database. | ||||||||
| ==== | ||||||||
| The full backup can be run against an *online* (using the Enterprise edition command -- `neo4j-admin database backup`) and an *offline* (using `neo4j-admin database dump`) database. | ||||||||
|
|
||||||||
|
|
||||||||
| [role=enterprise-edition] | ||||||||
| === `neo4j-admin database backup` | ||||||||
|
|
||||||||
| .Full backup against an online database | ||||||||
| .Backing up an online database | ||||||||
| ==== | ||||||||
| [source,shell,role=nocopy] | ||||||||
| ---- | ||||||||
|
|
@@ -31,21 +32,29 @@ Doing full backup... | |||||||
| ... | ||||||||
| ---- | ||||||||
| ==== | ||||||||
|
|
||||||||
| The `neo4j-admin database backup` command with the `--type=full` argument creates a xref:backup-restore/online-backup.adoc#backup-artifact[full backup artifact] file in the format of _<databasename><timestamp>.backup_, in the target location specified by `--to-path`. | ||||||||
|
|
||||||||
| The `neo4j-admin database backup` command allows you to include metadata, enabling the backup to store the role-based access control (RBAC) settings associated with the database. | ||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||||
|
|
||||||||
| For more information about online backup options and how to control memory usage, see xref:backup-restore/online-backup.adoc[Back up an online database]. | ||||||||
|
|
||||||||
| [NOTE] | ||||||||
| ==== | ||||||||
| A full online database backup creates a xref:backup-restore/online-backup.adoc#backup-artifact[full backup artifact] in the target location (`--to-path`). | ||||||||
| ==== | ||||||||
|
|
||||||||
| === `neo4j-admin database dump` | ||||||||
|
|
||||||||
| The `neo4j-admin database dump` command creates a single-file archive, that follows the format _<databasename><timestamp>.dump_, and stores it in the xref:configuration/file-locations.adoc#data[_<NEO4J_HOME>/data_] directory. | ||||||||
|
|
||||||||
| Note that when using `neo4j-admin database dump`, only the database contents are backed up; the associated users and roles metadata are not included. | ||||||||
|
|
||||||||
| For more information about performing a full backup against an *offline* database, see xref:backup-restore/offline-backup.adoc[Back up an offline database]. | ||||||||
|
|
||||||||
|
|
||||||||
| [role=enterprise-edition] | ||||||||
| [[differential-backup]] | ||||||||
| == Differential backup | ||||||||
|
|
||||||||
|
|
||||||||
| In the online backup version, after the initial full backup, the subsequent backups attempt to use the differential mode, where just the delta of the transaction logs since the last backup are transferred and used to create a differential backup artifact (stored in the target location). Those differential backup artifacts form a xref:backup-restore/online-backup.adoc#backup-chain[backup chain]. | ||||||||
| In the online backup version, after the initial full backup, subsequent backups attempt to use differential mode, where only the delta of the transaction logs since the last backup is transferred and used to create a differential backup artifact (stored in the target location). | ||||||||
| Those differential backup artifacts form a xref:backup-restore/online-backup.adoc#backup-chain[backup chain]. | ||||||||
| If the required transaction logs are not available on the backup server, then the backup client falls back on performing a full backup instead. | ||||||||
|
|
||||||||
|
|
||||||||
|
|
@@ -60,4 +69,3 @@ Backup complete. | |||||||
| ---- | ||||||||
| ==== | ||||||||
|
|
||||||||
| For more information about online backup options and how to control memory usage, see xref:backup-restore/online-backup.adoc[Back up an online database]. | ||||||||
| Original file line number | Diff line number | Diff line change | ||||||
|---|---|---|---|---|---|---|---|---|
|
|
@@ -193,7 +193,7 @@ The recommended way to restore a database in a cluster is to xref::database-admi | |||||||
| [IMPORTANT] | ||||||||
| ==== | ||||||||
| By default, a database backup includes only the database contents. | ||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I might be wrong, but you have to specify |
||||||||
| If you choose to include metadata, the backup also stores the role-based access control (RBAC) settings associated with the database. | ||||||||
| In the Enterprise edition, the `neo4j-admin database backup` command also allows you to include metadata, enabling the backup to store the role-based access control (RBAC) settings associated with the database. | ||||||||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It backs the metadata by default. Actually, it allows you to not include it if you want. Also, I'm not sure what we meant by settings "? I added a suggestion for the above sentence.
Suggested change
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Where do we say that that metadata is backed up by default?
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. See https://neo4j.com/docs/operations-manual/current/backup-restore/restore-backup/#_restore_users_and_roles_metadata. |
||||||||
|
|
||||||||
| When restoring, you have the flexibility to define the target topology (how many primaries and secondaries are desired for the database), which may differ from the topology at backup time. | ||||||||
| The database will then be allocated across the available servers according to that topology. | ||||||||
|
|
||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.