Class RestoreBackupRequest.Options

    • Field Detail

      • BACKUP_ID

        public static final String BACKUP_ID
        ID of the snapshot to restore. Leave empty to restore the most recent snapshot in the backup. The default value is ''.
        See Also:
        Constant Field Values
      • RESTORE_POLICY

        public static final String RESTORE_POLICY
        Behavior to apply when any database object to restore already exists. Supported values:
        • NONE: If an object to be restored already exists with the same name, abort and return error.
        • REPLACE: If an object to be restored already exists with the same name, replace it with the backup version.
        • RENAME: If an object to be restored already exists with the same name, move that existing one to the schema specified by RENAMED_OBJECTS_SCHEMA.
        The default value is NONE.
        See Also:
        Constant Field Values
      • NONE

        public static final String NONE
        If an object to be restored already exists with the same name, abort and return error.
        See Also:
        Constant Field Values
      • REPLACE

        public static final String REPLACE
        If an object to be restored already exists with the same name, replace it with the backup version.
        See Also:
        Constant Field Values
      • RENAMED_OBJECTS_SCHEMA

        public static final String RENAMED_OBJECTS_SCHEMA
        If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the default generated one. The default value is ''.
        See Also:
        Constant Field Values
      • CREATE_SCHEMA_IF_NOT_EXIST

        public static final String CREATE_SCHEMA_IF_NOT_EXIST
        Behavior to apply when the schema containing any database object to restore does not already exist. Supported values:
        • TRUE: If the schema containing any restored object does not exist, create it automatically.
        • FALSE: If the schema containing any restored object does not exist, return an error.
        The default value is TRUE.
        See Also:
        Constant Field Values
      • REINGEST

        public static final String REINGEST
        Behavior to apply when restoring table data. Supported values:
        • TRUE: Restore table data by re-ingesting it. This is the default behavior if the cluster topology differs from that of the contained backup.
        • FALSE: Restore the persisted data files directly.
        The default value is FALSE.
        See Also:
        Constant Field Values
      • DDL_ONLY

        public static final String DDL_ONLY
        Behavior to apply when restoring tables. Supported values:
        • TRUE: Restore table DDL, but do not restore data.
        • FALSE: Restore tables and their data.
        The default value is FALSE.
        See Also:
        Constant Field Values