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

Executes configuration and maintenance operations through the Firebird service manager. More...

#include <DatabaseManager.h>

Inheritance diagram for fbcpp::DatabaseManager:
Collaboration diagram for fbcpp::DatabaseManager:

Public Member Functions

void setProperties (const DatabasePropertiesOptions &options)
 Configures database properties using the provided options.
 
void repair (const DatabaseRepairOptions &options)
 Runs a repair 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 configuration and maintenance operations through the Firebird service manager.

Definition at line 432 of file DatabaseManager.h.

Member Function Documentation

◆ repair()

void DatabaseManager::repair ( const DatabaseRepairOptions &  options)

Runs a repair operation using the provided options.

Definition at line 128 of file DatabaseManager.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.

◆ setProperties()

void DatabaseManager::setProperties ( const DatabasePropertiesOptions &  options)

Configures database properties using the provided options.

Definition at line 33 of file DatabaseManager.cpp.


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