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

A set of string constants for the RestoreBackupRequest parameter options.

Optional parameters.

Field Summary

Fields

Modifier and Type	Field and Description
static String	BACKUP_ID Backup instance ID to restore.
static String	CHECKSUM Verify checksum for backup files.
static String	CREATE_SCHEMA_IF_NOT_EXIST Create the schema for an object to be restored if it does not currently exist.
static String	DDL_ONLY Only recreates the objects from their DDL, do not restore table data.
static String	DRY_RUN Does a dry-run restoration operation.
static String	FALSE
static String	NONE If an object to be restored currently exists with the same name, abort and return error
static String	RENAME If an object to be restored currently exists with the same name, rename the original version
static String	RENAMED_OBJECTS_SCHEMA If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one.
static String	REPLACE If an object to be restored currently exists with the same name, replace it with the backup version
static String	RESTORE_POLICY Behavior to apply when restoring objects that already exist.
static String	TRUE

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BACKUP_ID

public static final String BACKUP_ID

Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''.

See Also:

Constant Field Values

RESTORE_POLICY

public static final String RESTORE_POLICY

Behavior to apply when restoring objects that already exist. Supported values:

• NONE: If an object to be restored currently exists with the same name, abort and return error
• REPLACE: If an object to be restored currently exists with the same name, replace it with the backup version
• RENAME: If an object to be restored currently exists with the same name, rename the original version

The default value is NONE.

See Also:

Constant Field Values

NONE

public static final String NONE

If an object to be restored currently 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 currently 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 currently exists with the same name, rename the original version

See Also:

Constant Field Values

RENAMED_OBJECTS_SCHEMA

public static final String RENAMED_OBJECTS_SCHEMA

If the restore policy is rename, optionally use this schema for renamed objects instead of a 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

Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values:

• FALSE
• TRUE

The default value is TRUE.

See Also:

Constant Field Values

FALSE

public static final String FALSE

See Also:

Constant Field Values

TRUE

public static final String TRUE

See Also:

Constant Field Values

DDL_ONLY

public static final String DDL_ONLY

Only recreates the objects from their DDL, do not restore table data. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values

CHECKSUM

public static final String CHECKSUM

Verify checksum for backup files. Supported values:

• FALSE
• TRUE

The default value is TRUE.

See Also:

Constant Field Values

DRY_RUN

public static final String DRY_RUN

Does a dry-run restoration operation. Supported values:

• TRUE
• FALSE

The default value is FALSE.

See Also:

Constant Field Values