createBackup - Kinetica Docs

◆ createBackup() [1/4]

CreateBackupResponse gpudb::GPUdb::createBackup ( const CreateBackupRequest & request_ ) const

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasinkName.

Parameters

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

Returns

Response object containing the result of the operation.

◆ createBackup() [2/4]

CreateBackupResponse & gpudb::GPUdb::createBackup	(	const CreateBackupRequest &	request_,
		CreateBackupResponse &	response_ ) const

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasinkName.

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).

◆ createBackup() [3/4]

CreateBackupResponse gpudb::GPUdb::createBackup	(	const std::string &	backupName,
		const std::string &	backupType,
		const std::map< std::string, std::string > &	backupObjectsMap,
		const std::string &	datasinkName,
		const std::map< std::string, std::string > &	options ) const

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasinkName.

Parameters

[in]	backupName	Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.
[in]	backupType	Type of snapshot to create. Supported values: create_backup_differential: Snapshot of changes in the database objects and data since the last full snapshot. create_backup_full: Snapshot of the given database objects and data. create_backup_incremental: Snapshot of changes in the database objects and data since the last snapshot of any kind.
[in]	backupObjectsMap	Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot. create_backup_all: All object types and data contained in the given schema(s). create_backup_catalog: Data Lake catalog that is external to the database. create_backup_context: Context(s). create_backup_credential: Credential(s). create_backup_datasink: Data sink(s). create_backup_datasource: Data source(s). create_backup_directory: KiFS File directory(ies). create_backup_function_environment: Python UDF function environment(s). create_backup_graph: Graph definition(s). Source table(s), if applicable, are required in order to restore graph objects. create_backup_monitor: Table monitor(s) / SQL stream(s). create_backup_resource_group: Resource group(s). create_backup_role: Role(s), role members (roles or users, recursively), and associated permissions. create_backup_stored_procedure: SQL procedure(s). create_backup_table: Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. create_backup_user: User(s) (internal and external) and associated permissions. create_backup_user_defined_function: UDF(s). The default value is an empty map.
[in]	datasinkName	Data sink through which the backup will be stored.
[in]	options	Optional parameters. create_backup_block_table_mutations: Whether or not to block all mutations on target tables while they are being backed up. Supported values: create_backup_true: Block all mutations on target tables while they are being backed up. create_backup_false: Only block mutations on a target table at the point a disk eviction is necessary. The default value is create_backup_false. create_backup_checksum: Whether or not to calculate checksums for backup files. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_comment: Comments to store with this backup. create_backup_ddl_only: Whether or not, for tables, to only backup DDL and not table data. Supported values: create_backup_true: For tables, only back up DDL, not data. create_backup_false: For tables, back up DDL and data. The default value is create_backup_false. create_backup_delete_intermediate_backups: Whether or not to delete any intermediate snapshots when the backupType is set to differential. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_dry_run: Whether or not to perform a dry run of a backup operation. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep. The default value is ‘-1’. create_backup_recreate: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values: create_backup_true create_backup_false The default value is create_backup_false. The default value is an empty map.

Returns

Response object containing the result of the operation.

◆ createBackup() [4/4]

CreateBackupResponse & gpudb::GPUdb::createBackup	(	const std::string &	backupName,
		const std::string &	backupType,
		const std::map< std::string, std::string > &	backupObjectsMap,
		const std::string &	datasinkName,
		const std::map< std::string, std::string > &	options,
		CreateBackupResponse &	response_ ) const

Creates a database backup, containing a snapshot of existing objects, at the remote file store accessible via the data sink specified by datasinkName.

Parameters

[in]	backupName	Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless recreate is set to true.
[in]	backupType	Type of snapshot to create. Supported values: create_backup_differential: Snapshot of changes in the database objects and data since the last full snapshot. create_backup_full: Snapshot of the given database objects and data. create_backup_incremental: Snapshot of changes in the database objects and data since the last snapshot of any kind.
[in]	backupObjectsMap	Map of objects to be captured in the backup; must be specified when creating a full snapshot and left unspecified when creating an incremental or differential snapshot. create_backup_all: All object types and data contained in the given schema(s). create_backup_catalog: Data Lake catalog that is external to the database. create_backup_context: Context(s). create_backup_credential: Credential(s). create_backup_datasink: Data sink(s). create_backup_datasource: Data source(s). create_backup_directory: KiFS File directory(ies). create_backup_function_environment: Python UDF function environment(s). create_backup_graph: Graph definition(s). Source table(s), if applicable, are required in order to restore graph objects. create_backup_monitor: Table monitor(s) / SQL stream(s). create_backup_resource_group: Resource group(s). create_backup_role: Role(s), role members (roles or users, recursively), and associated permissions. create_backup_stored_procedure: SQL procedure(s). create_backup_table: Table(s) and SQL view(s). Active subscriptions on any tables to be backed up will be temporarily suspended while the backup is active. create_backup_user: User(s) (internal and external) and associated permissions. create_backup_user_defined_function: UDF(s). The default value is an empty map.
[in]	datasinkName	Data sink through which the backup will be stored.
[in]	options	Optional parameters. create_backup_block_table_mutations: Whether or not to block all mutations on target tables while they are being backed up. Supported values: create_backup_true: Block all mutations on target tables while they are being backed up. create_backup_false: Only block mutations on a target table at the point a disk eviction is necessary. The default value is create_backup_false. create_backup_checksum: Whether or not to calculate checksums for backup files. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_comment: Comments to store with this backup. create_backup_ddl_only: Whether or not, for tables, to only backup DDL and not table data. Supported values: create_backup_true: For tables, only back up DDL, not data. create_backup_false: For tables, back up DDL and data. The default value is create_backup_false. create_backup_delete_intermediate_backups: Whether or not to delete any intermediate snapshots when the backupType is set to differential. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_dry_run: Whether or not to perform a dry run of a backup operation. Supported values: create_backup_true create_backup_false The default value is create_backup_false. create_backup_max_incremental_backups_to_keep: Maximum number of incremental snapshots to keep. The default value is ‘-1’. create_backup_recreate: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values: create_backup_true create_backup_false The default value is create_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).

​◆ createBackup() [1/4]

​◆ createBackup() [2/4]

​◆ createBackup() [3/4]

​◆ createBackup() [4/4]

◆ createBackup() [1/4]

◆ createBackup() [2/4]

◆ createBackup() [3/4]

◆ createBackup() [4/4]