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

Public Attributes
const string	BACKUP_ID = "backup_id"
	Backup instance ID to restore. More...

const string	RESTORE_POLICY = "restore_policy"
	Behavior to apply when restoring objects that already exist. More...

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

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

const string	RENAME = "rename"
	If an object to be restored currently exists with the same name, rename the original version More...

const string	RENAMED_OBJECTS_SCHEMA = "renamed_objects_schema"
	If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one. More...

const string	CREATE_SCHEMA_IF_NOT_EXIST = "create_schema_if_not_exist"
	Create the schema for an object to be restored if it does not currently exist. More...

const string	FALSE = "false"

const string	TRUE = "true"

const string	DDL_ONLY = "ddl_only"
	Only recreates the objects from their DDL, do not restore table data. More...

const string	CHECKSUM = "checksum"
	Verify checksum for backup files. More...

const string	DRY_RUN = "dry_run"
	Does a dry-run restoration operation. More...

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

Detailed Description

A set of string constants for the parameter options.

Optional parameters.

Definition at line 82 of file RestoreBackup.cs.

Member Data Documentation

◆ BACKUP_ID

const string kinetica.RestoreBackupRequest.Options.BACKUP_ID = "backup_id"

Backup instance ID to restore.

ID of the snapshot to restore.

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

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

Definition at line 87 of file RestoreBackup.cs.

◆ CHECKSUM

const string kinetica.RestoreBackupRequest.Options.CHECKSUM = "checksum"

Verify checksum for backup files.

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

Supported values:

FALSE
TRUE

The default value is TRUE.

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 179 of file RestoreBackup.cs.

◆ CREATE_SCHEMA_IF_NOT_EXIST

const string kinetica.RestoreBackupRequest.Options.CREATE_SCHEMA_IF_NOT_EXIST = "create_schema_if_not_exist"

Create the schema for an object to be restored if it does not currently exist.

Behavior to apply when the schema containing any database object to restore does not already exist.

Supported values:

FALSE
TRUE

The default value is TRUE.

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

◆ DDL_ONLY

const string kinetica.RestoreBackupRequest.Options.DDL_ONLY = "ddl_only"

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

Behavior to apply when restoring tables.

Supported values:

TRUE
FALSE

The default value is FALSE.

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 kinetica.RestoreBackupRequest.Options.DRY_RUN = "dry_run"

Does a dry-run restoration operation.

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

Supported values:

TRUE
FALSE

The default value is FALSE.

Definition at line 193 of file RestoreBackup.cs.

◆ FALSE

const string kinetica.RestoreBackupRequest.Options.FALSE = "false"

Definition at line 149 of file RestoreBackup.cs.

◆ NONE

const string kinetica.RestoreBackupRequest.Options.NONE = "none"

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

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

Definition at line 118 of file RestoreBackup.cs.

◆ REINGEST

const string kinetica.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 200 of file RestoreBackup.cs.

◆ RENAME

const string kinetica.RestoreBackupRequest.Options.RENAME = "rename"

If an object to be restored currently exists with the same name, rename the original version

If an object to be restored already exists with the same name, move that existing one to the schema specified by RENAMED_OBJECTS_SCHEMA.

Definition at line 126 of file RestoreBackup.cs.

◆ RENAMED_OBJECTS_SCHEMA

const string kinetica.RestoreBackupRequest.Options.RENAMED_OBJECTS_SCHEMA = "renamed_objects_schema"

If the restore policy is rename, optionally use this schema for renamed objects instead of a default generated one.

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

◆ REPLACE

const string kinetica.RestoreBackupRequest.Options.REPLACE = "replace"

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

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

Definition at line 122 of file RestoreBackup.cs.

◆ RESTORE_POLICY

const string kinetica.RestoreBackupRequest.Options.RESTORE_POLICY = "restore_policy"

Behavior to apply when restoring objects that already exist.

Behavior to apply when any database object to restore already exists.

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.

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.

The default value is NONE.

Definition at line 114 of file RestoreBackup.cs.

◆ TRUE

const string kinetica.RestoreBackupRequest.Options.TRUE = "true"

Definition at line 150 of file RestoreBackup.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/RestoreBackup.cs

Public Attributes

Detailed Description

Member Data Documentation

◆ BACKUP_ID

◆ CHECKSUM

◆ CREATE_SCHEMA_IF_NOT_EXIST

◆ DDL_ONLY

◆ DRY_RUN

◆ FALSE

◆ NONE

◆ REINGEST

◆ RENAME

◆ RENAMED_OBJECTS_SCHEMA

◆ REPLACE

◆ RESTORE_POLICY

◆ TRUE