​

Field Details

• ​

  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

• ​

  CHECKSUM

  public static final String CHECKSUM

  Whether or not to verify checksums for backup files when restoring. Supported values:

  • TRUE
  • FALSE

  The default value is FALSE.

  See Also:

  • Constant Field Values

• ​

  TRUE

  public static final String TRUE

  Restore all permissions.

  See Also:

  • Constant Field Values

• ​

  FALSE

  public static final String FALSE

  Restore only permissions on restored objects.

  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

• ​

  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

• ​

  DRY_RUN

  public static final String DRY_RUN

  Whether or not to perform a dry run of the restoration operation. Supported values:

  • TRUE
  • FALSE

  The default value is FALSE.

  See Also:

  • Constant Field Values

• ​

  RESTORE_SUBSCRIPTIONS

  public static final String RESTORE_SUBSCRIPTIONS

  Behavior to apply when restoring datasource subscriptions on tables. Supported values:

  • RESUME: Resume subscriptions that were active when the backup was made.
  • PAUSE: Pause subscriptions that were active when the backup was made.
  • CANCEL: Cancel active subscriptions.

  The default value is RESUME.

  See Also:

  • Constant Field Values

• ​

  RESUME

  public static final String RESUME

  Resume subscriptions that were active when the backup was made.

  See Also:

  • Constant Field Values

• ​

  PAUSE

  public static final String PAUSE

  Pause subscriptions that were active when the backup was made.

  See Also:

  • Constant Field Values

• ​

  CANCEL

  public static final String CANCEL

  Cancel active subscriptions.

  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

• ​

  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

• ​

  RESTORE_ALL_PERMISSIONS

  public static final String RESTORE_ALL_PERMISSIONS

  Whether or not all permissions of restored principals should be restored or scoped to the restored objects. Supported values:

  • TRUE: Restore all permissions.
  • FALSE: Restore only permissions on restored objects.

  The default value is FALSE.

  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. This policy does not apply to non-schema objects.

  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

• ​

  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 by RENAMED_OBJECTS_SCHEMA. This policy does not apply to non-schema objects.

  See Also:

  • Constant Field Values

• ​

  TARGET_SCHEMA_MAP

  public static final String TARGET_SCHEMA_MAP

  Restore schema-based objects to alternate schema. Value is a comma delimitted list of key:value pairs mapping the original (source) schema name as it exists in the backup to a target (destination) schema namespace: ‘<src>:<dst>,<src>:<dst>,…’. Note that schema names are case sensitive and must adhere to the database schema naming criteria. The default value is ”.

  See Also:

  • Constant Field Values