Inheritance diagram for ripple::NodeStore::NuDBBackend:

Collaboration diagram for ripple::NodeStore::NuDBBackend:

[legend]

Public Member Functions
	NuDBBackend (size_t keyBytes, Section const &keyValues, std::size_t burstSize, Scheduler &scheduler, beast::Journal journal)

	NuDBBackend (size_t keyBytes, Section const &keyValues, std::size_t burstSize, Scheduler &scheduler, nudb::context &context, beast::Journal journal)

	~NuDBBackend () override

std::string	getName () override
	Get the human-readable name of this backend. More...

void	open (bool createIfMissing, uint64_t appType, uint64_t uid, uint64_t salt) override
	Open the backend. More...

bool	isOpen () override
	Returns true is the database is open. More...

void	open (bool createIfMissing) override
	Open the backend. More...

void	close () override
	Close the backend. More...

Status	fetch (void const key, std::shared_ptr< NodeObject > pno) override
	Fetch a single object. More...

std::pair< std::vector< std::shared_ptr< NodeObject > >, Status >	fetchBatch (std::vector< uint256 const * > const &hashes) override
	Fetch a batch synchronously. More...

void	do_insert (std::shared_ptr< NodeObject > const &no)

void	store (std::shared_ptr< NodeObject > const &no) override
	Store a single object. More...

void	storeBatch (Batch const &batch) override
	Store a group of objects. More...

void	sync () override

void	for_each (std::function< void(std::shared_ptr< NodeObject >)> f) override
	Visit every object in the database This is usually called during import. More...

int	getWriteLoad () override
	Estimate the number of write operations pending. More...

void	setDeletePath () override
	Remove contents on disk upon destruction. More...

void	verify () override
	Perform consistency checks on database. More...

int	fdRequired () const override
	Returns the number of file descriptors the backend expects to need. More...

virtual std::optional< Counters< std::uint64_t > >	counters () const
	Returns read and write stats. More...

Public Attributes
const beast::Journal	j_

const size_t	keyBytes_

const std::size_t	burstSize_

const std::string	name_

nudb::store	db_

std::atomic< bool >	deletePath_

Scheduler &	scheduler_

Static Public Attributes
static constexpr std::uint64_t	currentType = 1

static constexpr std::uint64_t	deterministicMask = 0xFFFFFFFF00000000ull

static constexpr std::uint64_t	deterministicType = 0x5348524400000000ull

Detailed Description

Definition at line 38 of file NuDBFactory.cpp.

Constructor & Destructor Documentation

◆ NuDBBackend() [1/2]

ripple::NodeStore::NuDBBackend::NuDBBackend	(	size_t	keyBytes,
		Section const &	keyValues,
		std::size_t	burstSize,
		Scheduler &	scheduler,
		beast::Journal	journal
	)

Definition at line 55 of file NuDBFactory.cpp.

◆ NuDBBackend() [2/2]

ripple::NodeStore::NuDBBackend::NuDBBackend	(	size_t	keyBytes,
		Section const &	keyValues,
		std::size_t	burstSize,
		Scheduler &	scheduler,
		nudb::context &	context,
		beast::Journal	journal
	)

Definition at line 73 of file NuDBFactory.cpp.

◆ ~NuDBBackend()

ripple::NodeStore::NuDBBackend::~NuDBBackend ( )

override

Definition at line 93 of file NuDBFactory.cpp.

Member Function Documentation

◆ getName()

std::string ripple::NodeStore::NuDBBackend::getName ( )

overridevirtual

Get the human-readable name of this backend.

This is used for diagnostic output.

Implements ripple::NodeStore::Backend.

Definition at line 108 of file NuDBFactory.cpp.

◆ open() [1/2]

void ripple::NodeStore::NuDBBackend::open	(	bool	createIfMissing,
		uint64_t	appType,
		uint64_t	uid,
		uint64_t	salt
	)

overridevirtual

Open the backend.

Parameters

createIfMissing	Create the database files if necessary.
appType	Deterministic appType used to create a backend.
uid	Deterministic uid used to create a backend.
salt	Deterministic salt used to create a backend.

Exceptions

std::runtime_error is function is called not for NuDB backend.

Old value currentType is accepted for appnum in traditional databases, new value is used for deterministic shard databases. New 64-bit value is constructed from fixed and random parts. Fixed part is bounded by bitmask deterministicMask, and the value of fixed part is deterministicType. Random part depends on the contents of the shard and may be any. The contents of appnum field should match either old or new rule.

Reimplemented from ripple::NodeStore::Backend.

Definition at line 114 of file NuDBFactory.cpp.

◆ isOpen()

bool ripple::NodeStore::NuDBBackend::isOpen ( )

overridevirtual

Returns true is the database is open.

Implements ripple::NodeStore::Backend.

Definition at line 167 of file NuDBFactory.cpp.

◆ open() [2/2]

void ripple::NodeStore::NuDBBackend::open ( bool createIfMissing )

overridevirtual

Open the backend.

Parameters

createIfMissing Create the database files if necessary. This allows the caller to catch exceptions.

Implements ripple::NodeStore::Backend.

Definition at line 173 of file NuDBFactory.cpp.

◆ close()

void ripple::NodeStore::NuDBBackend::close ( )

overridevirtual

Close the backend.

This allows the caller to catch exceptions.

Implements ripple::NodeStore::Backend.

Definition at line 179 of file NuDBFactory.cpp.

◆ fetch()

Status ripple::NodeStore::NuDBBackend::fetch	(	void const *	key,
		std::shared_ptr< NodeObject > *	pObject
	)

overridevirtual

Fetch a single object.

If the object is not found or an error is encountered, the result will indicate the condition.

Note: This will be called concurrently.

Parameters

key	A pointer to the key data.
pObject	[out] The created object if successful.

Returns: The result of the operation.

Implements ripple::NodeStore::Backend.

Definition at line 205 of file NuDBFactory.cpp.

◆ fetchBatch()

std::pair<std::vector<std::shared_ptr<NodeObject> >, Status> ripple::NodeStore::NuDBBackend::fetchBatch ( std::vector< uint256 const * > const & hashes )

overridevirtual

Fetch a batch synchronously.

Implements ripple::NodeStore::Backend.

Definition at line 233 of file NuDBFactory.cpp.

◆ do_insert()

void ripple::NodeStore::NuDBBackend::do_insert ( std::shared_ptr< NodeObject > const & no )

Definition at line 251 of file NuDBFactory.cpp.

◆ store()

void ripple::NodeStore::NuDBBackend::store ( std::shared_ptr< NodeObject > const & object )

overridevirtual

Store a single object.

Depending on the implementation this may happen immediately or deferred using a scheduled task.

Note: This will be called concurrently.

Parameters

object The object to store.

Implements ripple::NodeStore::Backend.

Definition at line 263 of file NuDBFactory.cpp.

◆ storeBatch()

void ripple::NodeStore::NuDBBackend::storeBatch ( Batch const & batch )

overridevirtual

Store a group of objects.

Note: This function will not be called concurrently with itself or store.

Implements ripple::NodeStore::Backend.

Definition at line 275 of file NuDBFactory.cpp.

◆ sync()

void ripple::NodeStore::NuDBBackend::sync ( )

overridevirtual

Implements ripple::NodeStore::Backend.

Definition at line 288 of file NuDBFactory.cpp.

◆ for_each()

void ripple::NodeStore::NuDBBackend::for_each ( std::function< void(std::shared_ptr< NodeObject >)> f )

overridevirtual

Visit every object in the database This is usually called during import.

Note: This routine will not be called concurrently with itself or other methods.

See also: import

Implements ripple::NodeStore::Backend.

Definition at line 293 of file NuDBFactory.cpp.

◆ getWriteLoad()

int ripple::NodeStore::NuDBBackend::getWriteLoad ( )

overridevirtual

Estimate the number of write operations pending.

Implements ripple::NodeStore::Backend.

Definition at line 330 of file NuDBFactory.cpp.

◆ setDeletePath()

void ripple::NodeStore::NuDBBackend::setDeletePath ( )

overridevirtual

Remove contents on disk upon destruction.

Implements ripple::NodeStore::Backend.

Definition at line 336 of file NuDBFactory.cpp.

◆ verify()

void ripple::NodeStore::NuDBBackend::verify ( )

overridevirtual

Perform consistency checks on database.

This method is implemented only by NuDBBackend. It is not yet called anywhere, but it might be a good idea to one day call it at startup to avert a crash.

Reimplemented from ripple::NodeStore::Backend.

Definition at line 342 of file NuDBFactory.cpp.

◆ fdRequired()

int ripple::NodeStore::NuDBBackend::fdRequired ( ) const

overridevirtual

Returns the number of file descriptors the backend expects to need.

Implements ripple::NodeStore::Backend.

Definition at line 361 of file NuDBFactory.cpp.

◆ counters()

virtual std::optional<Counters<std::uint64_t> > ripple::NodeStore::Backend::counters ( ) const

virtualinherited

Returns read and write stats.

Note: The Counters struct is specific to and only used by CassandraBackend.

Definition at line 184 of file Backend.h.

Member Data Documentation

◆ currentType

constexpr std::uint64_t ripple::NodeStore::NuDBBackend::currentType = 1

staticconstexpr

Definition at line 41 of file NuDBFactory.cpp.

◆ deterministicMask

constexpr std::uint64_t ripple::NodeStore::NuDBBackend::deterministicMask = 0xFFFFFFFF00000000ull

staticconstexpr

Definition at line 42 of file NuDBFactory.cpp.

◆ deterministicType

constexpr std::uint64_t ripple::NodeStore::NuDBBackend::deterministicType = 0x5348524400000000ull

staticconstexpr

Definition at line 45 of file NuDBFactory.cpp.

◆ j_

const beast::Journal ripple::NodeStore::NuDBBackend::j_

Definition at line 47 of file NuDBFactory.cpp.

◆ keyBytes_

const size_t ripple::NodeStore::NuDBBackend::keyBytes_

Definition at line 48 of file NuDBFactory.cpp.

◆ burstSize_

const std::size_t ripple::NodeStore::NuDBBackend::burstSize_

Definition at line 49 of file NuDBFactory.cpp.

◆ name_

const std::string ripple::NodeStore::NuDBBackend::name_

Definition at line 50 of file NuDBFactory.cpp.

◆ db_

nudb::store ripple::NodeStore::NuDBBackend::db_

Definition at line 51 of file NuDBFactory.cpp.

◆ deletePath_

std::atomic<bool> ripple::NodeStore::NuDBBackend::deletePath_

Definition at line 52 of file NuDBFactory.cpp.

◆ scheduler_

Scheduler& ripple::NodeStore::NuDBBackend::scheduler_

Definition at line 53 of file NuDBFactory.cpp.

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NuDBBackend() [1/2]

◆ NuDBBackend() [2/2]

◆ ~NuDBBackend()

Member Function Documentation

◆ getName()

◆ open() [1/2]

◆ isOpen()

◆ open() [2/2]

◆ close()

◆ fetch()

◆ fetchBatch()

◆ do_insert()

◆ store()

◆ storeBatch()

◆ sync()

◆ for_each()

◆ getWriteLoad()

◆ setDeletePath()

◆ verify()

◆ fdRequired()

◆ counters()

Member Data Documentation

◆ currentType

◆ deterministicMask

◆ deterministicType

◆ j_

◆ keyBytes_

◆ burstSize_

◆ name_

◆ db_

◆ deletePath_

◆ scheduler_