Skip to main content

  • ​
    alterBackup

    public AlterBackupResponse alterBackup(AlterBackupRequest request) throws GPUdbException
    Alters an existing database backup, accessible via the data sink specified by datasinkName.
    Parameters:
    request - Request object containing the parameters for the operation.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.

  • ​
    alterBackup

    public AlterBackupResponse alterBackup(String backupName, String action, String value, String datasinkName, Map<String,String> options) throws GPUdbException
    Alters an existing database backup, accessible via the data sink specified by datasinkName.
    Parameters:
    backupName - 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.
    datasinkName - 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:The default value is FALSE.
    The default value is an empty Map.
    Returns:
    Response object containing the results of the operation.
    Throws:
    GPUdbException - if an error occurs during the operation.