fb-cpp 0.0.2
A modern C++ wrapper for the Firebird database API
Loading...
Searching...
No Matches
fbcpp::BackupManager Class Referencefinal

Executes backup and restore operations through the Firebird service manager. More...

#include <BackupManager.h>

Inheritance diagram for fbcpp::BackupManager:
Collaboration diagram for fbcpp::BackupManager:

Public Member Functions

void backup (const BackupOptions &options)
 Runs a backup operation using the provided options.
 
void restore (const RestoreOptions &options)
 Runs a restore operation using the provided options.
 
 ServiceManager (Client &client, const ServiceManagerOptions &options={})
 Attaches to the service manager specified by the given options.
 
 ServiceManager (ServiceManager &&o) noexcept
 Move constructor.
 
 ServiceManager (const ServiceManager &)=delete
 
- Public Member Functions inherited from fbcpp::ServiceManager
 ServiceManager (Client &client, const ServiceManagerOptions &options={})
 Attaches to the service manager specified by the given options.
 
 ServiceManager (ServiceManager &&o) noexcept
 Move constructor.
 
ServiceManager & operator= (ServiceManager &&o) noexcept
 Transfers ownership of another ServiceManager into this one.
 
 ServiceManager (const ServiceManager &)=delete
 
ServiceManager & operator= (const ServiceManager &)=delete
 
 ~ServiceManager () noexcept
 Detaches from the service manager.
 
bool isValid () noexcept
 Returns whether the ServiceManager object is valid.
 
Client & getClient () noexcept
 Returns the Client object reference used to create this ServiceManager object.
 
FbRef< fb::IService > getHandle () noexcept
 Returns the internal Firebird IService handle.
 
void disconnect ()
 Detaches from the service manager.
 

Additional Inherited Members

- Public Types inherited from fbcpp::ServiceManager
using VerboseOutput = std::function< void(std::string_view line)>
 Function invoked when a verbose service output line is available.
 
- Protected Member Functions inherited from fbcpp::ServiceManager
void startAction (const std::vector< std::uint8_t > &spb)
 
void waitForCompletion (const VerboseOutput &verboseOutput={}, bool requestStdin=false)
 
- Static Protected Member Functions inherited from fbcpp::ServiceManager
static void addSpbInt (fb::IXpbBuilder *builder, impl::StatusWrapper *status, unsigned char tag, std::uint64_t value, const char *what)
 

Detailed Description

Executes backup and restore operations through the Firebird service manager.

Definition at line 329 of file BackupManager.h.

Member Function Documentation

◆ backup()

void BackupManager::backup ( const BackupOptions &  options)

Runs a backup operation using the provided options.

Definition at line 32 of file BackupManager.cpp.

◆ restore()

void BackupManager::restore ( const RestoreOptions &  options)

Runs a restore operation using the provided options.

Definition at line 61 of file BackupManager.cpp.

◆ ServiceManager() [1/2]

ServiceManager::ServiceManager ( Client &  client,
const ServiceManagerOptions &  options = {} 
)
explicit

Attaches to the service manager specified by the given options.

Definition at line 209 of file ServiceManager.cpp.

◆ ServiceManager() [2/2]

fbcpp::ServiceManager::ServiceManager ( ServiceManager &&  o)
inlinenoexcept

Move constructor.

A moved ServiceManager object becomes invalid.

Definition at line 215 of file ServiceManager.h.


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