dropBackup - Kinetica Docs

◆ dropBackup() [1/4]

DropBackupResponse gpudb::GPUdb::dropBackup ( const DropBackupRequest & request_ ) const

Deletes one or more existing database backups and contained snapshots, 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.

DropBackupResponse & gpudb::GPUdb::dropBackup	(	const DropBackupRequest &	request_,
		DropBackupResponse &	response_ ) const

Deletes one or more existing database backups and contained snapshots, 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).

DropBackupResponse gpudb::GPUdb::dropBackup	(	const std::string &	backupName,
		const std::string &	datasinkName,
		const std::map< std::string, std::string > &	options ) const

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasinkName.

Parameters

[in]	backupName	Name of the backup to be deleted. An empty string or '' will delete all existing backups. Any text followed by a '' will delete backups whose name starts with that text. When deleting multiple backups, delete_all_backups must be set to true.
[in]	datasinkName	Data sink through which the backup is accessible.
[in]	options	Optional parameters. drop_backup_dry_run: Whether or not to perform a dry run of a backup deletion. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_delete_all_backups: Allow multiple backups to be deleted if true and multiple backup names are found matching backupName. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. The default value is an empty map.

Returns

Response object containing the result of the operation.

DropBackupResponse & gpudb::GPUdb::dropBackup	(	const std::string &	backupName,
		const std::string &	datasinkName,
		const std::map< std::string, std::string > &	options,
		DropBackupResponse &	response_ ) const

Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasinkName.

Parameters

[in]	backupName	Name of the backup to be deleted. An empty string or '' will delete all existing backups. Any text followed by a '' will delete backups whose name starts with that text. When deleting multiple backups, delete_all_backups must be set to true.
[in]	datasinkName	Data sink through which the backup is accessible.
[in]	options	Optional parameters. drop_backup_dry_run: Whether or not to perform a dry run of a backup deletion. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_delete_all_backups: Allow multiple backups to be deleted if true and multiple backup names are found matching backupName. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. drop_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values: drop_backup_true drop_backup_false The default value is drop_backup_false. 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).