SQWareProduction:mongodb:bin:sqwmng RestoreDatabase.ksh
Contents
Presentation
Script $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh :
restore database
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -h
Content of this assistance :
Sourcing sqwmng_Global.lib v2024.02 SQWareProduction for MongoDB (dbSQWare) ...
Usage: sqwmng_RestoreDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> [[+ options]]
DESCRIPTION
sqwmng_RestoreDatabase.ksh restore database
SUPPORT
MongoDB supported versions: 2.4 <= v <= 5.1
PARAMETERS
-I instance : Target instance to restore.
-DT DatabaseTarget : Target database.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-F file : Dump file to restore (by default take the latest).
-DS DatabaseSource : Source database (by default same than -DT).
-DD date_dump : Dump date to restore (by default take the latest).
-RD directory : Directory holding dump file (by default $HOME/mng_dump/${MNG_SID}).
-Opt option : Additional options for restore.
-NoMail : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
-Locale locale : Force Locale for help display (fr,en).
-AddMail email : Email address to add at 'pmexpdba@gmail.com'.
-SendReport : Send execution log report.
-FRT code : Force return code value on error.
-Exec : Restore (by default, display generated commands).
Error management
Errors passing arguments
This type of message is generated:
Lack 'MNG_SID' parameter, Usage: sqwmng_RestoreDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> [[+ options]] For full help : sqwmng_RestoreDatabase.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 'MNG_SID' 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_mongodb : " (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_mongodb (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_mongodb : " (See help customize this variable).
Usage examples
Sourcing sqwmng_Global.lib v2024.02 SQWareProduction for MongoDB (dbSQWare) ... #Standard help for script sqwmng_RestoreDatabase.ksh: # XXXXX : -DS # XXXXX : -RD # XXXXX : -DD # XXXXX : -Opt gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -h #Display online help for this script $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -Locale en -h #Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale) $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -s #Display usage examples for this script $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -I $MNG_SID -DT <DbName> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec #Add the mail list to the default address managed by the variable gvsqw_GlobalMail $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -I $MNG_SID -DT <DbName> -SendReport -Exec #Send the log by email at the end of the treatment even if there is no error $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -I $MNG_SID -DT <DbName> -NoMail -Exec #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_MngBin/sqwmng_RestoreDatabase.ksh -I $MNG_SID -DT <DbName> -F <FileName> -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_sqwmng_RestoreDatabase=<NumericValue> #in configuration file $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg
