A set of parameters for Kinetica.restoreBackup. More...

Inheritance diagram for kinetica.RestoreBackupRequest:

Collaboration diagram for kinetica.RestoreBackupRequest:

Classes
struct	Options
	A set of string constants for the parameter options. More...

struct	RestoreObjectsMap
	A set of string constants for the parameter restore_objects_map. More...

Public Member Functions
	RestoreBackupRequest ()
	Constructs a RestoreBackupRequest object with default parameters. More...

	RestoreBackupRequest (string backup_name, IDictionary< string, string > restore_objects_map, string datasource_name, IDictionary< string, string > options=null)
	Constructs a RestoreBackupRequest object with the specified parameters. More...

	RestoreBackupRequest ()
	Constructs a RestoreBackupRequest object with default parameters. More...

	RestoreBackupRequest (string backup_name, IDictionary< string, string > restore_objects_map, string datasource_name, IDictionary< string, string > options=null)
	Constructs a RestoreBackupRequest object with the specified parameters. More...

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

	KineticaData (KineticaType type)
	Constructor from Kinetica Type More...

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type More...

object	Get (int fieldPos)
	Retrieve a specific property from this object More...

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object More...

Properties
string	backup_name = "" `[get, set]`
	Name of the backup object, which must refer to a currently existing backup. More...

IDictionary< string, string >	restore_objects_map = new Dictionary<string, string>() `[get, set]`
	Map of objects to be restored from the backup. More...

string	datasource_name `[get, set]`
	Datasource where backup is located. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema `[get]`

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType. More...

Detailed Description

A set of parameters for Kinetica.restoreBackup.

Restores objects from a backup instance. Response from a backup restoration operation.

Definition at line 16 of file RestoreBackup.cs.

Constructor & Destructor Documentation

◆ RestoreBackupRequest() [1/4]

kinetica.RestoreBackupRequest.RestoreBackupRequest ( )

inline

Constructs a RestoreBackupRequest object with default parameters.

Definition at line 401 of file RestoreBackup.cs.

◆ RestoreBackupRequest() [2/4]

kinetica.RestoreBackupRequest.RestoreBackupRequest	(	string	backup_name,
		IDictionary< string, string >	restore_objects_map,
		string	datasource_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a RestoreBackupRequest object with the specified parameters.

Parameters

backup_name	Name of the backup object, which must refer to a currently existing backup. The default value is ''.
restore_objects_map	Map of objects to be restored from the backup. Error if empty. ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions) TABLE: Database Table CREDENTIAL: Credential CONTEXT: Context DATASINK: Data Sink DATASOURCE: Data Source STORED_PROCEDURE: SQL Procedure MONITOR: Table Monitor (Stream) USER: User (internal and external) and associated permissions ROLE: Role, role members (roles or users, recursively) and associated permissions CONFIGURATION: If TRUE, restore the database configuration file. Supported values: FALSE TRUE The default value is FALSE.
datasource_name	Datasource where backup is located.
options	Optional parameters. BACKUP_ID: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''. 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. 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 ''. CREATE_SCHEMA_IF_NOT_EXIST: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values: FALSE TRUE The default value is TRUE. DDL_ONLY: Only recreates the objects from their DDL, do not restore table data. Supported values: TRUE FALSE The default value is FALSE. CHECKSUM: Verify checksum for backup files. Supported values: FALSE TRUE The default value is TRUE. DRY_RUN: Does a dry-run restoration operation. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 603 of file RestoreBackup.cs.

◆ RestoreBackupRequest() [3/4]

kinetica.RestoreBackupRequest.RestoreBackupRequest ( )

inline

Constructs a RestoreBackupRequest object with default parameters.

Definition at line 401 of file RestoreBackup.cs.

◆ RestoreBackupRequest() [4/4]

kinetica.RestoreBackupRequest.RestoreBackupRequest	(	string	backup_name,
		IDictionary< string, string >	restore_objects_map,
		string	datasource_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a RestoreBackupRequest object with the specified parameters.

Parameters

backup_name	Name of the backup object, which must refer to a currently existing backup. The default value is ''.
restore_objects_map	Map of objects to be restored from the backup. Error if empty. ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions) TABLE: Database Table CREDENTIAL: Credential CONTEXT: Context DATASINK: Data Sink DATASOURCE: Data Source STORED_PROCEDURE: SQL Procedure MONITOR: Table Monitor (Stream) USER: User (internal and external) and associated permissions ROLE: Role, role members (roles or users, recursively) and associated permissions CONFIGURATION: If TRUE, restore the database configuration file. Supported values: FALSE TRUE The default value is FALSE.
datasource_name	Datasource where backup is located.
options	Optional parameters. BACKUP_ID: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''. 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. 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 ''. CREATE_SCHEMA_IF_NOT_EXIST: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values: FALSE TRUE The default value is TRUE. DDL_ONLY: Only recreates the objects from their DDL, do not restore table data. Supported values: TRUE FALSE The default value is FALSE. CHECKSUM: Verify checksum for backup files. Supported values: FALSE TRUE The default value is TRUE. DRY_RUN: Does a dry-run restoration operation. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 603 of file RestoreBackup.cs.

Property Documentation

◆ backup_name

string kinetica.RestoreBackupRequest.backup_name = ""

getset

Name of the backup object, which must refer to a currently existing backup.

The default value is ''.

Definition at line 199 of file RestoreBackup.cs.

◆ datasource_name

string kinetica.RestoreBackupRequest.datasource_name

getset

Datasource where backup is located.

Definition at line 282 of file RestoreBackup.cs.

◆ options

IDictionary< string, string > kinetica.RestoreBackupRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

BACKUP_ID: Backup instance ID to restore. Leave empty to restore the most recent backup instance. The default value is ''.
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.
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 ''.
CREATE_SCHEMA_IF_NOT_EXIST: Create the schema for an object to be restored if it does not currently exist. Error otherwise. Supported values:
- FALSE
- TRUE
The default value is TRUE.
DDL_ONLY: Only recreates the objects from their DDL, do not restore table data. Supported values:
- TRUE
- FALSE
The default value is FALSE.
CHECKSUM: Verify checksum for backup files. Supported values:
- FALSE
- TRUE
The default value is TRUE.
DRY_RUN: Does a dry-run restoration operation. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 397 of file RestoreBackup.cs.

◆ restore_objects_map

IDictionary< string, string > kinetica.RestoreBackupRequest.restore_objects_map = new Dictionary<string, string>()

getset

Map of objects to be restored from the backup.

ALL: All object types in a schema (excludes permissions, system configuration, host secret key, KiFS directories and user defined functions)
TABLE: Database Table
CREDENTIAL: Credential
CONTEXT: Context
DATASINK: Data Sink
DATASOURCE: Data Source
STORED_PROCEDURE: SQL Procedure
MONITOR: Table Monitor (Stream)
USER: User (internal and external) and associated permissions
ROLE: Role, role members (roles or users, recursively) and associated permissions
CONFIGURATION: If TRUE, restore the database configuration file. Supported values:
- FALSE
- TRUE
The default value is FALSE.

Definition at line 279 of file RestoreBackup.cs.

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

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

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ RestoreBackupRequest() [1/4]

◆ RestoreBackupRequest() [2/4]

◆ RestoreBackupRequest() [3/4]

◆ RestoreBackupRequest() [4/4]

Property Documentation

◆ backup_name

◆ datasource_name

◆ options

◆ restore_objects_map