GPUdb C++ API  Version 7.2.2.4
gpudb::AdminBackupBeginRequest Struct Reference

A set of parameters for GPUdb::adminBackupBegin. More...

#include <gpudb/protocol/admin_backup_begin.h>

Public Member Functions

 AdminBackupBeginRequest ()
 Constructs an AdminBackupBeginRequest object with default parameters. More...
 
 AdminBackupBeginRequest (const std::map< std::string, std::string > &options_)
 Constructs an AdminBackupBeginRequest object with the specified parameters. More...
 

Public Attributes

std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::adminBackupBegin.

Prepares the system for a backup by closing all open file handles after allowing current active jobs to complete. When the database is in backup mode, queries that result in a disk write operation will be blocked until backup mode has been completed by using GPUdb::adminBackupEnd.

Definition at line 23 of file admin_backup_begin.h.

Constructor & Destructor Documentation

◆ AdminBackupBeginRequest() [1/2]

gpudb::AdminBackupBeginRequest::AdminBackupBeginRequest ( )
inline

Constructs an AdminBackupBeginRequest object with default parameters.

Definition at line 29 of file admin_backup_begin.h.

◆ AdminBackupBeginRequest() [2/2]

gpudb::AdminBackupBeginRequest::AdminBackupBeginRequest ( const std::map< std::string, std::string > &  options_)
inline

Constructs an AdminBackupBeginRequest object with the specified parameters.

Parameters
[in]options_Optional parameters. The default value is an empty map.

Definition at line 41 of file admin_backup_begin.h.

Member Data Documentation

◆ options

std::map<std::string, std::string> gpudb::AdminBackupBeginRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 49 of file admin_backup_begin.h.


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