◆ createBackup() \[1/4]

CreateBackupResponse gpudb::GPUdb::createBackup

(

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