5 #ifndef BITCOIN_DBWRAPPER_H
6 #define BITCOIN_DBWRAPPER_H
69 bool DestroyDB(
const std::string& path_str);
98 template <
typename K,
typename V>
99 void Write(
const K& key,
const V& value)
110 template <
typename K>
148 template<
typename K>
void Seek(
const K& key) {
161 }
catch (
const std::exception&) {
172 }
catch (
const std::exception&) {
220 template <
typename K,
typename V>
221 bool Read(
const K& key, V& value)
const
226 std::optional<std::string> strValue{
ReadImpl(ssKey)};
234 }
catch (
const std::exception&) {
240 template <
typename K,
typename V>
241 bool Write(
const K& key,
const V& value,
bool fSync =
false)
244 batch.
Write(key, value);
256 template <
typename K>
265 template <
typename K>
266 bool Erase(
const K& key,
bool fSync =
false)
#define Assert(val)
Identity function.
Batch of changes queued to be written to a CDBWrapper.
size_t SizeEstimate() const
const std::unique_ptr< WriteBatchImpl > m_impl_batch
void Write(const K &key, const V &value)
CDBBatch(const CDBWrapper &_parent)
void WriteImpl(Span< const std::byte > key, DataStream &ssValue)
const CDBWrapper & parent
void EraseImpl(Span< const std::byte > key)
Span< const std::byte > GetKeyImpl() const
CDBIterator(const CDBWrapper &_parent, std::unique_ptr< IteratorImpl > _piter)
const std::unique_ptr< IteratorImpl > m_impl_iter
const CDBWrapper & parent
Span< const std::byte > GetValueImpl() const
void SeekImpl(Span< const std::byte > key)
CDBWrapper(const CDBWrapper &)=delete
auto & DBContext() const LIFETIMEBOUND
size_t DynamicMemoryUsage() const
bool WriteBatch(CDBBatch &batch, bool fSync=false)
bool Read(const K &key, V &value) const
CDBIterator * NewIterator()
std::string m_name
the name of this database
bool Erase(const K &key, bool fSync=false)
bool Write(const K &key, const V &value, bool fSync=false)
bool Exists(const K &key) const
std::vector< unsigned char > obfuscate_key
a key used for optional XOR-obfuscation of the database
CDBWrapper & operator=(const CDBWrapper &)=delete
CDBWrapper(const DBParams ¶ms)
std::optional< fs::path > StoragePath()
static const unsigned int OBFUSCATE_KEY_NUM_BYTES
the length of the obfuscate key in number of bytes
static const std::string OBFUSCATE_KEY_KEY
the key under which the obfuscation key is stored
const fs::path m_path
path to filesystem storage
std::optional< std::string > ReadImpl(Span< const std::byte > key) const
std::unique_ptr< LevelDBContext > m_db_context
holds all leveldb-specific fields of this class
bool m_is_memory
whether or not the database resides in memory
std::vector< unsigned char > CreateObfuscateKey() const
Returns a string (consisting of 8 random bytes) suitable for use as an obfuscating XOR key.
bool ExistsImpl(Span< const std::byte > key) const
bool IsEmpty()
Return true if the database managed by this class contains no entries.
size_t EstimateSizeImpl(Span< const std::byte > key1, Span< const std::byte > key2) const
size_t EstimateSize(const K &key_begin, const K &key_end) const
Double ended buffer combining vector and stream-like interfaces.
void reserve(size_type n)
dbwrapper_error(const std::string &msg)
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
static const size_t DBWRAPPER_PREALLOC_KEY_SIZE
bool DestroyDB(const std::string &path_str)
static const size_t DBWRAPPER_PREALLOC_VALUE_SIZE
These should be considered an implementation detail of the specific database.
const std::vector< unsigned char > & GetObfuscateKey(const CDBWrapper &w)
Work around circular dependency, as well as for testing in dbwrapper_tests.
Span< const std::byte > MakeByteSpan(V &&v) noexcept
User-controlled performance and debug options.
bool force_compact
Compact database on startup.
Application-specific storage settings.
DBOptions options
Passed-through options.
bool obfuscate
If true, store data obfuscated via simple XOR.
bool wipe_data
If true, remove all existing data.
size_t cache_bytes
Configures various leveldb cache settings.
fs::path path
Location in the filesystem where leveldb data will be stored.
bool memory_only
If true, use leveldb's memory environment.