showBackup - Kinetica Docs

◆ showBackup() [1/4]

ShowBackupResponse gpudb::GPUdb::showBackup ( const ShowBackupRequest & request_ ) const

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

Parameters

[in] request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

ShowBackupResponse & gpudb::GPUdb::showBackup	(	const ShowBackupRequest &	request_,
		ShowBackupResponse &	response_ ) const

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

Parameters

[in]	request_	Request object containing the parameters for the operation.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).

ShowBackupResponse gpudb::GPUdb::showBackup	(	const std::string &	backupName,
		const std::string &	datasourceName,
		const std::map< std::string, std::string > &	options ) const

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

Parameters

[in]	backupName	Name 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 ”.
[in]	datasourceName	Data source through which the backup is accessible.
[in]	options	Optional parameters. show_backup_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 ”. show_backup_backup_type: Show backups by type. This option is ignored if backup_id is non-empty. Supported values: show_backup_all: Show all backup types. show_backup_full: Show full backups only. show_backup_incremental: Show incremental backups only. show_backup_differential: Show differential backups only. The default value is show_backup_all. show_backup_show_contents: Show the contents of the backed-up snapshots. Supported values: show_backup_none: Don’t show snapshot contents. show_backup_object_names: Show backed-up object names, and for tables, sizing detail. show_backup_object_files: Show backed-up object names, and for tables, sizing detail and associated files. The default value is show_backup_none. show_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values: show_backup_true show_backup_false The default value is show_backup_false. The default value is an empty map.

Returns

Response object containing the result of the operation.

ShowBackupResponse & gpudb::GPUdb::showBackup	(	const std::string &	backupName,
		const std::string &	datasourceName,
		const std::map< std::string, std::string > &	options,
		ShowBackupResponse &	response_ ) const

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

Parameters

[in]	backupName	Name 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 ”.
[in]	datasourceName	Data source through which the backup is accessible.
[in]	options	Optional parameters. show_backup_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 ”. show_backup_backup_type: Show backups by type. This option is ignored if backup_id is non-empty. Supported values: show_backup_all: Show all backup types. show_backup_full: Show full backups only. show_backup_incremental: Show incremental backups only. show_backup_differential: Show differential backups only. The default value is show_backup_all. show_backup_show_contents: Show the contents of the backed-up snapshots. Supported values: show_backup_none: Don’t show snapshot contents. show_backup_object_names: Show backed-up object names, and for tables, sizing detail. show_backup_object_files: Show backed-up object names, and for tables, sizing detail and associated files. The default value is show_backup_none. show_backup_no_error_if_not_exists: Whether or not to suppress the error if the specified backup does not exist. Supported values: show_backup_true show_backup_false The default value is show_backup_false. The default value is an empty map.
[out]	response_	Response object containing the results of the operation.

Returns

Response object containing the result of the operation (initially passed in by reference).