SQWareProduction:mssql:bin:sqwmsq RestoreAllDatabases.ksh

Presentation

Script $gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh :

Run of sqwmsq_RestoreDatabase.ksh in parallel mode
You can choose:

• The parallel degree
• Aggressiveness of run (number of seconds between two runs)
• Aggressiveness of check end (number of seconds between two checks of end)

Filters to generate database list (you can mix all off them):

• Include list of database
• Exclude list of database
• Include like clause
• Exclude like clause
• Where clause

Online help

The online help is available for most scripts with the -h option.
Ex: $gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -h
Content of this assistance :

Sourcing sqwmsq_Global.lib v2024.07 SQWareProduction for MsSql (dbSQWare) ... 

Usage: sqwmsq_RestoreAllDatabases.ksh [-h] -I <FreeTdsAlias> [+ options]

DESCRIPTION
   sqwmsq_RestoreAllDatabases.ksh restore all databases in parallel
SUPPORT
   MsSql supported versions: 2000 <= v <= 2022

PARAMETERS
     -I   Instance      : Target instance (freeTds alias) to restore.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -P   Nb_threads    : Number of threads in parallel (by default 4).
     -BP  path          : Path to find backup to Load (by default: 'HKEY_LOCAL_MACHINE', 'BackupDirectory').
     -ID  listdb        : List of databases to include.
     -ED  listdb        : List of databases to exclude.
     -IL  likeclause    : Like clause to generate databases list (example: 'db%').
     -EL  likeclause    : Like clause to exclude databases (example: 'nodb%').
     -WCD whereclause   : Where clause to generate databases list.
     -PAR parfile       : Parfile to use.
     -AGR Nb_sec        : Nb of seconds between two runs (by default 5s).
     -AGE Nb_sec        : Nb of seconds between two checks of end (by default 20s).
     -FRT return_code   : Force return code value on error.
     -REP               : Repeat failed restore (overwrite all other options).
     -Move              : Generate move instruction.
     -Type    type      : Type of restore full,diff (by default full).
     -Rename  listolddb : Origin name of databases list to restore (must be used with -ID).
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -Exec              : Execute commands (by default, display generated commands).

Error management

Errors passing arguments

This type of message is generated:

Lack 'FreeTdsAlias' parameter, Usage: sqwmsq_RestoreAllDatabases.ksh [-h]  -S|-I <FreeTdsAlias> [+ options]
For full help : sqwmsq_RestoreAllDatabases.ksh -h

If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:

No send mail because you are in connected mode !!!
Lack 'FreeTdsAlias' parameter

If you are not connected to a terminal, the error message appears and is sent by mail to the address contained in the variable $gvsqw_GlobalMail (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_mssql : " (See help customize this variable).

Execution errors

Whether you are or not connected to a terminal, the error message appears and an email containing a summary of treatment errors is sent to the address contained in the variable $gvsqw_Mail_mssql (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_mssql : " (See help customize this variable).

Usage examples

Sourcing sqwmsq_Global.lib v2024.07 SQWareProduction for MsSql (dbSQWare) ... 

#Standard help for script sqwmsq_RestoreAllDatabases.ksh:


$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -h
#Display online help for this script

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -Locale en -h
#Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale)

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -s
#Display usage examples for this script

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias
#Generate commands but don't execute them !

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -Exec
#Execute the script sqwmsq_RestoreDatabase.ksh to restore backups of all databases 

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -BP <path> -Exec
#Path <path> of backup to restore (by default: 'HKEY_LOCAL_MACHINE', 'BackupDirectory')

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -PAR <parfile> -Exec
#Rebuild indexes by adding the parameters contained in the file <parfile> 

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -REP -Exec
#Retries failed backups (takes priority of the other options)

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -Move -Exec
#Restore the databases by moving the file locations

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -Rename <listolddb> -Exec
#Rename databases to restore (must be used with -ID)

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -Type <TypeRestore> -Exec
#Change backup type (full,diff)

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -AGR 20 -Exec
#Set the waiting time in seconds between two command run, 20s here

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -AGE 30 -Exec
#Set the waiting time in seconds between two end checks, 30s here

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -ID 'DbName1,DbName2' -Exec
#Execute generated commands for only the 2 specified databases

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -ED 'DbName3,DbName4' -Exec
#Execute generated commands except for the 2 specified databases

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -IL '%_PROD' -Exec
#Clause like to generate dynamic database list to include (example: 'dbprod%')

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -EL '%_TESTS' -Exec
#Clause like to generate dynamic database list to exclude (example: 'dbtest%')

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -WCD '<condition>' -Exec
#Clause where to generate dynamic database list to include (example: 'OPEN_MODE=MOUNTED')

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -P <NumericValue> -Exec
#Run sqwmsq_RestoreDatabase.ksh script with a parallel degree of '<NumericValue>'
#Use by default the variable gvsqw_NbThreadXXX in $gvsqw_MsqBin/../etc/sqwpg_GlobalVar.cfg
#You can change this default on all your environnement if you set this variable
#in configuration file $gvsqw_MsqBin/../etc_cust/sqwpg_GlobalVar.cfg

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_MsqBin/sqwmsq_RestoreAllDatabases.ksh -I $Alias -FRT <NumericValue> -Exec
#Force return code to '<NumericValue>' on error (if no error, "exit 0!")
#You can also force return code of this script on all your
#environnement if you set the variable: $gvsqw_ForcedReturnCodeScript_sqwmsq_RestoreAllDatabases=<NumericValue>
#in configuration file $gvsqw_MsqBin/../etc_cust/sqwmsq_GlobalVar.cfg