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

Inheritance diagram for kinetica.AlterBackupRequest:

Collaboration diagram for kinetica.AlterBackupRequest:

Classes
struct	Action
	A set of string constants for the parameter action. More...

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

Public Member Functions
	AlterBackupRequest ()
	Constructs an AlterBackupRequest object with default parameters. More...

	AlterBackupRequest (string backup_name, string action, string _value, string datasink_name, IDictionary< string, string > options=null)
	Constructs an AlterBackupRequest object with the specified parameters. More...

	AlterBackupRequest ()
	Constructs an AlterBackupRequest object with default parameters. More...

	AlterBackupRequest (string backup_name, string action, string _value, string datasink_name, IDictionary< string, string > options=null)
	Constructs an AlterBackupRequest 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 to be altered More...

string	action `[get, set]`
	Operation to be applied. More...

string	_value `[get, set]`
	Action specific argument. More...

string	datasink_name `[get, set]`
	Datasink where backup will be stored. 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.alterBackup.

Alters an existing database backup containing a current snapshot of existing objects.

Alters an existing database backup, accessible via the data sink specified by datasink_name.

Definition at line 16 of file AlterBackup.cs.

Constructor & Destructor Documentation

◆ AlterBackupRequest() [1/4]

kinetica.AlterBackupRequest.AlterBackupRequest ( )

inline

Constructs an AlterBackupRequest object with default parameters.

Definition at line 137 of file AlterBackup.cs.

◆ AlterBackupRequest() [2/4]

kinetica.AlterBackupRequest.AlterBackupRequest	(	string	backup_name,
		string	action,
		string	_value,
		string	datasink_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AlterBackupRequest object with the specified parameters.

Parameters

backup_name	Name of the backup object to be altered
action	Operation to be applied. Supported values: CHECKSUM: Calculate checksum for backup files DDL_ONLY: Only save the DDL, do not backup table data MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep MERGE: Merges all backup instances and creates a single full backup PURGE: Purges backup instances
_value	Action specific argument.
datasink_name	Datasink where backup will be stored.
options	Optional parameters. COMMENT: Comments to store with the new backup instance DRY_RUN: Dry run of backup changes. Supported values: FALSE TRUE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 201 of file AlterBackup.cs.

◆ AlterBackupRequest() [3/4]

kinetica.AlterBackupRequest.AlterBackupRequest ( )

inline

Constructs an AlterBackupRequest object with default parameters.

Definition at line 152 of file AlterBackup.cs.

◆ AlterBackupRequest() [4/4]

kinetica.AlterBackupRequest.AlterBackupRequest	(	string	backup_name,
		string	action,
		string	_value,
		string	datasink_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs an AlterBackupRequest object with the specified parameters.

Parameters

backup_name	Name of the backup to be altered.
action	Operation to be applied. Supported values: CHECKSUM: Calculate checksum for backed-up files. DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set _value to 'true' or 'false' for DDL only or DDL and table data, respectively. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set _value to the number of snapshots to keep. MERGE: Merges all snapshots within a backup and creates a single full snapshot. PURGE: Deletes a snapshot from a backup; set _value to the snapshot ID to purge.
_value	Value of the modification, depending on action .
datasink_name	Data sink through which the backup is accessible.
options	Optional parameters. COMMENT: Comments to store with the backup. DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 223 of file AlterBackup.cs.

Property Documentation

◆ _value

string kinetica.AlterBackupRequest._value

getset

Action specific argument.

Value of the modification, depending on action.

Definition at line 104 of file AlterBackup.cs.

◆ action

string kinetica.AlterBackupRequest.action

getset

Operation to be applied.

Supported values:

CHECKSUM: Calculate checksum for backup files
DDL_ONLY: Only save the DDL, do not backup table data
MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep
MERGE: Merges all backup instances and creates a single full backup
PURGE: Purges backup instances

Supported values:

CHECKSUM: Calculate checksum for backed-up files.
DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set _value to 'true' or 'false' for DDL only or DDL and table data, respectively.
MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set _value to the number of snapshots to keep.
MERGE: Merges all snapshots within a backup and creates a single full snapshot.
PURGE: Deletes a snapshot from a backup; set _value to the snapshot ID to purge.

Definition at line 101 of file AlterBackup.cs.

◆ backup_name

string kinetica.AlterBackupRequest.backup_name

getset

Name of the backup object to be altered

Name of the backup to be altered.

Definition at line 69 of file AlterBackup.cs.

◆ datasink_name

string kinetica.AlterBackupRequest.datasink_name

getset

Datasink where backup will be stored.

Data sink through which the backup is accessible.

Definition at line 107 of file AlterBackup.cs.

◆ options

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

getset

Optional parameters.

COMMENT: Comments to store with the new backup instance
DRY_RUN: Dry run of backup changes. Supported values:
- FALSE
- TRUE
The default value is FALSE.

The default value is an empty Dictionary.

COMMENT: Comments to store with the backup.
DRY_RUN: Whether or not to perform a dry run of a backup alteration. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 133 of file AlterBackup.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/AlterBackup.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AlterBackupRequest() [1/4]

◆ AlterBackupRequest() [2/4]

◆ AlterBackupRequest() [3/4]

◆ AlterBackupRequest() [4/4]

Property Documentation

◆ _value

◆ action

◆ backup_name

◆ datasink_name

◆ options