fbcpp::RestoreOptions Class Reference

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

#include <BackupManager.h>

Classes
struct	DatabaseFileSpec

Public Member Functions
const std::vector< DatabaseFileSpec > &	getDatabaseFiles () const
	Returns the configured database file specifications.
RestoreOptions &	setDatabase (const std::string &value)
	Sets the database path to be restored.
RestoreOptions &	setDatabase (const std::string &value, std::uint64_t length)
	Sets the database path to be restored with a split length.
RestoreOptions &	addDatabaseFile (const std::string &value)
	Appends a database file path.
RestoreOptions &	addDatabaseFile (const std::string &value, std::uint64_t length)
	Appends a database file path with a split length.
const std::vector< std::string > &	getBackupFiles () const
	Returns the backup file paths.
RestoreOptions &	addBackupFile (const std::string &value)
	Appends a backup file path.
RestoreOptions &	setBackupFile (const std::string &value)
	Replaces the backup file paths with a single path.
bool	getReplace () const
	Returns whether the target database should be replaced.
RestoreOptions &	setReplace (bool value)
	Sets whether the target database should be replaced.
const ServiceManager::VerboseOutput &	getVerboseOutput () const
	Returns the verbose output callback.
RestoreOptions &	setVerboseOutput (ServiceManager::VerboseOutput value)
	Sets the verbose output callback.
const std::optional< std::uint32_t > &	getParallelWorkers () const
	Returns the requested number of parallel workers.
RestoreOptions &	setParallelWorkers (std::uint32_t value)
	Sets the requested number of parallel workers.

Detailed Description

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

Definition at line 162 of file BackupManager.h.

Member Function Documentation

addBackupFile()

RestoreOptions & fbcpp::RestoreOptions::addBackupFile ( const std::string &  value )

inline

Appends a backup file path.

Definition at line 233 of file BackupManager.h.

addDatabaseFile() [1/2]

RestoreOptions & fbcpp::RestoreOptions::addDatabaseFile ( const std::string &  value )

inline

Appends a database file path.

Definition at line 201 of file BackupManager.h.

addDatabaseFile() [2/2]

RestoreOptions & fbcpp::RestoreOptions::addDatabaseFile ( const std::string &  value, std::uint64_t  length  )

inline

Appends a database file path with a split length.

Definition at line 210 of file BackupManager.h.

getBackupFiles()

const std::vector< std::string > & fbcpp::RestoreOptions::getBackupFiles ( ) const

inline

Returns the backup file paths.

Definition at line 225 of file BackupManager.h.

getDatabaseFiles()

const std::vector< DatabaseFileSpec > & fbcpp::RestoreOptions::getDatabaseFiles ( ) const

inline

Returns the configured database file specifications.

Definition at line 175 of file BackupManager.h.

getParallelWorkers()

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

inline

Returns the requested number of parallel workers.

Definition at line 285 of file BackupManager.h.

getReplace()

bool fbcpp::RestoreOptions::getReplace ( ) const

inline

Returns whether the target database should be replaced.

Definition at line 251 of file BackupManager.h.

getVerboseOutput()

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

inline

Returns the verbose output callback.

Definition at line 268 of file BackupManager.h.

setBackupFile()

RestoreOptions & fbcpp::RestoreOptions::setBackupFile ( const std::string &  value )

inline

Replaces the backup file paths with a single path.

Definition at line 242 of file BackupManager.h.

setDatabase() [1/2]

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

inline

Sets the database path to be restored.

Definition at line 183 of file BackupManager.h.

setDatabase() [2/2]

RestoreOptions & fbcpp::RestoreOptions::setDatabase ( const std::string &  value, std::uint64_t  length  )

inline

Sets the database path to be restored with a split length.

Definition at line 192 of file BackupManager.h.

setParallelWorkers()

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

inline

Sets the requested number of parallel workers.

Definition at line 293 of file BackupManager.h.

setReplace()

RestoreOptions & fbcpp::RestoreOptions::setReplace ( bool  value )

inline

Sets whether the target database should be replaced.

Definition at line 259 of file BackupManager.h.

setVerboseOutput()

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

inline

Sets the verbose output callback.

Definition at line 276 of file BackupManager.h.

---

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

• src/fb-cpp/BackupManager.h