SQWareProduction:mongodb:bin:sqwmng CopyDumpDatabase.ksh
Contents
Presentation
Script $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh :
copy of dump file $lvsqw_CopyType
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -h
Content of this assistance :
Sourcing sqwmng_Global.lib v2024.07 SQWareProduction for MongoDB (dbSQWare) ...
Usage: sqwmng_CopyDumpDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> [[+ options]]
DESCRIPTION
sqwmng_CopyDumpDatabase.ksh copy of dump $lvsqw_CopyType
SUPPORT
MongoDB supported versions: 2.4 <= v <= 5.1
PARAMETERS
-I instance : Target instance to copy.
-DT DatabaseTarget : Target database.
[
-GetInf u@h:path : user@host:path pour recuperer le dump source distant.
OR
-PutInf u@h:path : user@host:path pour pousser le dump sur le host distant.
OR
-IS instance : Source instance.
-US hostname : Source hostname.
]
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-NoMail : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
-Locale locale : Force Locale for help display (fr,en).
-P Nb processes : Max number of processes (by default ).
-HI Nb : Nb of generations to keep (by default 1).
-DD date_dump : Dump date to copy (by default take the latest).
-RD directory : Directory holding dump file (by default $HOME/mng_dump/${MNG_SID}).
-RDS directory : Directory holding source dump file (by default $HOME/mng_dump/$lvsqw_InstanceSource).
-UUS username : Source unix user(by default, same as target).
-AddMail email : Email address to add at 'pmexpdba@gmail.com'.
-SendReport : Send execution log report.
-FRT code : Force return code value on error.
-Exec : Copy files $lvsqw_CopyType (by default, display generated commands).
Error management
Errors passing arguments
This type of message is generated:
Lack 'MNG_SID' parameter, Usage: sqwmng_CopyDumpDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> [[+ options]] For full help : sqwmng_CopyDumpDatabase.ksh -h
If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:
Begining : 2020-11-29 20:09:48 End : 2020-11-29 20:09:48 Duration : 00:00:00
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.07 SQWareProduction for MongoDB (dbSQWare) ... #Standard help for script sqwmng_CopyDumpDatabase.ksh: $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -h #Display online help for this script $gvsqw_MngBin/sqwmng_CopyDumpDatabase.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_CopyDumpDatabase.ksh -s #Display usage examples for this script $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> #Generate commands but don't execute them ! $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -Exec #Copy of dump file \$lvsqw_CopyType $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -DD <date> -RD <DirTarget> -Exec #Copy dump file at date <date> (by default, the latest) to directory <DirName> (by default $gvsqw_RootDump) $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -RDS <DirSource> -Exec #Copy the dump files of all databases contained in the directory <DirSource> (by default $gvsqw_RootDumpSource) $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -UUS 'username' -Exec #Unix user 'username' to use (by default, same as target) $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -HI <NumberOfGenerations> -Exec #Changes the number of backup generations to keep $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -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_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -SendReport -Exec #Send the log by email at the end of the treatment even if there is no error $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -NoMail -Exec #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_MngBin/sqwmng_CopyDumpDatabase.ksh -I $MNG_SID -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> -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_CopyDumpDatabase=<NumericValue> #in configuration file $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg
