Browse Source

config: add rocksdb as a db backend option (#4239)

Closes #3831

The support for rocksdb was added a while back in
https://github.com/tendermint/tm-db/pull/12. This commit merely updates
the documentation.
pull/4242/head
Anton Kaliaev 5 years ago
committed by GitHub
parent
commit
15e80d2448
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 18 additions and 5 deletions
  1. +2
    -1
      CHANGELOG_PENDING.md
  2. +1
    -1
      cmd/tendermint/commands/run_node.go
  3. +5
    -1
      config/config.go
  4. +5
    -1
      config/toml.go
  5. +5
    -1
      docs/tendermint-core/configuration.md

+ 2
- 1
CHANGELOG_PENDING.md View File

@ -18,7 +18,7 @@ and a validator address plus a timestamp. Note we may remove the validator
address & timestamp fields in the future (see ADR-25). address & timestamp fields in the future (see ADR-25).
Special thanks to external contributors on this release: Special thanks to external contributors on this release:
@erikgrinaker, @PSalant726, @gchaincl, @gregzaitsev, @princesinha19
@erikgrinaker, @PSalant726, @gchaincl, @gregzaitsev, @princesinha19, @Stumble
Friendly reminder, we have a [bug bounty Friendly reminder, we have a [bug bounty
program](https://hackerone.com/tendermint). program](https://hackerone.com/tendermint).
@ -98,6 +98,7 @@ program](https://hackerone.com/tendermint).
- [p2p] \#4053 Add `unconditional_peer_ids` and `persistent_peers_max_dial_period` config variables (see ADR-050) (@dongsam) - [p2p] \#4053 Add `unconditional_peer_ids` and `persistent_peers_max_dial_period` config variables (see ADR-050) (@dongsam)
- [cli] \#4234 Add `--db_backend and --db_dir` flags (@princesinha19) - [cli] \#4234 Add `--db_backend and --db_dir` flags (@princesinha19)
- [cli] \#4113 Add optional `--genesis_hash` flag to check genesis hash upon startup - [cli] \#4113 Add optional `--genesis_hash` flag to check genesis hash upon startup
- [config] \#3831 Add support for [RocksDB](https://rocksdb.org/) (@Stumble)
### IMPROVEMENTS: ### IMPROVEMENTS:


+ 1
- 1
cmd/tendermint/commands/run_node.go View File

@ -85,7 +85,7 @@ func AddNodeFlags(cmd *cobra.Command) {
cmd.Flags().String( cmd.Flags().String(
"db_backend", "db_backend",
config.DBBackend, config.DBBackend,
"Database backend: goleveldb | cleveldb | boltdb")
"Database backend: goleveldb | cleveldb | boltdb | rocksdb")
cmd.Flags().String( cmd.Flags().String(
"db_dir", "db_dir",
config.DBPath, config.DBPath,


+ 5
- 1
config/config.go View File

@ -160,7 +160,7 @@ type BaseConfig struct { //nolint: maligned
// and verifying their commits // and verifying their commits
FastSyncMode bool `mapstructure:"fast_sync"` FastSyncMode bool `mapstructure:"fast_sync"`
// Database backend: goleveldb | cleveldb | boltdb
// Database backend: goleveldb | cleveldb | boltdb | rocksdb
// * goleveldb (github.com/syndtr/goleveldb - most popular implementation) // * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
// - pure go // - pure go
// - stable // - stable
@ -172,6 +172,10 @@ type BaseConfig struct { //nolint: maligned
// - EXPERIMENTAL // - EXPERIMENTAL
// - may be faster is some use-cases (random reads - indexer) // - may be faster is some use-cases (random reads - indexer)
// - use boltdb build tag (go build -tags boltdb) // - use boltdb build tag (go build -tags boltdb)
// * rocksdb (uses github.com/tecbot/gorocksdb)
// - EXPERIMENTAL
// - requires gcc
// - use rocksdb build tag (go build -tags rocksdb)
DBBackend string `mapstructure:"db_backend"` DBBackend string `mapstructure:"db_backend"`
// Database directory // Database directory


+ 5
- 1
config/toml.go View File

@ -86,7 +86,7 @@ moniker = "{{ .BaseConfig.Moniker }}"
# and verifying their commits # and verifying their commits
fast_sync = {{ .BaseConfig.FastSyncMode }} fast_sync = {{ .BaseConfig.FastSyncMode }}
# Database backend: goleveldb | cleveldb | boltdb
# Database backend: goleveldb | cleveldb | boltdb | rocksdb
# * goleveldb (github.com/syndtr/goleveldb - most popular implementation) # * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
# - pure go # - pure go
# - stable # - stable
@ -98,6 +98,10 @@ fast_sync = {{ .BaseConfig.FastSyncMode }}
# - EXPERIMENTAL # - EXPERIMENTAL
# - may be faster is some use-cases (random reads - indexer) # - may be faster is some use-cases (random reads - indexer)
# - use boltdb build tag (go build -tags boltdb) # - use boltdb build tag (go build -tags boltdb)
# * rocksdb (uses github.com/tecbot/gorocksdb)
# - EXPERIMENTAL
# - requires gcc
# - use rocksdb build tag (go build -tags rocksdb)
db_backend = "{{ .BaseConfig.DBBackend }}" db_backend = "{{ .BaseConfig.DBBackend }}"
# Database directory # Database directory


+ 5
- 1
docs/tendermint-core/configuration.md View File

@ -39,7 +39,7 @@ moniker = "anonymous"
# and verifying their commits # and verifying their commits
fast_sync = true fast_sync = true
# Database backend: goleveldb | cleveldb | boltdb
# Database backend: goleveldb | cleveldb | boltdb | rocksdb
# * goleveldb (github.com/syndtr/goleveldb - most popular implementation) # * goleveldb (github.com/syndtr/goleveldb - most popular implementation)
# - pure go # - pure go
# - stable # - stable
@ -51,6 +51,10 @@ fast_sync = true
# - EXPERIMENTAL # - EXPERIMENTAL
# - may be faster is some use-cases (random reads - indexer) # - may be faster is some use-cases (random reads - indexer)
# - use boltdb build tag (go build -tags boltdb) # - use boltdb build tag (go build -tags boltdb)
# * rocksdb (uses github.com/tecbot/gorocksdb)
# - EXPERIMENTAL
# - requires gcc
# - use rocksdb build tag (go build -tags rocksdb)
db_backend = "goleveldb" db_backend = "goleveldb"
# Database directory # Database directory


Loading…
Cancel
Save