alterBackup - Kinetica Docs

◆ alterBackup() [1/2]

AlterBackupResponse kinetica.Kinetica.alterBackup ( AlterBackupRequest request_ )

inline

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

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 8055 of file KineticaFunctions.cs.

AlterBackupResponse kinetica.Kinetica.alterBackup	(	string	backup_name,
		string	action,
		string	_value,
		string	datasink_name,
		IDictionary< string, string >	options = null )

inline

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

Parameters

backup_name	Name of the backup to be altered.
action	Operation to be applied. Supported values: CHECKSUM: Calculate checksum for backed-up files. 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. 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. MERGE: Merges all snapshots within a backup and creates a single full snapshot. PURGE: Deletes a snapshot from a backup; set _value to the snapshot ID to purge.
_value	Value of the modification, depending on action .
datasink_name	Data sink through which the backup is accessible.
options	Optional parameters. COMMENT: Comments to store with the backup. DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 8168 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< AlterBackupResponse > kinetica.Kinetica.AlterBackupAsync	(	AlterBackupRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

Parameters

request_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 8076 of file KineticaFunctions.cs.

async System.Threading.Tasks.Task< AlterBackupResponse > kinetica.Kinetica.AlterBackupAsync	(	string	backup_name,
		string	action,
		string	_value,
		string	datasink_name,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

Parameters

backup_name	Name of the backup to be altered.
action	Operation to be applied. Supported values: CHECKSUM: Calculate checksum for backed-up files. 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. 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. MERGE: Merges all snapshots within a backup and creates a single full snapshot. PURGE: Deletes a snapshot from a backup; set _value to the snapshot ID to purge.
_value	Value of the modification, depending on action .
datasink_name	Data sink through which the backup is accessible.
options	Optional parameters. COMMENT: Comments to store with the backup. DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 8264 of file KineticaFunctions.cs.