Skip to main content

​
◆ showBackup() [1/2]

ShowBackupResponse kinetica.Kinetica.showBackup (ShowBackupRequestrequest_)
 inline

Shows information about one or more backups accessible via the data source specified by datasource_name.

Parameters
request_Request object containing the parameters for the operation.
Returns
Response object containing the result of the operation.

Definition at line 59240 of file KineticaFunctions.cs.

​
◆ showBackup() [2/2]

ShowBackupResponse kinetica.Kinetica.showBackup (stringbackup_name,
stringdatasource_name,
IDictionary< string, string >options = null )
 inline

Shows information about one or more backups accessible via the data source specified by datasource_name .

Parameters
backup_nameName of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”.
datasource_nameData source through which the backup is accessible.
optionsOptional parameters.
  • BACKUP_ID: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
  • BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values:The default value is ALL.
  • SHOW_CONTENTS: 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.
  • NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Returns
Response object containing the result of the operation.

Definition at line 59388 of file KineticaFunctions.cs.

​
◆ ShowBackupAsync() [1/2]

async System.Threading.Tasks.Task< ShowBackupResponse > kinetica.Kinetica.ShowBackupAsync (ShowBackupRequestrequest_,
System.Threading.CancellationTokencancellationToken = default )
 inline

Shows information about one or more backups accessible via the data source specified by datasource_name.

(async)

Parameters
request_Request object containing the parameters for the operation.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 59261 of file KineticaFunctions.cs.

​
◆ ShowBackupAsync() [2/2]

async System.Threading.Tasks.Task< ShowBackupResponse > kinetica.Kinetica.ShowBackupAsync (stringbackup_name,
stringdatasource_name,
IDictionary< string, string >options = null,
System.Threading.CancellationTokencancellationToken = default )
 inline

Shows information about one or more backups accessible via the data source specified by datasource_name .

(async)

Parameters
backup_nameName of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”.
datasource_nameData source through which the backup is accessible.
optionsOptional parameters.
  • BACKUP_ID: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
  • BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values:The default value is ALL.
  • SHOW_CONTENTS: 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.
  • NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
cancellationTokenCancellation token to cancel the operation.
Returns
Task that returns the response object containing the result of the operation.

Definition at line 59516 of file KineticaFunctions.cs.