Kinetica   C#   API  Version 7.2.3.0
Public Attributes | List of all members
kinetica.RestoreBackupRequest.Options Struct Reference

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

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.

Leave empty to restore the most recent backup instance. 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.

Supported values:

The default value is TRUE.

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.

Supported values:

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.

Supported values:

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.

Supported values:

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

Definition at line 118 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

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.

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

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.

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.

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: