createBackup - Kinetica Docs

◆ createBackup() [1/2]

CreateBackupResponse kinetica.Kinetica.createBackup ( CreateBackupRequest request_ )

inline

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

Parameters

request_ Request object containing the parameters for the operation.

Returns

Response object containing the result of the operation.

Definition at line 16892 of file KineticaFunctions.cs.

◆ createBackup() [2/2]

CreateBackupResponse kinetica.Kinetica.createBackup	(	string	backup_name,
		string	backup_type,
		IDictionary< string, string >	backup_objects_map,
		string	datasink_name,
		IDictionary< string, string >	options = null )

inline

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

Parameters

backup_name	Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.
backup_type	Type of snapshot to create. Supported values: DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot. FULL: Snapshot of the given database objects and data. INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
backup_objects_map	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. ALL: All object types and data contained in the given schema(s). CATALOG: Data Lake catalog that is external to the database. CONTEXT: Context(s). CREDENTIAL: Credential(s). DATASINK: Data sink(s). DATASOURCE: Data source(s). DIRECTORY: KiFS File directory(ies). FUNCTION_ENVIRONMENT: Python UDF function environment(s). GRAPH: Graph definition(s). Source table(s), if applicable, are required in order to restore graph objects. MONITOR: Table monitor(s) / SQL stream(s). RESOURCE_GROUP: Resource group(s). ROLE: Role(s), role members (roles or users, recursively), and associated permissions. STORED_PROCEDURE: SQL procedure(s). 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. USER: User(s) (internal and external) and associated permissions. USER_DEFINED_FUNCTION: UDF(s). The default value is an empty Dictionary.
datasink_name	Data sink through which the backup will be stored.
options	Optional parameters. BLOCK_TABLE_MUTATIONS: Whether or not to block all mutations on target tables while they are being backed up. Supported values: TRUE: Block all mutations on target tables while they are being backed up. FALSE: Only block mutations on a target table at the point a disk eviction is necessary. The default value is FALSE. CHECKSUM: Whether or not to calculate checksums for backup files. Supported values: TRUE FALSE The default value is FALSE. COMMENT: Comments to store with this backup. DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values: TRUE: For tables, only back up DDL, not data. FALSE: For tables, back up DDL and data. The default value is FALSE. DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL. Supported values: TRUE FALSE The default value is FALSE. DRY_RUN: Whether or not to perform a dry run of a backup operation. Supported values: TRUE FALSE The default value is FALSE. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is ‘-1’. RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Returns

Response object containing the result of the operation.

Definition at line 17261 of file KineticaFunctions.cs.

◆ CreateBackupAsync() [1/2]

async System.Threading.Tasks.Task< CreateBackupResponse > kinetica.Kinetica.CreateBackupAsync	(	CreateBackupRequest	request_,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

Parameters

request_	Request object containing the parameters for the operation.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 16914 of file KineticaFunctions.cs.

◆ CreateBackupAsync() [2/2]

async System.Threading.Tasks.Task< CreateBackupResponse > kinetica.Kinetica.CreateBackupAsync	(	string	backup_name,
		string	backup_type,
		IDictionary< string, string >	backup_objects_map,
		string	datasink_name,
		IDictionary< string, string >	options = null,
		System.Threading.CancellationToken	cancellationToken = default )

inline

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

(async)

Parameters

backup_name	Name for this backup. If the backup already exists, only an incremental or differential backup can be made, unless RECREATE is set to TRUE.
backup_type	Type of snapshot to create. Supported values: DIFFERENTIAL: Snapshot of changes in the database objects and data since the last full snapshot. FULL: Snapshot of the given database objects and data. INCREMENTAL: Snapshot of changes in the database objects and data since the last snapshot of any kind.
backup_objects_map	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. ALL: All object types and data contained in the given schema(s). CATALOG: Data Lake catalog that is external to the database. CONTEXT: Context(s). CREDENTIAL: Credential(s). DATASINK: Data sink(s). DATASOURCE: Data source(s). DIRECTORY: KiFS File directory(ies). FUNCTION_ENVIRONMENT: Python UDF function environment(s). GRAPH: Graph definition(s). Source table(s), if applicable, are required in order to restore graph objects. MONITOR: Table monitor(s) / SQL stream(s). RESOURCE_GROUP: Resource group(s). ROLE: Role(s), role members (roles or users, recursively), and associated permissions. STORED_PROCEDURE: SQL procedure(s). 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. USER: User(s) (internal and external) and associated permissions. USER_DEFINED_FUNCTION: UDF(s). The default value is an empty Dictionary.
datasink_name	Data sink through which the backup will be stored.
options	Optional parameters. BLOCK_TABLE_MUTATIONS: Whether or not to block all mutations on target tables while they are being backed up. Supported values: TRUE: Block all mutations on target tables while they are being backed up. FALSE: Only block mutations on a target table at the point a disk eviction is necessary. The default value is FALSE. CHECKSUM: Whether or not to calculate checksums for backup files. Supported values: TRUE FALSE The default value is FALSE. COMMENT: Comments to store with this backup. DDL_ONLY: Whether or not, for tables, to only backup DDL and not table data. Supported values: TRUE: For tables, only back up DDL, not data. FALSE: For tables, back up DDL and data. The default value is FALSE. DELETE_INTERMEDIATE_BACKUPS: Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL. Supported values: TRUE FALSE The default value is FALSE. DRY_RUN: Whether or not to perform a dry run of a backup operation. Supported values: TRUE FALSE The default value is FALSE. MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep. The default value is ‘-1’. RECREATE: Whether or not to replace an existing backup object with a new backup with a full snapshot, if one already exists. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.
cancellationToken	Cancellation token to cancel the operation.

Returns

Task that returns the response object containing the result of the operation.

Definition at line 17613 of file KineticaFunctions.cs.

​◆ createBackup() [1/2]

​◆ createBackup() [2/2]

​◆ CreateBackupAsync() [1/2]

​◆ CreateBackupAsync() [2/2]

◆ createBackup() [1/2]

◆ createBackup() [2/2]

◆ CreateBackupAsync() [1/2]

◆ CreateBackupAsync() [2/2]