Skip to main content

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

​
Static Public Attributes

const string BLOCK_TABLE_MUTATIONS = “block_table_mutations”
 Whether or not to block all mutations on target tables while they are being backed up.
 
const string TRUE = “true”
 A boolean constant for the CreateBackupRequest.Options options.
 
const string FALSE = “false”
 A boolean constant for the CreateBackupRequest.Options options.
 
const string CHECKSUM = “checksum”
 Whether or not to calculate checksums for backup files.
 
const string COMMENT = “comment”
 Comments to store with this backup.
 
const string DDL_ONLY = “ddl_only”
 Whether or not, for tables, to only backup DDL and not table data.
 
const string DELETE_INTERMEDIATE_BACKUPS = “delete_intermediate_backups”
 Whether or not to delete any intermediate snapshots when the CreateBackupRequest.backup_type is set to DIFFERENTIAL.
 
const string DRY_RUN = “dry_run”
 Whether or not to perform a dry run of a backup operation.
 
const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = “max_incremental_backups_to_keep”
 Maximum number of incremental snapshots to keep.
 
const string RECREATE = “recreate”
 Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists.
 

​
Detailed Description

A set of string constants for the parameter CreateBackupRequest.options.

Optional parameters.

Definition at line 127 of file CreateBackup.cs.

​
Member Data Documentation

​
◆ BLOCK_TABLE_MUTATIONS

const string kinetica.CreateBackupRequest.Options.BLOCK_TABLE_MUTATIONS = “block_table_mutations”
 static

Whether or not to block all mutations on target tables while they are being backed up.

Supported values:

  • TRUE: Block all mutations on target tables while they are being backed up.
  • FALSE: Only block mutations on a target table at the point a disk eviction is necessary.

The default value is FALSE.

Definition at line 150 of file CreateBackup.cs.

​
◆ CHECKSUM

const string kinetica.CreateBackupRequest.Options.CHECKSUM = “checksum”
 static

Whether or not to calculate checksums for backup files.

Supported values:

The default value is FALSE.

Definition at line 176 of file CreateBackup.cs.

​
◆ COMMENT

const string kinetica.CreateBackupRequest.Options.COMMENT = “comment”
 static

Comments to store with this backup.

Definition at line 179 of file CreateBackup.cs.

​
◆ DDL_ONLY

const string kinetica.CreateBackupRequest.Options.DDL_ONLY = “ddl_only”
 static

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.

Definition at line 202 of file CreateBackup.cs.

​
◆ DELETE_INTERMEDIATE_BACKUPS

const string kinetica.CreateBackupRequest.Options.DELETE_INTERMEDIATE_BACKUPS = “delete_intermediate_backups”
 static

Whether or not to delete any intermediate snapshots when the CreateBackupRequest.backup_type is set to DIFFERENTIAL.

Supported values:

The default value is FALSE.

Definition at line 222 of file CreateBackup.cs.

​
◆ DRY_RUN

const string kinetica.CreateBackupRequest.Options.DRY_RUN = “dry_run”
 static

Whether or not to perform a dry run of a backup operation.

Supported values:

The default value is FALSE.

Definition at line 240 of file CreateBackup.cs.

​
◆ FALSE

const string kinetica.CreateBackupRequest.Options.FALSE = “false”
 static

A boolean constant for the CreateBackupRequest.Options options.

Definition at line 158 of file CreateBackup.cs.

​
◆ MAX_INCREMENTAL_BACKUPS_TO_KEEP

const string kinetica.CreateBackupRequest.Options.MAX_INCREMENTAL_BACKUPS_TO_KEEP = “max_incremental_backups_to_keep”
 static

Maximum number of incremental snapshots to keep.

The default value is ‘-1’.

Definition at line 244 of file CreateBackup.cs.

​
◆ RECREATE

const string kinetica.CreateBackupRequest.Options.RECREATE = “recreate”
 static

Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists.

Supported values:

The default value is FALSE.

Definition at line 262 of file CreateBackup.cs.

​
◆ TRUE

const string kinetica.CreateBackupRequest.Options.TRUE = “true”
 static

A boolean constant for the CreateBackupRequest.Options options.

Definition at line 154 of file CreateBackup.cs.

The documentation for this struct was generated from the following files:
  • _build/public-os_centos8-arch_amd64-cc_gcc_8.5.0/install/Kinetica/Protocol/CreateBackup.cs
  • Kinetica/Protocol/CreateBackup.cs