An instance of this class represents one database. More...

#include <bdb.h>

Inheritance diagram for BerkeleyDatabase:

Collaboration diagram for BerkeleyDatabase:

Public Member Functions
	BerkeleyDatabase ()=delete

	BerkeleyDatabase (std::shared_ptr< BerkeleyEnvironment > env, std::string filename)
	Create DB handle to real database. More...

	~BerkeleyDatabase () override

void	Open () override
	Open the database if it is not already opened. More...

bool	Rewrite (const char *pszSkip=nullptr) override
	Rewrite the entire database on disk, with the exception of key pszSkip if non-zero. More...

void	AddRef () override
	Indicate that a new database user has begun using the database. More...

void	RemoveRef () override
	Indicate that database user has stopped using the database and that it could be flushed or closed. More...

bool	Backup (const std::string &strDest) const override
	Back up the entire database to a file. More...

void	Flush () override
	Make sure all changes are flushed to database file. More...

void	Close () override
	Flush to the database file and close the database. More...

bool	PeriodicFlush () override

void	IncrementUpdateCounter () override

void	ReloadDbEnv () override

bool	Verify (bilingual_str &error)
	Verifies the environment and database file. More...

std::string	Filename () override
	Return path to main database filename. More...

std::string	Format () override

std::unique_ptr< DatabaseBatch >	MakeBatch (bool flush_on_close=true) override
	Make a BerkeleyBatch connected to this database. More...

Public Member Functions inherited from WalletDatabase
	WalletDatabase ()
	Create dummy DB handle. More...

virtual	~WalletDatabase ()

Public Attributes
std::shared_ptr< BerkeleyEnvironment >	env
	Pointer to shared database environment. More...

std::unique_ptr< Db >	m_db
	Database pointer. More...

std::string	strFile

Public Attributes inherited from WalletDatabase
std::atomic< int >	m_refcount {0}
	Counts the number of active database users to be sure that the database is not closed while someone is using it. More...

std::atomic< unsigned int >	nUpdateCounter

unsigned int	nLastSeen

unsigned int	nLastFlushed

int64_t	nLastWalletUpdate

Detailed Description

An instance of this class represents one database.

For BerkeleyDB this is just a (env, strFile) tuple.

Definition at line 94 of file bdb.h.

Constructor & Destructor Documentation

◆ BerkeleyDatabase() [1/2]

BerkeleyDatabase::BerkeleyDatabase ( )

delete

◆ BerkeleyDatabase() [2/2]

BerkeleyDatabase::BerkeleyDatabase	(	std::shared_ptr< BerkeleyEnvironment >	env,
		std::string	filename
	)

inline

Create DB handle to real database.

Definition at line 100 of file bdb.h.

Here is the call graph for this function:

◆ ~BerkeleyDatabase()

BerkeleyDatabase::~BerkeleyDatabase ( )

override

Definition at line 293 of file bdb.cpp.

Here is the call graph for this function:

Member Function Documentation

◆ AddRef()

void BerkeleyDatabase::AddRef ( )

overridevirtual

Indicate that a new database user has begun using the database.

Implements WalletDatabase.

Definition at line 803 of file bdb.cpp.

Here is the caller graph for this function:

◆ Backup()

bool BerkeleyDatabase::Backup ( const std::string & strDest ) const

overridevirtual

Back up the entire database to a file.

Implements WalletDatabase.

Definition at line 603 of file bdb.cpp.

Here is the call graph for this function:

◆ Close()

void BerkeleyDatabase::Close ( )

overridevirtual

Flush to the database file and close the database.

Also close the environment if no other databases are open in it.

Implements WalletDatabase.

Definition at line 645 of file bdb.cpp.

◆ Filename()

std::string BerkeleyDatabase::Filename ( )

inlineoverridevirtual

Return path to main database filename.

Implements WalletDatabase.

Definition at line 144 of file bdb.h.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Flush()

void BerkeleyDatabase::Flush ( )

overridevirtual

Make sure all changes are flushed to database file.

Implements WalletDatabase.

Definition at line 640 of file bdb.cpp.

◆ Format()

std::string BerkeleyDatabase::Format ( )

inlineoverridevirtual

Implements WalletDatabase.

Definition at line 146 of file bdb.h.

◆ IncrementUpdateCounter()

void BerkeleyDatabase::IncrementUpdateCounter ( )

overridevirtual

Implements WalletDatabase.

Definition at line 382 of file bdb.cpp.

◆ MakeBatch()

std::unique_ptr< DatabaseBatch > BerkeleyDatabase::MakeBatch ( bool flush_on_close = true )

overridevirtual

Make a BerkeleyBatch connected to this database.

Implements WalletDatabase.

Definition at line 820 of file bdb.cpp.

◆ Open()

void BerkeleyDatabase::Open ( )

overridevirtual

Open the database if it is not already opened.

Implements WalletDatabase.

Definition at line 322 of file bdb.cpp.

Here is the caller graph for this function:

◆ PeriodicFlush()

bool BerkeleyDatabase::PeriodicFlush ( )

overridevirtual

Implements WalletDatabase.

Definition at line 576 of file bdb.cpp.

Here is the call graph for this function:

◆ ReloadDbEnv()

void BerkeleyDatabase::ReloadDbEnv ( )

overridevirtual

Implements WalletDatabase.

Definition at line 650 of file bdb.cpp.

◆ RemoveRef()

void BerkeleyDatabase::RemoveRef ( )

overridevirtual

Indicate that database user has stopped using the database and that it could be flushed or closed.

Implements WalletDatabase.

Definition at line 813 of file bdb.cpp.

Here is the caller graph for this function:

◆ Rewrite()

bool BerkeleyDatabase::Rewrite ( const char * pszSkip = nullptr )

overridevirtual

Rewrite the entire database on disk, with the exception of key pszSkip if non-zero.

Implements WalletDatabase.

Definition at line 449 of file bdb.cpp.

Here is the call graph for this function:

◆ Verify()

bool BerkeleyDatabase::Verify ( bilingual_str & error )

Verifies the environment and database file.

Definition at line 258 of file bdb.cpp.

Here is the call graph for this function:

Member Data Documentation

◆ env

std::shared_ptr<BerkeleyEnvironment> BerkeleyDatabase::env

Pointer to shared database environment.

Normally there is only one BerkeleyDatabase object per BerkeleyEnvivonment, but in the special, backwards compatible case where multiple wallet BDB data files are loaded from the same directory, this will point to a shared instance that gets freed when the last data file is closed.

Definition at line 156 of file bdb.h.

◆ m_db

std::unique_ptr<Db> BerkeleyDatabase::m_db

Database pointer.

This is initialized lazily and reset during flushes, so it can be null.

Definition at line 159 of file bdb.h.

◆ strFile

std::string BerkeleyDatabase::strFile

Definition at line 161 of file bdb.h.

The documentation for this class was generated from the following files:

src/wallet/bdb.h
src/wallet/bdb.cpp

Public Member Functions

Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BerkeleyDatabase() [1/2]

◆ BerkeleyDatabase() [2/2]

◆ ~BerkeleyDatabase()

Member Function Documentation

◆ AddRef()

◆ Backup()

◆ Close()

◆ Filename()

◆ Flush()

◆ Format()

◆ IncrementUpdateCounter()

◆ MakeBatch()

◆ Open()

◆ PeriodicFlush()

◆ ReloadDbEnv()

◆ RemoveRef()

◆ Rewrite()

◆ Verify()

Member Data Documentation

◆ env

◆ m_db

◆ strFile