Skip to main content

A set of string constants for the parameter RestoreBackupRequest.options. More…

​
Static Public Attributes

const string BACKUP_ID = “backup_id”
 ID of the snapshot to restore.
 
const string CHECKSUM = “checksum”
 Whether or not to verify checksums for backup files when restoring.
 
const string TRUE = “true”
 A boolean constant for the RestoreBackupRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the RestoreBackupRequest.Options options.
 
const string CREATE_SCHEMA_IF_NOT_EXIST = “create_schema_if_not_exist”
 Behavior to apply when the schema containing any database object to restore does not already exist.
 
const string DDL_ONLY = “ddl_only”
 Behavior to apply when restoring tables.
 
const string DRY_RUN = “dry_run”
 Whether or not to perform a dry run of the restoration operation.
 
const string RESTORE_SUBSCRIPTIONS = “restore_subscriptions”
 Behavior to apply when restoring datasource subscriptions on tables.
 
const string RESUME = “resume”
 Resume subscriptions that were active when the backup was made.
 
const string PAUSE = “pause”
 Pause subscriptions that were active when the backup was made.
 
const string CANCEL = “cancel”
 Cancel active subscriptions.
 
const string REINGEST = “reingest”
 Behavior to apply when restoring table data.
 
const string RENAMED_OBJECTS_SCHEMA = “renamed_objects_schema”
 If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the default generated one.
 
const string RESTORE_POLICY = “restore_policy”
 Behavior to apply when any database object to restore already exists.
 
const string NONE = “none”
 If an object to be restored already exists with the same name, abort and return error.
 
const string REPLACE = “replace”
 If an object to be restored already exists with the same name, replace it with the backup version.
 
const string RENAME = “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.
 

​
Detailed Description

A set of string constants for the parameter RestoreBackupRequest.options.

Optional parameters.

Definition at line 101 of file RestoreBackup.cs.

​
Member Data Documentation

​
◆ BACKUP_ID

const string kinetica.RestoreBackupRequest.Options.BACKUP_ID = “backup_id”
 static

ID of the snapshot to restore.

Leave empty to restore the most recent snapshot in the backup. The default value is ”.

Definition at line 106 of file RestoreBackup.cs.

​
◆ CANCEL

const string kinetica.RestoreBackupRequest.Options.CANCEL = “cancel”
 static

Cancel active subscriptions.

Definition at line 237 of file RestoreBackup.cs.

​
◆ CHECKSUM

const string kinetica.RestoreBackupRequest.Options.CHECKSUM = “checksum”
 static

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

Supported values:

The default value is FALSE.

Definition at line 125 of file RestoreBackup.cs.

​
◆ CREATE_SCHEMA_IF_NOT_EXIST

const string kinetica.RestoreBackupRequest.Options.CREATE_SCHEMA_IF_NOT_EXIST = “create_schema_if_not_exist”
 static

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.

Definition at line 156 of file RestoreBackup.cs.

​
◆ DDL_ONLY

const string kinetica.RestoreBackupRequest.Options.DDL_ONLY = “ddl_only”
 static

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.

Definition at line 177 of file RestoreBackup.cs.

​
◆ DRY_RUN

const string kinetica.RestoreBackupRequest.Options.DRY_RUN = “dry_run”
 static

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

Supported values:

The default value is FALSE.

Definition at line 196 of file RestoreBackup.cs.

​
◆ FALSE

const string kinetica.RestoreBackupRequest.Options.FALSE = “false”
 static

A boolean constant for the RestoreBackupRequest.Options options.

Definition at line 133 of file RestoreBackup.cs.

​
◆ NONE

const string kinetica.RestoreBackupRequest.Options.NONE = “none”
 static

If an object to be restored already exists with the same name, abort and return error.

Definition at line 307 of file RestoreBackup.cs.

​
◆ PAUSE

const string kinetica.RestoreBackupRequest.Options.PAUSE = “pause”
 static

Pause subscriptions that were active when the backup was made.

Definition at line 234 of file RestoreBackup.cs.

​
◆ REINGEST

const string kinetica.RestoreBackupRequest.Options.REINGEST = “reingest”
 static

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.

Definition at line 260 of file RestoreBackup.cs.

​
◆ RENAME

const string kinetica.RestoreBackupRequest.Options.RENAME = “rename”
 static

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.

Definition at line 319 of file RestoreBackup.cs.

​
◆ RENAMED_OBJECTS_SCHEMA

const string kinetica.RestoreBackupRequest.Options.RENAMED_OBJECTS_SCHEMA = “renamed_objects_schema”
 static

If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the default generated one.

The default value is ”.

Definition at line 268 of file RestoreBackup.cs.

​
◆ REPLACE

const string kinetica.RestoreBackupRequest.Options.REPLACE = “replace”
 static

If an object to be restored already exists with the same name, replace it with the backup version.

Definition at line 311 of file RestoreBackup.cs.

​
◆ RESTORE_POLICY

const string kinetica.RestoreBackupRequest.Options.RESTORE_POLICY = “restore_policy”
 static

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.

Definition at line 303 of file RestoreBackup.cs.

​
◆ RESTORE_SUBSCRIPTIONS

const string kinetica.RestoreBackupRequest.Options.RESTORE_SUBSCRIPTIONS = “restore_subscriptions”
 static

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.

Definition at line 226 of file RestoreBackup.cs.

​
◆ RESUME

const string kinetica.RestoreBackupRequest.Options.RESUME = “resume”
 static

Resume subscriptions that were active when the backup was made.

Definition at line 230 of file RestoreBackup.cs.

​
◆ TRUE

const string kinetica.RestoreBackupRequest.Options.TRUE = “true”
 static

A boolean constant for the RestoreBackupRequest.Options options.

Definition at line 129 of file RestoreBackup.cs.

The documentation for this struct was generated from the following files: