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

Public Attributes
const string	BACKUP_ID = "backup_id"
	ID of the snapshot to restore. More...

const string	CHECKSUM = "checksum"
	Whether or not to verify checksums for backup files when restoring. More...

const string	TRUE = "true"
	Restore table data by re-ingesting it. More...

const string	FALSE = "false"
	Restore the persisted data files directly. More...

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. More...

const string	DDL_ONLY = "ddl_only"
	Behavior to apply when restoring tables. More...

const string	DRY_RUN = "dry_run"
	Whether or not to perform a dry run of the restoration operation. More...

const string	RESTORE_SUBSCRIPTIONS = "restore_subscriptions"
	Behavior to apply when restoring datasource subscriptions on tables. More...

const string	RESUME = "resume"
	Resume subscriptions that were active when the backup was made. More...

const string	PAUSE = "pause"
	Pause subscriptions that were active when the backup was made. More...

const string	CANCEL = "cancel"
	Cancel active subscriptions. More...

const string	REINGEST = "reingest"
	Behavior to apply when restoring table data. More...

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. More...

const string	RESTORE_POLICY = "restore_policy"
	Behavior to apply when any database object to restore already exists. More...

const string	NONE = "none"
	If an object to be restored already exists with the same name, abort and return error. More...

const string	REPLACE = "replace"
	If an object to be restored already exists with the same name, replace it with the backup version. More...

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. More...

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 100 of file RestoreBackup.cs.

Member Data Documentation

◆ BACKUP_ID

const string RestoreBackupRequest.Options.BACKUP_ID = "backup_id"

ID of the snapshot to restore.

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

Definition at line 105 of file RestoreBackup.cs.

◆ CANCEL

const string RestoreBackupRequest.Options.CANCEL = "cancel"

Cancel active subscriptions.

Definition at line 214 of file RestoreBackup.cs.

◆ CHECKSUM

const string RestoreBackupRequest.Options.CHECKSUM = "checksum"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 120 of file RestoreBackup.cs.

◆ CREATE_SCHEMA_IF_NOT_EXIST

const string RestoreBackupRequest.Options.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.

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 148 of file RestoreBackup.cs.

◆ DDL_ONLY

const string RestoreBackupRequest.Options.DDL_ONLY = "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.

Definition at line 165 of file RestoreBackup.cs.

◆ DRY_RUN

const string RestoreBackupRequest.Options.DRY_RUN = "dry_run"

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 180 of file RestoreBackup.cs.

◆ FALSE

const string RestoreBackupRequest.Options.FALSE = "false"

Restore the persisted data files directly.

Definition at line 129 of file RestoreBackup.cs.

◆ NONE

const string RestoreBackupRequest.Options.NONE = "none"

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

Definition at line 273 of file RestoreBackup.cs.

◆ PAUSE

const string RestoreBackupRequest.Options.PAUSE = "pause"

Pause subscriptions that were active when the backup was made.

Definition at line 211 of file RestoreBackup.cs.

◆ REINGEST

const string RestoreBackupRequest.Options.REINGEST = "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.

Definition at line 233 of file RestoreBackup.cs.

◆ RENAME

const string RestoreBackupRequest.Options.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.

This policy does not apply to non-schema objects.

Definition at line 285 of file RestoreBackup.cs.

◆ RENAMED_OBJECTS_SCHEMA

const string RestoreBackupRequest.Options.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.

The default value is ''.

Definition at line 240 of file RestoreBackup.cs.

◆ REPLACE

const string RestoreBackupRequest.Options.REPLACE = "replace"

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

Definition at line 277 of file RestoreBackup.cs.

◆ RESTORE_POLICY

const string RestoreBackupRequest.Options.RESTORE_POLICY = "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.

Definition at line 269 of file RestoreBackup.cs.

◆ RESTORE_SUBSCRIPTIONS

const string RestoreBackupRequest.Options.RESTORE_SUBSCRIPTIONS = "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.

Definition at line 203 of file RestoreBackup.cs.

◆ RESUME

const string RestoreBackupRequest.Options.RESUME = "resume"

Resume subscriptions that were active when the backup was made.

Definition at line 207 of file RestoreBackup.cs.

◆ TRUE

const string RestoreBackupRequest.Options.TRUE = "true"

Restore table data by re-ingesting it.

This is the default behavior if the cluster topology differs from that of the contained backup.

Definition at line 126 of file RestoreBackup.cs.

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

Kinetica/Protocol/RestoreBackup.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ BACKUP_ID

◆ CANCEL

◆ CHECKSUM

◆ CREATE_SCHEMA_IF_NOT_EXIST

◆ DDL_ONLY

◆ DRY_RUN

◆ FALSE

◆ NONE

◆ PAUSE

◆ REINGEST

◆ RENAME

◆ RENAMED_OBJECTS_SCHEMA

◆ REPLACE

◆ RESTORE_POLICY

◆ RESTORE_SUBSCRIPTIONS

◆ RESUME

◆ TRUE