A set of parameters for GPUdb::showBackup. More…
#include <gpudb/protocol/show_backup.h>
Public Member Functions | |
| ShowBackupRequest () | |
| Constructs a ShowBackupRequest object with default parameters. | |
| ShowBackupRequest (const std::string &backupName_, const std::string &datasourceName_, const std::map< std::string, std::string > &options_) | |
| Constructs a ShowBackupRequest object with the specified parameters. | |
Public Attributes | |
| std::string | backupName |
| Name of the backup. | |
| std::string | datasourceName |
| Data source through which the backup is accessible. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::showBackup.
Shows information about one or more backups accessible via the data source specified by datasourceName.
Definition at line 21 of file show_backup.h.
Constructor & Destructor Documentation
◆ ShowBackupRequest() [1/2]
| inline |
Constructs a ShowBackupRequest object with default parameters.
Definition at line 26 of file show_backup.h.
◆ ShowBackupRequest() [2/2]
| inline |
Constructs a ShowBackupRequest object with the specified parameters.
| [in] | backupName_ | Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”. |
| [in] | datasourceName_ | Data source through which the backup is accessible. |
| [in] | options_ | Optional parameters.
|
Definition at line 117 of file show_backup.h.
Member Data Documentation
◆ backupName
| std::string gpudb::ShowBackupRequest::backupName |
Name of the backup.
An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”.
Definition at line 129 of file show_backup.h.
◆ datasourceName
| std::string gpudb::ShowBackupRequest::datasourceName |
Data source through which the backup is accessible.
Definition at line 134 of file show_backup.h.
◆ options
| std::map<std::string, std::string> gpudb::ShowBackupRequest::options |
Optional parameters.
- show_backup_backup_id: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
- show_backup_backup_type: Show backups by type. This option is ignored if backup_id is non-empty. Supported values:
- show_backup_all: Show all backup types.
- show_backup_full: Show full backups only.
- show_backup_incremental: Show incremental backups only.
- show_backup_differential: Show differential backups only.
- show_backup_show_contents: Show the contents of the backed-up snapshots. Supported values:
- show_backup_none: Don’t show snapshot contents.
- show_backup_object_names: Show backed-up object names, and for tables, sizing detail.
- show_backup_object_files: Show backed-up object names, and for tables, sizing detail and associated files.
- show_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value is show_backup_false.
The default value is an empty map.
Definition at line 192 of file show_backup.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/show_backup.h