models.sql_backup_job_params module

class models.sql_backup_job_params.SqlBackupJobParams(aag_backup_preference_type=None, backup_database_volumes_only=None, backup_system_dbs=None, continue_after_error=None, enable_checksum=None, enable_incremental_backup_after_restart=None, full_backup_type=None, is_copy_only_full=None, is_copy_only_log=None, num_dbs_per_batch=None, num_streams=None, use_aag_preferences_from_sql_server=None, user_db_preference_type=None, with_clause=None)

Bases: object

Implementation of the ‘SqlBackupJobParams’ model.

Message to capture additional backup job params specific to SQL.

Attributes:

aag_backup_preference_type (int): Preference type for backing up

databases that are part of an AAG. Only applicable if ‘use_aag_preferences_from_sql_server’ is set to false.

backup_database_volumes_only (bool): If set to true, only the volumes

associated with databases should be backed up. The user cannot select additional volumes at host level for backup. If set to false, all the volumes on the host machine will be backed up. In this case, the user can further select the exact set of volumes using host level params. Note that the volumes associated with selected databases will always be included in the backup.

backup_system_dbs (bool): Set to true if system databases should be

backed up.

continue_after_error (bool): Whether backup should continue after

encountering a page checksum error.

enable_checksum (bool): Whether backup checksums are enabled. enable_incremental_backup_after_restart (bool): If this is set to

true, then incremental backup will be performed after the server restarts, otherwise a full-backup will be done.

full_backup_type (int): The type of SQL full backup to be used for

this job.

is_copy_only_full (bool): Whether full backups should be copy-only. is_copy_only_log (bool): Whether log backups should be copy-only. num_dbs_per_batch (int): The number of databases to be backed up per

batch. This is only applicable for file based sql backup. If this is not specified, we use the value specified in magneto_vss_sql_app_file_batch_size gflag.

num_streams (int): The number of streams to be used in native sql

backup command. This is only applicable for native sql backup. If this is not specified, we use the value specified in magneto_sql_num_streams_for_each_db_backup gflag.

use_aag_preferences_from_sql_server (bool): Set to true if we should

use AAG preferences specified at the SQL server host.

user_db_preference_type (int): Preference type for backing up user

databases on the host.

with_clause (string): ‘with_clause’ contains ‘with clause’ to be used

in native sql backup command. This is only applicable for native sql backup. Here user can specify multiple backup options. Example: “WITH BUFFERCOUNT = 575, MAXTRANSFERSIZE = 2097152”. If this is not specified, we use the value specified in magneto_sql_native_backup_with_clause gflag.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.