Skip to content

Commit 82638af

Browse files
committed
cmd/geth, node: rename backingdb to db.engine
1 parent 5f3d2ce commit 82638af

File tree

7 files changed

+32
-32
lines changed

7 files changed

+32
-32
lines changed

cmd/geth/genesis_test.go

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -147,40 +147,40 @@ func TestCustomBackend(t *testing.T) {
147147
}
148148
for i, tt := range []backendTest{
149149
{ // When not specified, it should default to leveldb
150-
execArgs: []string{"--backingdb", "leveldb"},
150+
execArgs: []string{"--db.engine", "leveldb"},
151151
execExpect: "0x0000000000001338",
152152
},
153153
{ // Explicit leveldb
154-
initArgs: []string{"--backingdb", "leveldb"},
155-
execArgs: []string{"--backingdb", "leveldb"},
154+
initArgs: []string{"--db.engine", "leveldb"},
155+
execArgs: []string{"--db.engine", "leveldb"},
156156
execExpect: "0x0000000000001338",
157157
},
158158
{ // Explicit leveldb first, then autodiscover
159-
initArgs: []string{"--backingdb", "leveldb"},
159+
initArgs: []string{"--db.engine", "leveldb"},
160160
execExpect: "0x0000000000001338",
161161
},
162162
{ // Explicit pebble
163-
initArgs: []string{"--backingdb", "pebble"},
164-
execArgs: []string{"--backingdb", "pebble"},
163+
initArgs: []string{"--db.engine", "pebble"},
164+
execArgs: []string{"--db.engine", "pebble"},
165165
execExpect: "0x0000000000001338",
166166
},
167167
{ // Explicit pebble, then auto-discover
168-
initArgs: []string{"--backingdb", "pebble"},
168+
initArgs: []string{"--db.engine", "pebble"},
169169
execExpect: "0x0000000000001338",
170170
},
171171
{ // Can't start pebble on top of leveldb
172-
initArgs: []string{"--backingdb", "leveldb"},
173-
execArgs: []string{"--backingdb", "pebble"},
174-
execExpect: `Fatal: Failed to register the Ethereum service: backingdb choice was pebble but found pre-existing leveldb database in specified data directory`,
172+
initArgs: []string{"--db.engine", "leveldb"},
173+
execArgs: []string{"--db.engine", "pebble"},
174+
execExpect: `Fatal: Failed to register the Ethereum service: db.engine choice was pebble but found pre-existing leveldb database in specified data directory`,
175175
},
176176
{ // Can't start leveldb on top of pebble
177-
initArgs: []string{"--backingdb", "pebble"},
178-
execArgs: []string{"--backingdb", "leveldb"},
179-
execExpect: `Fatal: Failed to register the Ethereum service: backingdb choice was leveldb but found pre-existing pebble database in specified data directory`,
177+
initArgs: []string{"--db.engine", "pebble"},
178+
execArgs: []string{"--db.engine", "leveldb"},
179+
execExpect: `Fatal: Failed to register the Ethereum service: db.engine choice was leveldb but found pre-existing pebble database in specified data directory`,
180180
},
181181
{ // Reject invalid backend choice
182-
initArgs: []string{"--backingdb", "mssql"},
183-
initExpect: `Fatal: Invalid choice for backing db 'mssql', allowed 'leveldb' or 'pebble'`,
182+
initArgs: []string{"--db.engine", "mssql"},
183+
initExpect: `Fatal: Invalid choice for db.engine 'mssql', allowed 'leveldb' or 'pebble'`,
184184
// Since the init fails, this will return the (default) mainnet genesis
185185
// block nonce
186186
execExpect: `0x0000000000000042`,

cmd/utils/flags.go

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,8 @@ var (
9999
Usage: "URL for remote database",
100100
Category: flags.LoggingCategory,
101101
}
102-
BackingDBFlag = &cli.StringFlag{
103-
Name: "backingdb",
102+
DBEngineFlag = &cli.StringFlag{
103+
Name: "db.engine",
104104
Usage: "Backing database implementation to use ('leveldb' or 'pebble')",
105105
Value: "leveldb",
106106
Category: flags.EthCategory,
@@ -1023,7 +1023,7 @@ var (
10231023

10241024
func init() {
10251025
if rawdb.PebbleEnabled {
1026-
DatabasePathFlags = append(DatabasePathFlags, BackingDBFlag)
1026+
DatabasePathFlags = append(DatabasePathFlags, DBEngineFlag)
10271027
}
10281028
}
10291029

@@ -1509,13 +1509,13 @@ func SetNodeConfig(ctx *cli.Context, cfg *node.Config) {
15091509
if ctx.IsSet(InsecureUnlockAllowedFlag.Name) {
15101510
cfg.InsecureUnlockAllowed = ctx.Bool(InsecureUnlockAllowedFlag.Name)
15111511
}
1512-
if ctx.IsSet(BackingDBFlag.Name) {
1513-
backingDB := ctx.String(BackingDBFlag.Name)
1514-
if backingDB != "leveldb" && backingDB != "pebble" {
1515-
Fatalf("Invalid choice for backing db '%s', allowed 'leveldb' or 'pebble'", backingDB)
1512+
if ctx.IsSet(DBEngineFlag.Name) {
1513+
dbEngine := ctx.String(DBEngineFlag.Name)
1514+
if dbEngine != "leveldb" && dbEngine != "pebble" {
1515+
Fatalf("Invalid choice for db.engine '%s', allowed 'leveldb' or 'pebble'", dbEngine)
15161516
}
1517-
log.Info(fmt.Sprintf("Using %s as backing db", backingDB))
1518-
cfg.BackingDB = backingDB
1517+
log.Info(fmt.Sprintf("Using %s as db engine", dbEngine))
1518+
cfg.DBEngine = dbEngine
15191519
}
15201520
}
15211521

core/rawdb/database.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,18 +349,18 @@ type OpenOptions struct {
349349
func openKeyValueDatabase(o OpenOptions) (ethdb.Database, error) {
350350
existingDb := hasPreexistingDb(o.Directory)
351351
if len(existingDb) != 0 && len(o.Type) != 0 && o.Type != existingDb {
352-
return nil, fmt.Errorf("backingdb choice was %v but found pre-existing %v database in specified data directory", o.Type, existingDb)
352+
return nil, fmt.Errorf("db.engine choice was %v but found pre-existing %v database in specified data directory", o.Type, existingDb)
353353
}
354354
if o.Type == dbPebble || existingDb == dbPebble {
355355
if PebbleEnabled {
356356
log.Info("Using pebble as the backing database")
357357
return NewPebbleDBDatabase(o.Directory, o.Cache, o.Handles, o.Namespace, o.ReadOnly)
358358
} else {
359-
return nil, errors.New("backingdb 'pebble' not supported on this platform")
359+
return nil, errors.New("db.engine 'pebble' not supported on this platform")
360360
}
361361
}
362362
if len(o.Type) != 0 && o.Type != dbLeveldb {
363-
return nil, fmt.Errorf("unknown backingdb %v", o.Type)
363+
return nil, fmt.Errorf("unknown db.engine %v", o.Type)
364364
}
365365
log.Info("Using leveldb as the backing database")
366366
// Use leveldb, either as default (no explicit choice), or pre-existing, or chosen explicitly

ethdb/pebble/pebble.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@
2020
package pebble
2121

2222
import (
23+
"fmt"
2324
"runtime"
2425
"sync"
2526
"sync/atomic"
2627
"time"
2728

28-
"fmt"
2929
"github.com/cockroachdb/pebble"
3030
"github.com/cockroachdb/pebble/bloom"
3131
"github.com/ethereum/go-ethereum/common"

node/config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ type Config struct {
203203
// EnablePersonal enables the deprecated personal namespace.
204204
EnablePersonal bool `toml:"-"`
205205

206-
BackingDB string `toml:",omitempty"`
206+
DBEngine string `toml:",omitempty"`
207207
}
208208

209209
// IPCEndpoint resolves an IPC endpoint based on a configured value, taking into

node/defaults.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ var DefaultConfig = Config{
6464
MaxPeers: 50,
6565
NAT: nat.Any(),
6666
},
67-
BackingDB: "",
67+
DBEngine: "",
6868
}
6969

7070
// DefaultDataDir is the default data directory to use for the databases and other

node/node.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -710,7 +710,7 @@ func (n *Node) OpenDatabase(name string, cache, handles int, namespace string, r
710710
db = rawdb.NewMemoryDatabase()
711711
} else {
712712
db, err = rawdb.Open(rawdb.OpenOptions{
713-
Type: n.config.BackingDB,
713+
Type: n.config.DBEngine,
714714
Directory: n.ResolvePath(name),
715715
Namespace: namespace,
716716
Cache: cache,
@@ -742,7 +742,7 @@ func (n *Node) OpenDatabaseWithFreezer(name string, cache, handles int, ancient
742742
db = rawdb.NewMemoryDatabase()
743743
} else {
744744
db, err = rawdb.Open(rawdb.OpenOptions{
745-
Type: n.config.BackingDB,
745+
Type: n.config.DBEngine,
746746
Directory: n.ResolvePath(name),
747747
AncientsDirectory: n.ResolveAncient(name, ancient),
748748
Namespace: namespace,

0 commit comments

Comments
 (0)