fbcpp::DatabaseRepairOptions Class Reference

Represents options used to run a database maintenance operation through the service manager. More...

#include <DatabaseManager.h>

Public Member Functions
const std::string &	getDatabase () const
	Returns the database path to be maintained.
DatabaseRepairOptions &	setDatabase (const std::string &value)
	Sets the database path to be maintained.
const ServiceManager::VerboseOutput &	getVerboseOutput () const
	Returns the verbose output callback.
DatabaseRepairOptions &	setVerboseOutput (ServiceManager::VerboseOutput value)
	Sets the verbose output callback.
const std::optional< std::uint32_t > &	getParallelWorkers () const
	Returns the requested number of parallel workers.
DatabaseRepairOptions &	setParallelWorkers (std::uint32_t value)
	Sets the requested number of parallel workers.
bool	getSweep () const
	Returns whether database sweep is configured to be run.
DatabaseRepairOptions &	setSweep (bool value)
	Sets whether database sweep should be run.
bool	getValidate () const
	Returns whether database validation is configured to be run.
DatabaseRepairOptions &	setValidate (bool value)
	Sets whether database validation should be run.
bool	getMend () const
	Returns whether database mending is configured to be run.
DatabaseRepairOptions &	setMend (bool value)
	Sets whether database mending should be run.
bool	getIgnoreChecksum () const
	Returns whether checksum verification is configured to be ignored.
DatabaseRepairOptions &	setIgnoreChecksum (bool value)
	Sets whether checksum verification should be ignored.
bool	getKillShadows () const
	Returns whether killing database shadows is configured to be run.
DatabaseRepairOptions &	setKillShadows (bool value)
	Sets whether killing database shadows should be run.
bool	getFull () const
	Returns whether full validation is configured to be run.
DatabaseRepairOptions &	setFull (bool value)
	Sets whether full validation should be run.
bool	getCheckDb () const
	Returns whether checking only metadata/structure is configured to be run.
DatabaseRepairOptions &	setCheckDb (bool value)
	Sets whether checking only metadata/structure should be run.
bool	getIcu () const
	Returns whether recreating ICU indexes is configured to be run.
DatabaseRepairOptions &	setIcu (bool value)
	Sets whether recreating ICU indexes should be run.
bool	getUpgradeDb () const
	Returns whether database upgrade is configured to be run.
DatabaseRepairOptions &	setUpgradeDb (bool value)
	Sets whether database upgrade should be run.

Detailed Description

Represents options used to run a database maintenance operation through the service manager.

Definition at line 207 of file DatabaseManager.h.

Member Function Documentation

getCheckDb()

bool fbcpp::DatabaseRepairOptions::getCheckDb ( ) const

inline

Returns whether checking only metadata/structure is configured to be run.

Definition at line 366 of file DatabaseManager.h.

getDatabase()

const std::string & fbcpp::DatabaseRepairOptions::getDatabase ( ) const

inline

Returns the database path to be maintained.

Definition at line 213 of file DatabaseManager.h.

getFull()

bool fbcpp::DatabaseRepairOptions::getFull ( ) const

inline

Returns whether full validation is configured to be run.

Definition at line 349 of file DatabaseManager.h.

getIcu()

bool fbcpp::DatabaseRepairOptions::getIcu ( ) const

inline

Returns whether recreating ICU indexes is configured to be run.

Definition at line 383 of file DatabaseManager.h.

getIgnoreChecksum()

bool fbcpp::DatabaseRepairOptions::getIgnoreChecksum ( ) const

inline

Returns whether checksum verification is configured to be ignored.

Definition at line 315 of file DatabaseManager.h.

getKillShadows()

bool fbcpp::DatabaseRepairOptions::getKillShadows ( ) const

inline

Returns whether killing database shadows is configured to be run.

Definition at line 332 of file DatabaseManager.h.

getMend()

bool fbcpp::DatabaseRepairOptions::getMend ( ) const

inline

Returns whether database mending is configured to be run.

Definition at line 298 of file DatabaseManager.h.

getParallelWorkers()

const std::optional< std::uint32_t > & fbcpp::DatabaseRepairOptions::getParallelWorkers ( ) const

inline

Returns the requested number of parallel workers.

Definition at line 247 of file DatabaseManager.h.

getSweep()

bool fbcpp::DatabaseRepairOptions::getSweep ( ) const

inline

Returns whether database sweep is configured to be run.

Definition at line 264 of file DatabaseManager.h.

getUpgradeDb()

bool fbcpp::DatabaseRepairOptions::getUpgradeDb ( ) const

inline

Returns whether database upgrade is configured to be run.

Definition at line 400 of file DatabaseManager.h.

getValidate()

bool fbcpp::DatabaseRepairOptions::getValidate ( ) const

inline

Returns whether database validation is configured to be run.

Definition at line 281 of file DatabaseManager.h.

getVerboseOutput()

const ServiceManager::VerboseOutput & fbcpp::DatabaseRepairOptions::getVerboseOutput ( ) const

inline

Returns the verbose output callback.

Definition at line 230 of file DatabaseManager.h.

setCheckDb()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setCheckDb ( bool  value )

inline

Sets whether checking only metadata/structure should be run.

Definition at line 374 of file DatabaseManager.h.

setDatabase()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setDatabase ( const std::string &  value )

inline

Sets the database path to be maintained.

Definition at line 221 of file DatabaseManager.h.

setFull()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setFull ( bool  value )

inline

Sets whether full validation should be run.

Definition at line 357 of file DatabaseManager.h.

setIcu()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setIcu ( bool  value )

inline

Sets whether recreating ICU indexes should be run.

Definition at line 391 of file DatabaseManager.h.

setIgnoreChecksum()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setIgnoreChecksum ( bool  value )

inline

Sets whether checksum verification should be ignored.

Definition at line 323 of file DatabaseManager.h.

setKillShadows()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setKillShadows ( bool  value )

inline

Sets whether killing database shadows should be run.

Definition at line 340 of file DatabaseManager.h.

setMend()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setMend ( bool  value )

inline

Sets whether database mending should be run.

Definition at line 306 of file DatabaseManager.h.

setParallelWorkers()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setParallelWorkers ( std::uint32_t  value )

inline

Sets the requested number of parallel workers.

Definition at line 255 of file DatabaseManager.h.

setSweep()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setSweep ( bool  value )

inline

Sets whether database sweep should be run.

Definition at line 272 of file DatabaseManager.h.

setUpgradeDb()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setUpgradeDb ( bool  value )

inline

Sets whether database upgrade should be run.

Definition at line 408 of file DatabaseManager.h.

setValidate()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setValidate ( bool  value )

inline

Sets whether database validation should be run.

Definition at line 289 of file DatabaseManager.h.

setVerboseOutput()

DatabaseRepairOptions & fbcpp::DatabaseRepairOptions::setVerboseOutput ( ServiceManager::VerboseOutput  value )

inline

Sets the verbose output callback.

Definition at line 238 of file DatabaseManager.h.

---

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

• src/fb-cpp/DatabaseManager.h