From 17c698401641a4e147586ecdc30d04794aeabcbd Mon Sep 17 00:00:00 2001 From: brendan-coughlan Date: Mon, 27 Jan 2025 06:30:52 -0800 Subject: [PATCH] more descriptive overwrite in the docs --- cmd/restoreSnapshot.go | 3 ++- docs/snapshots_docs.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/cmd/restoreSnapshot.go b/cmd/restoreSnapshot.go index 4b6d8a4a..795cb3a2 100644 --- a/cmd/restoreSnapshot.go +++ b/cmd/restoreSnapshot.go @@ -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) diff --git a/docs/snapshots_docs.md b/docs/snapshots_docs.md index 5256a2c5..e72a6db0 100644 --- a/docs/snapshots_docs.md +++ b/docs/snapshots_docs.md @@ -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: