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 
60  public const string CREDENTIAL = "credential";
61 
64  public const string CONTEXT = "context";
65 
68  public const string DATASINK = "datasink";
69 
72  public const string DATASOURCE = "datasource";
73 
76  public const string STORED_PROCEDURE = "stored_procedure";
77 
82  public const string MONITOR = "monitor";
83 
88  public const string USER = "user";
89 
93  public const string ROLE = "role";
94 
111  public const string CONFIGURATION = "configuration";
112 
113  public const string TRUE = "true";
114  public const string FALSE = "false";
115  } // end struct BackupObjectsMap
116 
120  public struct Options
121  {
123  public const string COMMENT = "comment";
124 
138  public const string CHECKSUM = "checksum";
139 
140  public const string TRUE = "true";
141  public const string FALSE = "false";
142 
160  public const string DDL_ONLY = "ddl_only";
161 
165  public const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep";
166 
181  public const string DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups";
182 
197  public const string RECREATE = "recreate";
198 
212  public const string DRY_RUN = "dry_run";
213  } // end struct Options
214 
220  public string backup_name { get; set; }
221 
243  public string backup_type { get; set; }
244 
340  public IDictionary<string, string> backup_objects_map { get; set; } = new Dictionary<string, string>();
341 
344  public string datasink_name { get; set; }
345 
450  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
451 
454  public CreateBackupRequest() { }
455 
687  string backup_type,
688  IDictionary<string, string> backup_objects_map,
689  string datasink_name,
690  IDictionary<string, string> options = null)
691  {
692  this.backup_name = backup_name ?? "";
693  this.backup_type = backup_type ?? "";
694  this.backup_objects_map = backup_objects_map ?? new Dictionary<string, string>();
695  this.datasink_name = datasink_name ?? "";
696  this.options = options ?? new Dictionary<string, string>();
697  } // end constructor
698  } // end class CreateBackupRequest
699 
703  public class CreateBackupResponse : KineticaData
704  {
707  public string backup_name { get; set; }
708 
710  public long backup_id { get; set; }
711 
714  public long copied_bytes { get; set; }
715 
717  public long copied_files { get; set; }
718 
721  public long copied_records { get; set; }
722 
725  public long total_number_of_records { get; set; }
726 
728  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
729  } // end class CreateBackupResponse
730 } // 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
IDictionary< string, string > info
Additional information.
CreateBackupRequest()
Constructs a CreateBackupRequest object with default parameters.
const string DIFFERENTIAL
Snapshot of changes in the database objects & 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 & 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