nimbus-eth1/nimbus/db/core_db/persistent.nim

92 lines
2.9 KiB
Nim

# Nimbus
# Copyright (c) 2023-2024 Status Research & Development GmbH
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
# http://www.apache.org/licenses/LICENSE-2.0)
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
# http://opensource.org/licenses/MIT)
# at your option. This file may not be copied, modified, or distributed except
# according to those terms.
## This module automatically pulls in the persistent backend libraries at the
## linking stage (e.g. `rocksdb`) which can be avoided for pure memory DB
## applications by importing `db/code_db/memory_only` (rather than
## `db/core_db/persistent`.)
##
## The right way to use this file on a conditional mode is to import it as in
## ::
## import ./path/to/core_db
## when ..condition..
## import ./path/to/core_db/persistent
##
{.push raises: [].}
import
../aristo,
./memory_only,
../select_backend
export
memory_only
# This file is currently inconsistent due to the `dbBackend == rocksdb` hack
# which will be removed, soon (must go to the test base where such a compile
# time flag induced mechanism might be useful.)
#
# The `Aristo` backend has no business with `dbBackend` and will be extended
# in future.
{.warning: "Inconsistent API file needs to be de-uglified".}
# Allow hive sim to compile with dbBackend == none
when dbBackend == rocksdb:
import
base_iterators_persistent,
./backend/[aristo_rocksdb, legacy_rocksdb]
export
base_iterators_persistent,
toRocksStoreRef
proc newCoreDbRef*(
dbType: static[CoreDbType]; # Database type symbol
path: string; # Storage path for database
): CoreDbRef =
## Constructor for persistent type DB
##
## Note: Using legacy notation `newCoreDbRef()` rather than
## `CoreDbRef.init()` because of compiler coughing.
when dbBackend == rocksdb:
when dbType == LegacyDbPersistent:
newLegacyPersistentCoreDbRef path
elif dbType == AristoDbRocks:
newAristoRocksDbCoreDbRef path
else:
{.error: "Unsupported dbType for persistent newCoreDbRef()".}
else:
{.error: "Unsupported dbBackend setting for persistent newCoreDbRef()".}
proc newCoreDbRef*(
dbType: static[CoreDbType]; # Database type symbol
path: string; # Storage path for database
qidLayout: QidLayoutRef; # Optional for `Aristo`, ignored by others
): CoreDbRef =
## Constructor for persistent type DB
##
## Note: Using legacy notation `newCoreDbRef()` rather than
## `CoreDbRef.init()` because of compiler coughing.
when dbBackend == rocksdb:
when dbType == AristoDbRocks:
newAristoRocksDbCoreDbRef(path, qlr)
else:
{.error: "Unsupported dbType for persistent newCoreDbRef()" &
" with qidLayout argument".}
else:
{.error: "Unsupported dbBackend setting for persistent newCoreDbRef()" &
" with qidLayout argument".}
# End