Kinetica   C#   API  Version 7.2.3.0
CreateBackup.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
20  public class CreateBackupRequest : KineticaData
21  {
25  public struct BackupType
26  {
29  public const string INCREMENTAL = "incremental";
30 
33  public const string DIFFERENTIAL = "differential";
34 
37  public const string FULL = "full";
38  } // end struct BackupType
39 
45  public struct BackupObjectsMap
46  {
50  public const string ALL = "all";
51 
56  public const string TABLE = "table";
57 
59  public const string CATALOG = "catalog";
60 
63  public const string CREDENTIAL = "credential";
64 
67  public const string CONTEXT = "context";
68 
71  public const string DATASINK = "datasink";
72 
75  public const string DATASOURCE = "datasource";
76 
79  public const string STORED_PROCEDURE = "stored_procedure";
80 
85  public const string MONITOR = "monitor";
86 
91  public const string USER = "user";
92 
96  public const string ROLE = "role";
97 
114  public const string CONFIGURATION = "configuration";
115 
116  public const string TRUE = "true";
117  public const string FALSE = "false";
118  } // end struct BackupObjectsMap
119 
123  public struct Options
124  {
126  public const string COMMENT = "comment";
127 
141  public const string CHECKSUM = "checksum";
142 
143  public const string TRUE = "true";
144  public const string FALSE = "false";
145 
163  public const string DDL_ONLY = "ddl_only";
164 
168  public const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep";
169 
184  public const string DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups";
185 
200  public const string RECREATE = "recreate";
201 
215  public const string DRY_RUN = "dry_run";
216  } // end struct Options
217 
223  public string backup_name { get; set; }
224 
246  public string backup_type { get; set; }
247 
348  public IDictionary<string, string> backup_objects_map { get; set; } = new Dictionary<string, string>();
349 
352  public string datasink_name { get; set; }
353 
458  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
459 
462  public CreateBackupRequest() { }
463 
700  string backup_type,
701  IDictionary<string, string> backup_objects_map,
702  string datasink_name,
703  IDictionary<string, string> options = null)
704  {
705  this.backup_name = backup_name ?? "";
706  this.backup_type = backup_type ?? "";
707  this.backup_objects_map = backup_objects_map ?? new Dictionary<string, string>();
708  this.datasink_name = datasink_name ?? "";
709  this.options = options ?? new Dictionary<string, string>();
710  } // end constructor
711  } // end class CreateBackupRequest
712 
716  public class CreateBackupResponse : KineticaData
717  {
720  public string backup_name { get; set; }
721 
723  public long backup_id { get; set; }
724 
727  public long copied_bytes { get; set; }
728 
730  public long copied_files { get; set; }
731 
734  public long copied_records { get; set; }
735 
738  public long total_number_of_records { get; set; }
739 
741  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
742  } // end class CreateBackupResponse
743 } // end namespace kinetica
const string STORED_PROCEDURE
SQL Procedure
Definition: CreateBackup.cs:56
const string FULL
Snapshot of the given database objects and data.
Definition: CreateBackup.cs:25
long copied_records
Total number of records in all files copied for this snapshot
long total_number_of_records
Total number of records that can be restored from this snapshot
string backup_name
Name for this backup object.
const string COMMENT
Comments to store with this backup
Definition: CreateBackup.cs:96
IDictionary< string, string > options
Optional parameters.
long copied_files
Total number of files copied for this snapshot
const string CONFIGURATION
If TRUE, backup the database configuration file.
Definition: CreateBackup.cs:84
const string ROLE
Role, role members (roles or users, recursively) and associated permissions
Definition: CreateBackup.cs:67
A set of string constants for the parameter options.
Definition: CreateBackup.cs:93
IDictionary< string, string > info
Additional information.
CreateBackupRequest()
Constructs a CreateBackupRequest object with default parameters.
const string DIFFERENTIAL
Snapshot of changes in the database objects and data since the last full snapshot.
Definition: CreateBackup.cs:24
const string MONITOR
Table Monitor (Stream)
Definition: CreateBackup.cs:59
const string CHECKSUM
Calculate checksum for backup files.
const string INCREMENTAL
Snapshot of changes in the database objects and data since the last snapshot of any kind.
Definition: CreateBackup.cs:23
long copied_bytes
Total size of all files copied for this snapshot
const string MAX_INCREMENTAL_BACKUPS_TO_KEEP
Maximum number of incremental backups to keep.
string backup_name
Value of backup_name.
IDictionary< string, string > backup_objects_map
Map of objects to be captured in the backup.
const string DRY_RUN
Dry run of backup.
string backup_type
Type of backup to create.
const string ALL
All object types in a schema (excludes permissions, system configuration, host secret key,...
Definition: CreateBackup.cs:38
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.
string datasink_name
Datasink where backup will be stored.
const string RECREATE
Replace the existing backup object with a new full backup if it already exists.
const string DELETE_INTERMEDIATE_BACKUPS
When the backup type is differential, delete any intermediate incremental or differential backups.
const string DDL_ONLY
Only save the DDL, do not backup table data.
const string USER
User (internal and external) and associated permissions
Definition: CreateBackup.cs:63