Module cvpysdk.backupsets.db2backupset
File for operating on a DB2 Backupset.
DB2Backupset is the only class defined in this file.
DB2Backupset: Derived class from Backupset Base class, representing a db2 backupset, and to perform operations on that subclient
DB2Backupset:
restore_entire_database() -- runs the restore job for specified backupset
restore_out_of_place() -- runs the out of place restore for given backupset
restore_table_level() -- Table level restore function
DB2Backupset instance Attributes:
**db2_db_status** -- returns db2 database status
Expand source code Browse git
# -*- coding: utf-8 -*-
# --------------------------------------------------------------------------
# Copyright Commvault Systems, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# --------------------------------------------------------------------------
"""File for operating on a DB2 Backupset.
DB2Backupset is the only class defined in this file.
DB2Backupset: Derived class from Backupset Base class, representing a db2 backupset,
and to perform operations on that subclient
DB2Backupset:
=============
restore_entire_database() -- runs the restore job for specified backupset
restore_out_of_place() -- runs the out of place restore for given backupset
restore_table_level() -- Table level restore function
DB2Backupset instance Attributes:
=================================
**db2_db_status** -- returns db2 database status
"""
from __future__ import unicode_literals
from ..backupset import Backupset
class DB2Backupset(Backupset):
"""Derived class from Backupset Base class, representing a db2 backupset,
and to perform operations on that backupset."""
@property
def db2_db_status(self):
"""
returns db2 database status
Returns:
(str) -- Status of db as connected or disconnected
"""
return self._properties.get('db2BackupSet', {}).get('dB2DBStatus', "")
def restore_entire_database(
self,
dest_client_name=None,
dest_instance_name=None,
dest_database_name=None,
**kwargs
):
"""Restores the db2 databases specified in the input paths list to the same location.
Args:
dest_client_name (str) -- destination client name where db need to be
restored
dest_instance_name (str) -- destination db2 instance name of destination
client
dest_database_name (str) -- destination database name
recover_db (bool) -- recover database flag
default: True
restore_incremental (bool) -- Restore incremental flag
default: True
restore_data (bool) -- Restore data or not
default: True
copy_precedence (int) -- Copy precedence to perform restore from
default : None
roll_forward (bool) -- Rollforward database or not
default: True
restore_logs (bool) - Restore the logs or not
default: True
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if failed to initialize job
if response is empty
if response is not success
"""
self._instance_object._restore_association = self._backupset_association
instance_object = self._instance_object
if dest_client_name is None:
dest_client_name = instance_object._agent_object._client_object.client_name
if dest_instance_name is None:
dest_instance_name = instance_object.instance_name
if dest_database_name is None:
dest_database_name = self.backupset_name.upper()
return self._instance_object.restore_entire_database(
dest_client_name, dest_instance_name, dest_database_name, **kwargs)
def restore_out_of_place(
self,
dest_client_name,
dest_instance_name,
dest_backupset_name,
target_path,
**kwargs
):
"""Restores the DB2 data/log files specified in the input paths
list to the same location.
Args:
dest_client_name (str) -- destination client name where files are to be
restored
dest_instance_name (str) -- destination db2 instance name of
destination client
dest_backupset_name (str) -- destination db2 backupset name of
destination client
target_path (str) -- Target DB Restore Destination
copy_precedence (int) -- copy precedence value of storage policy copy
default: None
from_time (str) -- time to retore the contents after
format: YYYY-MM-DD HH:MM:SS
default: None
to_time (str) -- time to retore the contents before
format: YYYY-MM-DD HH:MM:SS
default: None
redirect_enabled (bool) -- boolean to specify if redirect restore is
enabled
default: False
redirect_storage_group_path (dict) -- Path specified for each storage group
in advanced restore options in order to perform redirect restore
format: {'Storage Group Name': 'Redirect Path'}
default: None
redirect_tablespace_path (dict) -- Path specified for each tablespace in advanced
restore options in order to perform redirect restore
format: {'Tablespace name': 'Redirect Path'}
default: None
destination_path (str) -- destinath path for restore
default: None
restore_data (bool) -- Restore data or not
default: True
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if failed to initialize job
if response is empty
if response is not success
"""
self._instance_object._restore_association = self._backupset_association
return self._instance_object.restore_out_of_place(dest_client_name=dest_client_name,
dest_instance_name=dest_instance_name,
dest_backupset_name=dest_backupset_name,
target_path=target_path,
**kwargs)
def restore_table_level(
self,
aux_client_name,
aux_instance_name,
aux_backupset_name,
dest_client_name,
dest_instance_name,
dest_backupset_name,
target_path,
staging_path,
tables_path,
user_name,
password,
**kwargs
):
"""
Performs DB2 table level restore
Args:
aux_client_name (str) -- auxiliary client name where files are to be restored
aux_instance_name (str) -- auxiliary instance name where files are to be restored
aux_backupset_name (str) -- auxiliary backupset name where files are to be restored
dest_client_name (str) -- destination client name where files are to be restored
dest_instance_name (str) -- destination db2 instance name of destination client
dest_backupset_name (str) -- destination db2 backupset name of destination client
target_path (str) -- Destination DB restore path
src_backupset_name (str) -- Source Backupset Name
staging_path (str) -- Staging Path
user_name (str) -- Destination User name
password (str) -- Destination Password
tables_path (list) -- List of tables path
Example:
Unix: ['/+tblview+/instance_name/database_name/schema_name/table_name/**']
Windows: ["\+tblview+\instance_name\database_name\schema_name\table_name\**"]
copy_precedence (int) -- copy precedence value of storage policy copy
default: None
from_time (str) -- time to retore the contents after
format: YYYY-MM-DD HH:MM:SS
default: None
to_time (str) -- time to retore the contents before
format: YYYY-MM-DD HH:MM:SS
default: None
rollForward (bool) -- Rollforward or not
default: True
destination_path (str) -- destinath path for restore
default: None
server_port (int) -- Server Port Destination instance
default: 50000
generateAuthorizationDDL (bool) -- Generate Authorization DDL
default: False
extractDDLStatements (bool) -- Extracts DDL statement or not
default: True
clearAuxiliary (bool) -- Cleanup auxilliary or not
default: True
dropTable (bool) -- Drop table for import
default: False
Returns:
object - instance of the Job class for this restore job
Raises:
SDKException:
if failed to initialize job
if response is empty
if response is not success
"""
self._instance_object._restore_association = self._backupset_association
return self._instance_object.restore_table_level(aux_client_name=aux_client_name,
aux_instance_name=aux_instance_name,
aux_backupset_name=aux_backupset_name,
dest_client_name=dest_client_name,
dest_instance_name=dest_instance_name,
dest_backupset_name=dest_backupset_name,
target_path=target_path,
staging_path=staging_path,
tables_path=tables_path,
user_name=user_name,
password=password,
**kwargs)Classes
class DB2Backupset (instance_object, backupset_name, backupset_id=None)-
Derived class from Backupset Base class, representing a db2 backupset, and to perform operations on that backupset.
Initialise the backupset object.
Args
instance_object (object) – instance of the Instance class
backupset_name (str) – name of the backupset
backupset_id (str) – id of the backupset default: None
Returns
object - instance of the Backupset class
Expand source code Browse git
class DB2Backupset(Backupset): """Derived class from Backupset Base class, representing a db2 backupset, and to perform operations on that backupset.""" @property def db2_db_status(self): """ returns db2 database status Returns: (str) -- Status of db as connected or disconnected """ return self._properties.get('db2BackupSet', {}).get('dB2DBStatus', "") def restore_entire_database( self, dest_client_name=None, dest_instance_name=None, dest_database_name=None, **kwargs ): """Restores the db2 databases specified in the input paths list to the same location. Args: dest_client_name (str) -- destination client name where db need to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_database_name (str) -- destination database name recover_db (bool) -- recover database flag default: True restore_incremental (bool) -- Restore incremental flag default: True restore_data (bool) -- Restore data or not default: True copy_precedence (int) -- Copy precedence to perform restore from default : None roll_forward (bool) -- Rollforward database or not default: True restore_logs (bool) - Restore the logs or not default: True Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ self._instance_object._restore_association = self._backupset_association instance_object = self._instance_object if dest_client_name is None: dest_client_name = instance_object._agent_object._client_object.client_name if dest_instance_name is None: dest_instance_name = instance_object.instance_name if dest_database_name is None: dest_database_name = self.backupset_name.upper() return self._instance_object.restore_entire_database( dest_client_name, dest_instance_name, dest_database_name, **kwargs) def restore_out_of_place( self, dest_client_name, dest_instance_name, dest_backupset_name, target_path, **kwargs ): """Restores the DB2 data/log files specified in the input paths list to the same location. Args: dest_client_name (str) -- destination client name where files are to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_backupset_name (str) -- destination db2 backupset name of destination client target_path (str) -- Target DB Restore Destination copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None redirect_enabled (bool) -- boolean to specify if redirect restore is enabled default: False redirect_storage_group_path (dict) -- Path specified for each storage group in advanced restore options in order to perform redirect restore format: {'Storage Group Name': 'Redirect Path'} default: None redirect_tablespace_path (dict) -- Path specified for each tablespace in advanced restore options in order to perform redirect restore format: {'Tablespace name': 'Redirect Path'} default: None destination_path (str) -- destinath path for restore default: None restore_data (bool) -- Restore data or not default: True Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ self._instance_object._restore_association = self._backupset_association return self._instance_object.restore_out_of_place(dest_client_name=dest_client_name, dest_instance_name=dest_instance_name, dest_backupset_name=dest_backupset_name, target_path=target_path, **kwargs) def restore_table_level( self, aux_client_name, aux_instance_name, aux_backupset_name, dest_client_name, dest_instance_name, dest_backupset_name, target_path, staging_path, tables_path, user_name, password, **kwargs ): """ Performs DB2 table level restore Args: aux_client_name (str) -- auxiliary client name where files are to be restored aux_instance_name (str) -- auxiliary instance name where files are to be restored aux_backupset_name (str) -- auxiliary backupset name where files are to be restored dest_client_name (str) -- destination client name where files are to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_backupset_name (str) -- destination db2 backupset name of destination client target_path (str) -- Destination DB restore path src_backupset_name (str) -- Source Backupset Name staging_path (str) -- Staging Path user_name (str) -- Destination User name password (str) -- Destination Password tables_path (list) -- List of tables path Example: Unix: ['/+tblview+/instance_name/database_name/schema_name/table_name/**'] Windows: ["\+tblview+\instance_name\database_name\schema_name\table_name\**"] copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None rollForward (bool) -- Rollforward or not default: True destination_path (str) -- destinath path for restore default: None server_port (int) -- Server Port Destination instance default: 50000 generateAuthorizationDDL (bool) -- Generate Authorization DDL default: False extractDDLStatements (bool) -- Extracts DDL statement or not default: True clearAuxiliary (bool) -- Cleanup auxilliary or not default: True dropTable (bool) -- Drop table for import default: False Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ self._instance_object._restore_association = self._backupset_association return self._instance_object.restore_table_level(aux_client_name=aux_client_name, aux_instance_name=aux_instance_name, aux_backupset_name=aux_backupset_name, dest_client_name=dest_client_name, dest_instance_name=dest_instance_name, dest_backupset_name=dest_backupset_name, target_path=target_path, staging_path=staging_path, tables_path=tables_path, user_name=user_name, password=password, **kwargs)Ancestors
Instance variables
var db2_db_status-
returns db2 database status
Returns
(str) – Status of db as connected or disconnected
Expand source code Browse git
@property def db2_db_status(self): """ returns db2 database status Returns: (str) -- Status of db as connected or disconnected """ return self._properties.get('db2BackupSet', {}).get('dB2DBStatus', "")
Methods
def restore_entire_database(self, dest_client_name=None, dest_instance_name=None, dest_database_name=None, **kwargs)-
Restores the db2 databases specified in the input paths list to the same location.
Args
dest_client_name (str) – destination client name where db need to be restored
dest_instance_name (str) – destination db2 instance name of destination client
dest_database_name (str) – destination database name
recover_db (bool) – recover database flag
default: Truerestore_incremental (bool) – Restore incremental flag
default: Truerestore_data (bool) – Restore data or not default: True
copy_precedence (int) – Copy precedence to perform restore from default : None
roll_forward (bool) – Rollforward database or not default: True
restore_logs (bool) - Restore the logs or not default: True
Returns
object - instance of the Job class for this restore job
Raises
SDKException:
if failed to initialize job if response is empty if response is not successExpand source code Browse git
def restore_entire_database( self, dest_client_name=None, dest_instance_name=None, dest_database_name=None, **kwargs ): """Restores the db2 databases specified in the input paths list to the same location. Args: dest_client_name (str) -- destination client name where db need to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_database_name (str) -- destination database name recover_db (bool) -- recover database flag default: True restore_incremental (bool) -- Restore incremental flag default: True restore_data (bool) -- Restore data or not default: True copy_precedence (int) -- Copy precedence to perform restore from default : None roll_forward (bool) -- Rollforward database or not default: True restore_logs (bool) - Restore the logs or not default: True Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ self._instance_object._restore_association = self._backupset_association instance_object = self._instance_object if dest_client_name is None: dest_client_name = instance_object._agent_object._client_object.client_name if dest_instance_name is None: dest_instance_name = instance_object.instance_name if dest_database_name is None: dest_database_name = self.backupset_name.upper() return self._instance_object.restore_entire_database( dest_client_name, dest_instance_name, dest_database_name, **kwargs) def restore_out_of_place(self, dest_client_name, dest_instance_name, dest_backupset_name, target_path, **kwargs)-
Restores the DB2 data/log files specified in the input paths list to the same location.
Args: dest_client_name (str) -- destination client name where files are to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_backupset_name (str) -- destination db2 backupset name of destination client target_path (str) -- Target DB Restore Destination copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None redirect_enabled (bool) -- boolean to specify if redirect restore is enabled default: False redirect_storage_group_path (dict) -- Path specified for each storage group in advanced restore options in order to perform redirect restore format: {'Storage Group Name': 'Redirect Path'} default: None redirect_tablespace_path (dict) -- Path specified for each tablespace in advanced restore options in order to perform redirect restore format: {'Tablespace name': 'Redirect Path'} default: None destination_path (str) -- destinath path for restore default: None restore_data (bool) -- Restore data or not default: True Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not successExpand source code Browse git
def restore_out_of_place( self, dest_client_name, dest_instance_name, dest_backupset_name, target_path, **kwargs ): """Restores the DB2 data/log files specified in the input paths list to the same location. Args: dest_client_name (str) -- destination client name where files are to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_backupset_name (str) -- destination db2 backupset name of destination client target_path (str) -- Target DB Restore Destination copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None redirect_enabled (bool) -- boolean to specify if redirect restore is enabled default: False redirect_storage_group_path (dict) -- Path specified for each storage group in advanced restore options in order to perform redirect restore format: {'Storage Group Name': 'Redirect Path'} default: None redirect_tablespace_path (dict) -- Path specified for each tablespace in advanced restore options in order to perform redirect restore format: {'Tablespace name': 'Redirect Path'} default: None destination_path (str) -- destinath path for restore default: None restore_data (bool) -- Restore data or not default: True Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ self._instance_object._restore_association = self._backupset_association return self._instance_object.restore_out_of_place(dest_client_name=dest_client_name, dest_instance_name=dest_instance_name, dest_backupset_name=dest_backupset_name, target_path=target_path, **kwargs) def restore_table_level(self, aux_client_name, aux_instance_name, aux_backupset_name, dest_client_name, dest_instance_name, dest_backupset_name, target_path, staging_path, tables_path, user_name, password, **kwargs)-
Performs DB2 table level restore Args: aux_client_name (str) – auxiliary client name where files are to be restored aux_instance_name (str) – auxiliary instance name where files are to be restored aux_backupset_name (str) – auxiliary backupset name where files are to be restored dest_client_name (str) – destination client name where files are to be restored dest_instance_name (str) – destination db2 instance name of destination client dest_backupset_name (str) – destination db2 backupset name of destination client
target_path (str) -- Destination DB restore path src_backupset_name (str) -- Source Backupset Name staging_path (str) -- Staging Path user_name (str) -- Destination User name password (str) -- Destination Password tables_path (list) -- List of tables path Example: Unix: ['/+tblview+/instance_name/database_name/schema_name/table_name/**'] Windows: ["\+tblview+\instance_name\database_name\schema_name able_name\**"] copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None rollForward (bool) -- Rollforward or not default: True destination_path (str) -- destinath path for restore default: None server_port (int) -- Server Port Destination instance default: 50000 generateAuthorizationDDL (bool) -- Generate Authorization DDL default: False extractDDLStatements (bool) -- Extracts DDL statement or not default: True clearAuxiliary (bool) -- Cleanup auxilliary or not default: True dropTable (bool) -- Drop table for import default: False Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not successExpand source code Browse git
def restore_table_level( self, aux_client_name, aux_instance_name, aux_backupset_name, dest_client_name, dest_instance_name, dest_backupset_name, target_path, staging_path, tables_path, user_name, password, **kwargs ): """ Performs DB2 table level restore Args: aux_client_name (str) -- auxiliary client name where files are to be restored aux_instance_name (str) -- auxiliary instance name where files are to be restored aux_backupset_name (str) -- auxiliary backupset name where files are to be restored dest_client_name (str) -- destination client name where files are to be restored dest_instance_name (str) -- destination db2 instance name of destination client dest_backupset_name (str) -- destination db2 backupset name of destination client target_path (str) -- Destination DB restore path src_backupset_name (str) -- Source Backupset Name staging_path (str) -- Staging Path user_name (str) -- Destination User name password (str) -- Destination Password tables_path (list) -- List of tables path Example: Unix: ['/+tblview+/instance_name/database_name/schema_name/table_name/**'] Windows: ["\+tblview+\instance_name\database_name\schema_name\table_name\**"] copy_precedence (int) -- copy precedence value of storage policy copy default: None from_time (str) -- time to retore the contents after format: YYYY-MM-DD HH:MM:SS default: None to_time (str) -- time to retore the contents before format: YYYY-MM-DD HH:MM:SS default: None rollForward (bool) -- Rollforward or not default: True destination_path (str) -- destinath path for restore default: None server_port (int) -- Server Port Destination instance default: 50000 generateAuthorizationDDL (bool) -- Generate Authorization DDL default: False extractDDLStatements (bool) -- Extracts DDL statement or not default: True clearAuxiliary (bool) -- Cleanup auxilliary or not default: True dropTable (bool) -- Drop table for import default: False Returns: object - instance of the Job class for this restore job Raises: SDKException: if failed to initialize job if response is empty if response is not success """ self._instance_object._restore_association = self._backupset_association return self._instance_object.restore_table_level(aux_client_name=aux_client_name, aux_instance_name=aux_instance_name, aux_backupset_name=aux_backupset_name, dest_client_name=dest_client_name, dest_instance_name=dest_instance_name, dest_backupset_name=dest_backupset_name, target_path=target_path, staging_path=staging_path, tables_path=tables_path, user_name=user_name, password=password, **kwargs)
Inherited members