Skip to content

Commit

Permalink
more descriptive overwrite in the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BrendanCoughlan5 committed Jan 27, 2025
1 parent d7a85d0 commit 17c6984
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
3 changes: 2 additions & 1 deletion cmd/restoreSnapshot.go
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ var restoreSnapshotCmd = &cobra.Command{
Short: "Restore database from a snapshot file",
Long: `Restore the database from a previously created snapshot file.
Note: This command restores --database.schema_name only if it's present in InputFile snapshot.
Note: It is recommended to use a fresh, clean database for restoration. Objects in the snapshot will overwrite existing objects in the database.
This command restores --database.schema_name only if it's present in InputFile snapshot.
Follow the snapshot docs if you need to convert the snapshot to a different schema name than was used during snapshot creation.`,
RunE: func(cmd *cobra.Command, args []string) error {
initRestoreSnapshotCmd(cmd)
Expand Down
3 changes: 2 additions & 1 deletion docs/snapshots_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ We heavily recommend syncing from genesis for mainnet and creating your own snap
./bin/sidecar restore-snapshot --help
Restore the database from a previously created snapshot file.

Note: This command restores --database.schema_name only if it's present in InputFile snapshot.
Note: It is recommended to use a fresh, clean database for restoration. Objects in the snapshot will overwrite existing objects in the database.
This command restores --database.schema_name only if it's present in InputFile snapshot.
Follow the snapshot docs if you need to convert the snapshot to a different schema name than was used during snapshot creation.
Usage:
Expand Down

0 comments on commit 17c6984

Please sign in to comment.