kinetica.CreateBackupRequest

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 CreateBackupRequest.backup_objects_map. More…

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

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

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

	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.

	CreateBackupRequest ()
	Constructs a CreateBackupRequest object with default parameters.

	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.

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

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

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

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

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

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

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

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

Properties
string	backup_name `[get, set]`
	Name for this backup.

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

IDictionary< string, string >	backup_objects_map = new Dictionary<string, string>() `[get, set]`
	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.

string	datasink_name `[get, set]`
	Data sink through which the backup will be stored.

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

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

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.

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

Detailed Description

A set of parameters for Kinetica.createBackup.

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

Definition at line 20 of file CreateBackup.cs.

Constructor & Destructor Documentation

◆ CreateBackupRequest() [1/4]

kinetica.CreateBackupRequest.CreateBackupRequest ( )

inline

Constructs a CreateBackupRequest object with default parameters.

Definition at line 543 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. 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: DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot. FULL: Snapshot of the given database objects and data. INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
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 schema(s). CATALOG: Data Lake catalog that is external to the database. CONTEXT: Context(s). CREDENTIAL: Credential(s). DATASINK: Data sink(s). DATASOURCE: Data source(s). FUNCTION_ENVIRONMENT: Python UDF function environment(s). GRAPH: Graph(s) definition. MONITOR: Table monitor(s) / SQL stream(s). RESOURCE_GROUP: Resource group(s). ROLE: Role(s), role members (roles or users, recursively), and associated permissions. STORED_PROCEDURE: SQL procedure(s). TABLE: Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. USER: User(s) (internal and external) and associated permissions. USER_DEFINED_FUNCTION: UDF(s). The default value is an empty Dictionary.
datasink_name	Data sink through which the backup will be stored.
options	Optional parameters. CHECKSUM: Whether or not to calculate checksums for backup files. Supported values: TRUE FALSE The default value is FALSE. COMMENT: Comments to store with this backup. 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. 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. DRY_RUN: Whether or not to perform a dry run of a backup operation. Supported values: TRUE FALSE The default value is FALSE. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is ‘-1’. 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. The default value is an empty Dictionary.

Definition at line 842 of file CreateBackup.cs.

◆ CreateBackupRequest() [3/4]

kinetica.CreateBackupRequest.CreateBackupRequest ( )

inline

Constructs a CreateBackupRequest object with default parameters.

Definition at line 543 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: DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot. FULL: Snapshot of the given database objects and data. INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
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 schema(s). CATALOG: Data Lake catalog that is external to the database. CONTEXT: Context(s). CREDENTIAL: Credential(s). DATASINK: Data sink(s). DATASOURCE: Data source(s). FUNCTION_ENVIRONMENT: Python UDF function environment(s). GRAPH: Graph(s) definition. MONITOR: Table monitor(s) / SQL stream(s). RESOURCE_GROUP: Resource group(s). ROLE: Role(s), role members (roles or users, recursively), and associated permissions. STORED_PROCEDURE: SQL procedure(s). TABLE: Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. USER: User(s) (internal and external) and associated permissions. USER_DEFINED_FUNCTION: UDF(s). The default value is an empty Dictionary.
datasink_name	Data sink through which the backup will be stored.
options	Optional parameters. CHECKSUM: Whether or not to calculate checksums for backup files. Supported values: TRUE FALSE The default value is FALSE. COMMENT: Comments to store with this backup. 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. 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. DRY_RUN: Whether or not to perform a dry run of a backup operation. Supported values: TRUE FALSE The default value is FALSE. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is ‘-1’. 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. The default value is an empty Dictionary.

Definition at line 842 of file CreateBackup.cs.

Property Documentation

◆ backup_name

string kinetica.CreateBackupRequest.backup_name

getset

Name for this backup.

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

Definition at line 242 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; 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 schema(s).
CATALOG: Data Lake catalog that is external to the database.
CONTEXT: Context(s).
CREDENTIAL: Credential(s).
DATASINK: Data sink(s).
DATASOURCE: Data source(s).
FUNCTION_ENVIRONMENT: Python UDF function environment(s).
GRAPH: Graph(s) definition.
MONITOR: Table monitor(s) / SQL stream(s).
RESOURCE_GROUP: Resource group(s).
ROLE: Role(s), role members (roles or users, recursively), and associated permissions.
STORED_PROCEDURE: SQL procedure(s).
TABLE: Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active.
USER: User(s) (internal and external) and associated permissions.
USER_DEFINED_FUNCTION: UDF(s).

The default value is an empty Dictionary.

Definition at line 395 of file CreateBackup.cs.

◆ backup_type

string kinetica.CreateBackupRequest.backup_type

getset

Type of snapshot to create.

Supported values:

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

Definition at line 268 of file CreateBackup.cs.

◆ datasink_name

string kinetica.CreateBackupRequest.datasink_name

getset

Data sink through which the backup will be stored.

Definition at line 398 of file CreateBackup.cs.

◆ options

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

getset

Optional parameters.

CHECKSUM: Whether or not to calculate checksums for backup files. Supported values:
- TRUE
- FALSE
The default value is FALSE.
COMMENT: Comments to store with this backup.
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.
DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the CreateBackupRequest.backup_type is set to DIFFERENTIAL. 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.
MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is ‘-1’.
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.

The default value is an empty Dictionary.

Definition at line 539 of file CreateBackup.cs.

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

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateBackup.cs
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

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