SQWareProduction:mssql:bin:sqwmsq BackupAllDatabases.ksh

From Wiki_dbSQWare
Jump to: navigation, search

Presentation

Script $gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh :


Run of sqwmsq_BackupDatabase.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_BackupAllDatabases.ksh -h
Content of this assistance : 

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

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

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

PARAMETERS
     -I   Instance      : Target instance (freeTds alias) to backup.
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 put backup (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%').
     -HI  Nb_Generations: Nb of generations to keep (by default 2).
     -WCD whereclause   : Where clause to generate databases list.
     -AllFull           : Select all databases with RECOVERY=FULL.
     -SMS SizeMax       : Size Max of backup stripe (by default 40000 Mo).
     -SBS SizeStat      : Display progression of backups (by default: Statisticss=10).
     -PAR parfile       : Parfile file for databases list.
     -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 of failed backups (overwrite all other options).
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -ForceComp         : Force the compression of backup file (only for 2008 R2 standard edition).
     -PurgeDiff         : Delete all diff and log backups.
     -SendReport        : Send execution log report.
     -Type type         : Type of backup full,diff,log,CopyOnly (by default full).
     -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).
Nuvola apps information.png
Note:
To be sure the aid is accurate, refer directly to the online help script -h option.


Error management

Errors passing arguments

This type of message is generated: 

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

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

Not sending 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).

Nuvola apps information.png
Note:
Sending mail can be disabled by the option -NoMail for one execution.


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).

Nuvola apps information.png
Note:
Sending mail can be disabled by the option -NoMail for one execution.


Usage examples

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

#Standard help for script sqwmsq_BackupAllDatabases.ksh:


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

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.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_BackupAllDatabases.ksh -s
#Display usage examples for this script

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

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -Exec
#Execute backup with the script sqwmsq_BackupDatabase.ksh on all databases 

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

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

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -BP <path> -Exec
#Make the backups on the directory <path> (by default: 'HKEY_LOCAL_MACHINE', 'BackupDirectory')

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -SBS <SizeStat> -Exec
#Displays the progression of backups to prevent timeouts. 

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -PAR <parfile> -Exec
#Execute the backups by adding the parameters contained in the file <parfile>

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -SMS <SizeMax> -Exec
#Split backup's file on several file of weight informed by $gvsqw_SizeMaxStripe variable (by default 40000 Mo) 

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

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -Type <TypedeBackup> -PurgeDiff -Exec
#Change backup type (full,diff,log,CopyOnly) and delete all diff and log backups

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -Type log -AllFull -Exec
#Backup log of all databases with RECOVERY=FULL

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -HI <NumberOfGenerations> -Exec
#Changes the number of backup generations to keep

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.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_BackupAllDatabases.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_BackupAllDatabases.ksh -I $Alias -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.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_BackupAllDatabases=<NumericValue>
#in configuration file $gvsqw_MsqBin/../etc_cust/sqwmsq_GlobalVar.cfg

#############################
#Run off sqwmsq_BackupDatabase.ksh in parallel mode for all databases
#Options to generate databases list with filters (you can mix all off them):
$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -ID <listdb> -Exec
#Generate database list with 'in list':
#=> and name in ('$ListInclude')
$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -ED <listdb> -Exec
#Generate database list with 'not in list':
#=> and name not in ('$ListExclude')
$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -IL <likeclause> -Exec
#Generate database list with 'like':
#=> and name like 'LikeClause'
$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -EL <likeclause> -Exec
#Generate database list with 'not like':
#=> and name not like 'NotLikeClause'
$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -WCD <whereclause> -Exec
#Generate database list with 'where clause':
#=> and 'WhereClause'

$gvsqw_MsqBin/sqwmsq_BackupAllDatabases.ksh -I $Alias -P <NumericValue> -Exec
#Run sqwmsq_BackupDatabase.ksh script with a parallel degree of '<NumericValue>'
#Use by default the variable gvsqw_NbThreadXXX in $gvsqw_MsqBin/../etc/sqwmsq_GlobalVar.cfg
#You can change this default on all your environnement if you set this variable
#in configuration file $gvsqw_MsqBin/../etc_cust/sqwmsq_GlobalVar.cfg
Nuvola apps information.png
Note:
To be sure the examples are accurate, refer directly to the online help script -s option.


Retrieved from "https://wiki.dbsqware.com/index.php?title=SQWareProduction:mssql:bin:sqwmsq_BackupAllDatabases.ksh&oldid=18201"