Skip to main content

​
◆ alterBackup() [1/4]

AlterBackupResponse gpudb::GPUdb::alterBackup (const AlterBackupRequest &request_) const

Alters an existing database backup, accessible via the data sink specified by datasinkName.

Parameters
[in]request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

​
◆ alterBackup() [2/4]

AlterBackupResponse & gpudb::GPUdb::alterBackup (const AlterBackupRequest &request_,
AlterBackupResponse &response_ ) const

Alters an existing database backup, accessible via the data sink specified by datasinkName.

Parameters
[in]request_Request object containing the parameters for the operation.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).

​
◆ alterBackup() [3/4]

AlterBackupResponse gpudb::GPUdb::alterBackup (const std::string &backupName,
const std::string &action,
const std::string &value,
const std::string &datasinkName,
const std::map< std::string, std::string > &options ) const

Alters an existing database backup, accessible via the data sink specified by datasinkName.

Parameters
[in]backupNameName of the backup to be altered.
[in]actionOperation to be applied. Supported values:
  • alter_backup_checksum: Calculate checksum for backed-up files.
  • alter_backup_ddl_only: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to ‘true’ or ‘false’ for DDL only or DDL and table data, respectively.
  • alter_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
  • alter_backup_merge: Merges all snapshots within a backup and creates a single full snapshot.
  • alter_backup_purge: Deletes a snapshot from a backup; set value to the snapshot ID to purge.
[in]valueValue of the modification, depending on action.
[in]datasinkNameData sink through which the backup is accessible.
[in]optionsOptional parameters.The default value is an empty map.
Returns
Response object containing the result of the operation.

​
◆ alterBackup() [4/4]

AlterBackupResponse & gpudb::GPUdb::alterBackup (const std::string &backupName,
const std::string &action,
const std::string &value,
const std::string &datasinkName,
const std::map< std::string, std::string > &options,
AlterBackupResponse &response_ ) const

Alters an existing database backup, accessible via the data sink specified by datasinkName.

Parameters
[in]backupNameName of the backup to be altered.
[in]actionOperation to be applied. Supported values:
  • alter_backup_checksum: Calculate checksum for backed-up files.
  • alter_backup_ddl_only: Whether or not to only save DDL and not back up table data, when taking future snapshots; set value to ‘true’ or ‘false’ for DDL only or DDL and table data, respectively.
  • alter_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep, when taking future snapshots; set value to the number of snapshots to keep.
  • alter_backup_merge: Merges all snapshots within a backup and creates a single full snapshot.
  • alter_backup_purge: Deletes a snapshot from a backup; set value to the snapshot ID to purge.
[in]valueValue of the modification, depending on action.
[in]datasinkNameData sink through which the backup is accessible.
[in]optionsOptional parameters.The default value is an empty map.
[out]response_Response object containing the results of the operation.
Returns
Response object containing the result of the operation (initially passed in by reference).