A set of string constants for the parameter ShowBackupRequest.options. More…
Static Public Attributes | |
| const string | BACKUP_ID = “backup_id” |
| ID of the snapshot to show. | |
| const string | BACKUP_TYPE = “backup_type” |
| Show backups by type. | |
| const string | ALL = “all” |
| Show all backup types. | |
| const string | FULL = “full” |
| Show full backups only. | |
| const string | INCREMENTAL = “incremental” |
| Show incremental backups only. | |
| const string | DIFFERENTIAL = “differential” |
| Show differential backups only. | |
| const string | SHOW_CONTENTS = “show_contents” |
| Show the contents of the backed-up snapshots. | |
| const string | NONE = “none” |
| Don’t show snapshot contents. | |
| const string | OBJECT_NAMES = “object_names” |
| Show backed-up object names, and for tables, sizing detail. | |
| const string | OBJECT_FILES = “object_files” |
| Show backed-up object names, and for tables, sizing detail and associated files. | |
| const string | NO_ERROR_IF_NOT_EXISTS = “no_error_if_not_exists” |
| Whether or not to suppress the error if the specified backup does not exist. | |
| const string | TRUE = “true” |
| A boolean constant for the ShowBackupRequest.Options options. | |
| const string | FALSE = “false” |
| A boolean constant for the ShowBackupRequest.Options options. | |
Detailed Description
A set of string constants for the parameter ShowBackupRequest.options.
Optional parameters.
Definition at line 25 of file ShowBackup.cs.
Member Data Documentation
◆ ALL
| static |
Show all backup types.
Definition at line 66 of file ShowBackup.cs.
◆ BACKUP_ID
| static |
ID of the snapshot to show.
Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
Definition at line 30 of file ShowBackup.cs.
◆ BACKUP_TYPE
| static |
Show backups by type.
This option is ignored if BACKUP_ID is non-empty. Supported values:
- ALL: Show all backup types.
- FULL: Show full backups only.
- INCREMENTAL: Show incremental backups only.
- DIFFERENTIAL: Show differential backups only.
The default value is ALL.
Definition at line 63 of file ShowBackup.cs.
◆ DIFFERENTIAL
| static |
Show differential backups only.
Definition at line 75 of file ShowBackup.cs.
◆ FALSE
| static |
A boolean constant for the ShowBackupRequest.Options options.
Definition at line 139 of file ShowBackup.cs.
◆ FULL
| static |
Show full backups only.
Definition at line 69 of file ShowBackup.cs.
◆ INCREMENTAL
| static |
Show incremental backups only.
Definition at line 72 of file ShowBackup.cs.
◆ NO_ERROR_IF_NOT_EXISTS
| static |
Whether or not to suppress the error if the specified backup does not exist.
Supported values:
The default value is FALSE.
Definition at line 131 of file ShowBackup.cs.
◆ NONE
| static |
Don’t show snapshot contents.
Definition at line 105 of file ShowBackup.cs.
◆ OBJECT_FILES
| static |
Show backed-up object names, and for tables, sizing detail and associated files.
Definition at line 113 of file ShowBackup.cs.
◆ OBJECT_NAMES
| static |
Show backed-up object names, and for tables, sizing detail.
Definition at line 109 of file ShowBackup.cs.
◆ SHOW_CONTENTS
| static |
Show the contents of the backed-up snapshots.
Supported values:
- NONE: Don’t show snapshot contents.
- OBJECT_NAMES: Show backed-up object names, and for tables, sizing detail.
- OBJECT_FILES: Show backed-up object names, and for tables, sizing detail and associated files.
The default value is NONE.
Definition at line 102 of file ShowBackup.cs.
◆ TRUE
| static |
A boolean constant for the ShowBackupRequest.Options options.
Definition at line 135 of file ShowBackup.cs.
The documentation for this struct was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ShowBackup.cs
- Kinetica/Protocol/ShowBackup.cs