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

Inheritance diagram for kinetica.CreateBackupRequest:

Collaboration diagram for kinetica.CreateBackupRequest:

Classes
struct	BackupObjectsMap
	A set of string constants for the parameter backup_objects_map. More...

struct	BackupType
	A set of string constants for the parameter backup_type. More...

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

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

	CreateBackupRequest (string backup_name, string backup_type, IDictionary< string, string > backup_objects_map, string datasink_name, IDictionary< string, string > options=null)
	Constructs a CreateBackupRequest object with the specified parameters. More...

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

	CreateBackupRequest (string backup_name, string backup_type, IDictionary< string, string > backup_objects_map, string datasink_name, IDictionary< string, string > options=null)
	Constructs a CreateBackupRequest 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 for this backup object. More...

string	backup_type `[get, set]`
	Type of backup to create. More...

IDictionary< string, string >	backup_objects_map = new Dictionary<string, string>() `[get, set]`
	Map of objects to be captured in the backup. 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.createBackup.

Creates a database backup containing a current snapshot of existing objects.

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasink_name.

Definition at line 16 of file CreateBackup.cs.

Constructor & Destructor Documentation

◆ CreateBackupRequest() [1/4]

kinetica.CreateBackupRequest.CreateBackupRequest ( )

inline

Constructs a CreateBackupRequest object with default parameters.

Definition at line 384 of file CreateBackup.cs.

◆ CreateBackupRequest() [2/4]

kinetica.CreateBackupRequest.CreateBackupRequest	(	string	backup_name,
		string	backup_type,
		IDictionary< string, string >	backup_objects_map,
		string	datasink_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateBackupRequest object with the specified parameters.

Parameters

backup_name	Name for this backup object. If the backup object already exists, only an incremental or differential backup can be made, unless recreate is specified
backup_type	Type of backup to create. Supported values: INCREMENTAL DIFFERENTIAL FULL
backup_objects_map	Map of objects to be captured in the backup. Error if empty and creating full backup. Error if non-empty when creating an incremental or differential 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, backup the database configuration file. Supported values: FALSE TRUE The default value is FALSE.
datasink_name	Datasink where backup will be stored.
options	Optional parameters. COMMENT: Comments to store with this backup CHECKSUM: Calculate checksum for backup files. Supported values: FALSE TRUE The default value is TRUE. DDL_ONLY: Only save the DDL, do not backup table data. Supported values: TRUE FALSE The default value is FALSE. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep. The default value is '-1'. DELETE_INTERMEDIATE_BACKUPS: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides MAX_INCREMENTAL_BACKUPS_TO_KEEP. Supported values: FALSE TRUE The default value is FALSE. RECREATE: Replace the existing backup object with a new full backup if it already exists. Supported values: FALSE TRUE The default value is FALSE. DRY_RUN: Dry run of backup. Supported values: FALSE TRUE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 584 of file CreateBackup.cs.

◆ CreateBackupRequest() [3/4]

kinetica.CreateBackupRequest.CreateBackupRequest ( )

inline

Constructs a CreateBackupRequest object with default parameters.

Definition at line 454 of file CreateBackup.cs.

◆ CreateBackupRequest() [4/4]

kinetica.CreateBackupRequest.CreateBackupRequest	(	string	backup_name,
		string	backup_type,
		IDictionary< string, string >	backup_objects_map,
		string	datasink_name,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a CreateBackupRequest object with the specified parameters.

Parameters

backup_name	Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.
backup_type	Type of snapshot to create. Supported values: INCREMENTAL: Snapshot of changes in the database objects & data since the last snapshot of any kind. DIFFERENTIAL: Snapshot of changes in the database objects & data since the last full snapshot. FULL: Snapshot of the given database objects and data.
backup_objects_map	Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot. ALL: All object types and data contained in the given schemas(s). TABLE: Tables(s) and SQL view(s). CREDENTIAL: Credential(s). CONTEXT: Context(s). DATASINK: Data sink(s). DATASOURCE: Data source(s). STORED_PROCEDURE: SQL procedure(s). MONITOR: Table monitor(s) / SQL stream(s). USER: User(s) (internal and external) and associated permissions. ROLE: Role(s), role members (roles or users, recursively), and associated permissions. CONFIGURATION: If TRUE, backup the database configuration file. Supported values: TRUE FALSE The default value is FALSE.
datasink_name	Data sink through which the backup will be stored.
options	Optional parameters. COMMENT: Comments to store with this backup. CHECKSUM: Whether or not to calculate checksums for backup files. Supported values: TRUE FALSE The default value is FALSE. DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values: TRUE: For tables, only back up DDL, not data. FALSE: For tables, back up DDL and data. The default value is FALSE. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is '-1'. DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL. Supported values: TRUE FALSE The default value is FALSE. RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values: TRUE FALSE The default value is FALSE. DRY_RUN: Whether or not to perform a dry run of a backup operation. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 686 of file CreateBackup.cs.

Property Documentation

◆ backup_name

string kinetica.CreateBackupRequest.backup_name

getset

Name for this backup object.

Name for this backup.

If the backup object already exists, only an incremental or differential backup can be made, unless recreate is specified

If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.

Definition at line 183 of file CreateBackup.cs.

◆ backup_objects_map

IDictionary< string, string > kinetica.CreateBackupRequest.backup_objects_map = new Dictionary<string, string>()

getset

Map of objects to be captured in the backup.

Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot.

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, backup the database configuration file. Supported values:
- FALSE
- TRUE
The default value is FALSE.

ALL: All object types and data contained in the given schemas(s).
TABLE: Tables(s) and SQL view(s).
CREDENTIAL: Credential(s).
CONTEXT: Context(s).
DATASINK: Data sink(s).
DATASOURCE: Data source(s).
STORED_PROCEDURE: SQL procedure(s).
MONITOR: Table monitor(s) / SQL stream(s).
USER: User(s) (internal and external) and associated permissions.
ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
CONFIGURATION: If TRUE, backup the database configuration file. Supported values:
- TRUE
- FALSE
The default value is FALSE.

Definition at line 278 of file CreateBackup.cs.

◆ backup_type

string kinetica.CreateBackupRequest.backup_type

getset

Type of backup to create.

Type of snapshot to create.

Supported values:

INCREMENTAL: Snapshot of changes in the database objects & data since the last snapshot of any kind.
DIFFERENTIAL: Snapshot of changes in the database objects & data since the last full snapshot.
FULL: Snapshot of the given database objects and data.

Definition at line 200 of file CreateBackup.cs.

◆ datasink_name

string kinetica.CreateBackupRequest.datasink_name

getset

Datasink where backup will be stored.

Data sink through which the backup will be stored.

Definition at line 281 of file CreateBackup.cs.

◆ options

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

getset

Optional parameters.

COMMENT: Comments to store with this backup
CHECKSUM: Calculate checksum for backup files. Supported values:
- FALSE
- TRUE
The default value is TRUE.
DDL_ONLY: Only save the DDL, do not backup table data. Supported values:
- TRUE
- FALSE
The default value is FALSE.
MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental backups to keep. The default value is '-1'.
DELETE_INTERMEDIATE_BACKUPS: When the backup type is differential, delete any intermediate incremental or differential backups. This overrides MAX_INCREMENTAL_BACKUPS_TO_KEEP. Supported values:
- FALSE
- TRUE
The default value is FALSE.
RECREATE: Replace the existing backup object with a new full backup if it already exists. Supported values:
- FALSE
- TRUE
The default value is FALSE.
DRY_RUN: Dry run of backup. Supported values:
- FALSE
- TRUE
The default value is FALSE.

The default value is an empty Dictionary.

COMMENT: Comments to store with this backup.
CHECKSUM: Whether or not to calculate checksums for backup files. Supported values:
- TRUE
- FALSE
The default value is FALSE.
DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values:
- TRUE: For tables, only back up DDL, not data.
- FALSE: For tables, back up DDL and data.
The default value is FALSE.
MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is '-1'.
DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL. Supported values:
- TRUE
- FALSE
The default value is FALSE.
RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values:
- TRUE
- FALSE
The default value is FALSE.
DRY_RUN: Whether or not to perform a dry run of a backup operation. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

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

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateBackupRequest() [1/4]

◆ CreateBackupRequest() [2/4]

◆ CreateBackupRequest() [3/4]

◆ CreateBackupRequest() [4/4]

Property Documentation

◆ backup_name

◆ backup_objects_map

◆ backup_type

◆ datasink_name

◆ options