models.restore_sql_app_object_params module

class models.restore_sql_app_object_params.RestoreSqlAppObjectParams(capture_tail_logs=None, continue_after_error=None, data_file_destination=None, db_restore_overwrite_policy=None, enable_checksum=None, instance_name=None, is_auto_sync_enabled=None, is_multi_stage_restore=None, keep_cdc=None, log_file_destination=None, multi_stage_restore_options=None, new_database_name=None, restore_time_secs=None, resume_restore=None, secondary_data_file_destination=None, secondary_data_file_destination_vec=None, with_clause=None, with_no_recovery=None)

Bases: object

Implementation of the ‘RestoreSqlAppObjectParams’ model.

TODO: type model description here.

Attributes:

capture_tail_logs (bool): Set to true if tail logs are to be captured

before the restore operation. This is only applicable if we are restoring the SQL database to its original source, and the database is not being renamed.

continue_after_error (bool): Whether restore should continue after

encountering a page checksum error.

data_file_destination (string): Which directory to put the database

data files. Missing directory will be automatically created. Cannot be empty if not restoring to the original SQL instance.

db_restore_overwrite_policy (int): Policy to overwrite an existing DB

during a restore operation.

enable_checksum (bool): Whether restore checksums are enabled. instance_name (string): The name of the SQL instance that we restore

database to. If target_host is not empty, this also cannot be empty.

is_auto_sync_enabled (bool): The following field is set if auto_sync

for multi-stage SQL restore task is enabled. This field is valid only if is_multi_state_restore is set to true.

is_multi_stage_restore (bool): The following field is set if we are

creating a multi-stage SQL restore task needed for features such as Hot-Standby.

keep_cdc (bool): Set to true to keep cdc on restored database. log_file_destination (string): Which directory to put the database log

files. Missing directory will be automatically created. Cannot be empty if not restoring to the original SQL instance.

multi_stage_restore_options (SqlUpdateRestoreTaskOptions): TODO: type

description here.

new_database_name (string): The new name of the database, if it is

going to be renamed. app_entity in RestoreAppObject has to be non-empty for the renaming, otherwise it does not make sense to rename all databases in the owner.

restore_time_secs (long|int): The time to which the SQL database needs

to be restored. This allows for granular recovery of SQL databases. If this is not set, the SQL database will be recovered to the full/incremental snapshot (specified in the owner’s restore object in AppOwnerRestoreInfo).

resume_restore (bool): Resume restore if sql instance/database exist

in restore/recovering state. The database might be in restore/recovering state if previous restore failed or previous restore was attempted with norecovery option.

secondary_data_file_destination (string): Which directory to put the

secondary data files of the database. Secondary data files are optional and are user defined. The recommended file name extension for these is “.ndf”. If this option is specified, the directory will be automatically created if its missing.

secondary_data_file_destination_vec (list of FilesToDirectoryMapping):

Specify the secondary data files and corresponding direcories of the DB. Secondary data files are optional and are user defined. The recommended file extension for secondary files is “.ndf”. If this option is specified and the destination folders do not exist they will be automatically created.

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

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

with_no_recovery (bool): Set to true if we want to recover the

database in “NO_RECOVERY” mode which does not bring it online after restore.

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.