Package com.gpudb.protocol
Class RestoreBackupRequest.Options
- java.lang.Object
-
- com.gpudb.protocol.RestoreBackupRequest.Options
-
- Enclosing class:
- RestoreBackupRequest
public static final class RestoreBackupRequest.Options extends Object
-
-
Field Summary
Fields Modifier and Type Field Description static StringBACKUP_IDID of the snapshot to restore.static StringCHECKSUMWhether or not to verify checksums for backup files when restoring.static StringCREATE_SCHEMA_IF_NOT_EXISTBehavior to apply when the schema containing any database object to restore does not already exist.static StringDDL_ONLYBehavior to apply when restoring tables.static StringDRY_RUNWhether or not to perform a dry run of the restoration operation.static StringFALSEstatic StringNONEIf an object to be restored already exists with the same name, abort and return error.static StringREINGESTBehavior to apply when restoring table data.static StringRENAMEIf an object to be restored already exists with the same name, move that existing one to the schema specified byRENAMED_OBJECTS_SCHEMA.static StringRENAMED_OBJECTS_SCHEMAIf theRESTORE_POLICYisRENAME, use this schema for relocated existing objects instead of the default generated one.static StringREPLACEIf an object to be restored already exists with the same name, replace it with the backup version.static StringRESTORE_POLICYBehavior to apply when any database object to restore already exists.static StringTRUE
-
-
-
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 byRENAMED_OBJECTS_SCHEMA.
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
-
RENAME
public static final String RENAME
If an object to be restored already exists with the same name, move that existing one to the schema specified byRENAMED_OBJECTS_SCHEMA.- See Also:
- Constant Field Values
-
RENAMED_OBJECTS_SCHEMA
public static final String RENAMED_OBJECTS_SCHEMA
If theRESTORE_POLICYisRENAME, 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.
TRUE.- See Also:
- Constant Field Values
-
TRUE
public static final String TRUE
- See Also:
- Constant Field Values
-
FALSE
public static final String FALSE
- 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.
FALSE.- See Also:
- Constant Field Values
-
DDL_ONLY
public static final String DDL_ONLY
Behavior to apply when restoring tables. Supported values: The default value isFALSE.- See Also:
- Constant Field Values
-
CHECKSUM
public static final String CHECKSUM
Whether or not to verify checksums for backup files when restoring. Supported values: The default value isFALSE.- See Also:
- Constant Field Values
-
DRY_RUN
public static final String DRY_RUN
Whether or not to perform a dry run of the restoration operation. Supported values: The default value isFALSE.- See Also:
- Constant Field Values
-
-