Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Add a cli cmd to prune old states according to current settings (…
…#12742) * add PruningCmd and change PruneStores signature * the mimimum default pruning interval is 10 Co-authored-by: Marko <marbar3778@yahoo.com>
- Loading branch information
1 parent
d638ca3
commit d874ace
Showing
4 changed files
with
142 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,117 @@ | ||
| package pruning | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/spf13/cobra" | ||
| "github.com/spf13/viper" | ||
|
|
||
| "github.com/cosmos/cosmos-sdk/client/flags" | ||
| pruningtypes "github.com/cosmos/cosmos-sdk/pruning/types" | ||
| "github.com/cosmos/cosmos-sdk/server" | ||
| servertypes "github.com/cosmos/cosmos-sdk/server/types" | ||
| "github.com/cosmos/cosmos-sdk/store/rootmulti" | ||
| "github.com/tendermint/tendermint/libs/log" | ||
| dbm "github.com/tendermint/tm-db" | ||
| ) | ||
|
|
||
| const FlagAppDBBackend = "app-db-backend" | ||
|
|
||
| // PruningCmd prunes the sdk root multi store history versions based on the pruning options | ||
| // specified by command flags. | ||
| func PruningCmd(appCreator servertypes.AppCreator) *cobra.Command { | ||
| cmd := &cobra.Command{ | ||
| Use: "prune", | ||
| Short: "Prune app history states by keeping the recent heights and deleting old heights", | ||
| Long: `Prune app history states by keeping the recent heights and deleting old heights. | ||
| The pruning option is provided via the '--pruning' flag or alternatively with '--pruning-keep-recent' | ||
| For '--pruning' the options are as follows: | ||
| default: the last 362880 states are kept | ||
| nothing: all historic states will be saved, nothing will be deleted (i.e. archiving node) | ||
| everything: 2 latest states will be kept | ||
| custom: allow pruning options to be manually specified through 'pruning-keep-recent'. | ||
| besides pruning options, database home directory and database backend type should also be specified via flags | ||
| '--home' and '--app-db-backend'. | ||
| valid app-db-backend type includes 'goleveldb', 'cleveldb', 'rocksdb', 'boltdb', and 'badgerdb'. | ||
| `, | ||
| Example: "prune --home './' --app-db-backend 'goleveldb' --pruning 'custom' --pruning-keep-recent 100", | ||
| RunE: func(cmd *cobra.Command, _ []string) error { | ||
| vp := viper.New() | ||
|
|
||
| // Bind flags to the Context's Viper so we can get pruning options. | ||
| if err := vp.BindPFlags(cmd.Flags()); err != nil { | ||
| return err | ||
| } | ||
| pruningOptions, err := server.GetPruningOptionsFromFlags(vp) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Printf("get pruning options from command flags, strategy: %v, keep-recent: %v\n", | ||
| pruningOptions.Strategy, | ||
| pruningOptions.KeepRecent, | ||
| ) | ||
|
|
||
| home := vp.GetString(flags.FlagHome) | ||
| db, err := openDB(home, server.GetAppDBBackend(vp)) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| logger := log.NewTMLogger(log.NewSyncWriter(os.Stdout)) | ||
| app := appCreator(logger, db, nil, vp) | ||
| cms := app.CommitMultiStore() | ||
|
|
||
| rootMultiStore, ok := cms.(*rootmulti.Store) | ||
| if !ok { | ||
| return fmt.Errorf("currently only support the pruning of rootmulti.Store type") | ||
| } | ||
| latestHeight := rootmulti.GetLatestVersion(db) | ||
| // valid heights should be greater than 0. | ||
| if latestHeight <= 0 { | ||
| return fmt.Errorf("the database has no valid heights to prune, the latest height: %v", latestHeight) | ||
| } | ||
|
|
||
| var pruningHeights []int64 | ||
| for height := int64(1); height < latestHeight; height++ { | ||
| if height < latestHeight-int64(pruningOptions.KeepRecent) { | ||
| pruningHeights = append(pruningHeights, height) | ||
| } | ||
| } | ||
| if len(pruningHeights) == 0 { | ||
| fmt.Printf("no heights to prune\n") | ||
| return nil | ||
| } | ||
| fmt.Printf( | ||
| "pruning heights start from %v, end at %v\n", | ||
| pruningHeights[0], | ||
| pruningHeights[len(pruningHeights)-1], | ||
| ) | ||
|
|
||
| err = rootMultiStore.PruneStores(false, pruningHeights) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| fmt.Printf("successfully pruned the application root multi stores\n") | ||
| return nil | ||
| }, | ||
| } | ||
|
|
||
| cmd.Flags().String(flags.FlagHome, "", "The database home directory") | ||
| cmd.Flags().String(FlagAppDBBackend, "", "The type of database for application and snapshots databases") | ||
| cmd.Flags().String(server.FlagPruning, pruningtypes.PruningOptionDefault, "Pruning strategy (default|nothing|everything|custom)") | ||
| cmd.Flags().Uint64(server.FlagPruningKeepRecent, 0, "Number of recent heights to keep on disk (ignored if pruning is not 'custom')") | ||
| cmd.Flags().Uint64(server.FlagPruningInterval, 10, | ||
| `Height interval at which pruned heights are removed from disk (ignored if pruning is not 'custom'), | ||
| this is not used by this command but kept for compatibility with the complete pruning options`) | ||
|
|
||
| return cmd | ||
| } | ||
|
|
||
| func openDB(rootDir string, backendType dbm.BackendType) (dbm.DB, error) { | ||
| dataDir := filepath.Join(rootDir, "data") | ||
| return dbm.NewDB("application", backendType, dataDir) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters