SQWareProduction:mssql:bin:sqwmsq BackupDatabase.ksh
Contents
Presentation
Script $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh :
Generate backup database
You can choose type of backup (by default full):
- full
- log
- diff
Script automatically determine how many stripes
Makes purges of backup generations
You can change default values:
- change Path to put backup (by default: 'HKEY_LOCAL_MACHINE', 'BackupDirectory')
- force number of stripes
- size max of a stripe
- number of backup generations to keep online
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -h
Content of this assistance :
Sourcing sqwmsq_Global.lib v2024.02 SQWareProduction for MsSql (dbSQWare) ...
Usage: sqwmsq_BackupDatabase.ksh [-h] -I <FreeTdsAlias> -D <DatabaseName> [+ options]
DESCRIPTION
sqwmsq_BackupDatabase.ksh backup the database
SUPPORT
MsSql supported versions: 2000 <= v <= 2022
PARAMETERS
-I Instance : Target instance (freeTds alias) for backup.
-D databasename : Target database.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-BP path : Path to put backup (by default : 'HKEY_LOCAL_MACHINE', 'BackupDirectory').
-NS Nb_stripe : Force number of stripes.
-HI Nb_Generations: Number of generations to keep (by default 2).
-FRT return_code : Force return code value on error.
-SMS SizeMax : Size Max Stripe (by default 40000 Mo).
-SBS SizeStat : Size of backup stats (by default : Statisticss=10).
-REP : Insert into repeat file on error.
-AddMail email : Email address to add at 'pmexpdba@gmail.com'.
-PurgeDiff : Delete all diff and log backups.
-NoComp : Disable the compression if enable by default.
-ForceComp : Force the compression of backup file (only for 2008 R2 standard edition).
-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).
Error management
Errors passing arguments
This type of message is generated:
Lack 'FreeTdsAlias' parameter, Usage: sqwmsq_BackupDatabase.ksh [-h] -I <FreeTdsAlias> -D <DatabaseName> [+ options] For full help : sqwmsq_BackupDatabase.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).
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.02 SQWareProduction for MsSql (dbSQWare) ... #Standard help for script sqwmsq_BackupDatabase.ksh: $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -h #Display online help for this script $gvsqw_MsqBin/sqwmsq_BackupDatabase.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_BackupDatabase.ksh -s #Display usage examples for this script $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> #Generate commands but don't execute them ! $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -Exec #Execute backup command to save the database <DbName> $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -SBS <SizeStat> -Exec #Displays the status of backups to prevent timeouts. $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -PAR <parfile> -Exec #Execute the backups by adding the parameters contained in the file <parfile> $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -SMS <SizeMax> -Exec #Split backup's file on several file of weight informed by $gvsqw_SizeMaxStripe variable (by default 40000 Mo) $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -REP -Exec #Retries failed backups (takes priority of the other options) $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -Type <TypedeBackup> -PurgeDiff -Exec #Change backup type (full,diff,log,CopyOnly) and delete all diff and log backups $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -HI <NumberOfGenerations> -Exec #Changes the number of backup generations to keep $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -NS <NumberOfStripes> -Exec #Generate Dump on <NumberOfStripes> stripes $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -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_BackupDatabase.ksh -I $Alias -D <DbName> -SendReport -Exec #Send the log by email at the end of the treatment even if there is no error $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -NoMail -Exec #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_MsqBin/sqwmsq_BackupDatabase.ksh -I $Alias -D <DbName> -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_BackupDatabase=<NumericValue> #in configuration file $gvsqw_MsqBin/../etc_cust/sqwmsq_GlobalVar.cfg
