Template:SQWareProduction sqwmng DumpDatabase.ksh example

Sourcing sqwmng_Global.lib v2024.07 SQWareProduction for MongoDB (dbSQWare) ... 

#Standard help for script sqwmng_DumpDatabase.ksh:

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -h
#Display online help for this script

$gvsqw_MngBin/sqwmng_DumpDatabase.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_DumpDatabase.ksh -s
#Display usage examples for this script

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName>
#Generate commands but don't execute them !

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -Exec
#Execute a mongodump on th target database

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -Dist -Exec
#Execute a mongodump of database <DbName> for the non-local instance $MNG_SID with distant connection
#You need to register credentials to use for distant connection to the instance (user and so on) in file $gvsqw_DistPasswdFile

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -OPT <Option> -Exec
#Add the option(s) <Option> to the command mongodump

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -Tar -Exec
#Tar generated dump dir after mongodump (by default : $gvsqw_AfterDump)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -NoTar -Exec
#Don't tar generated dump dir after mongodump (by default : $gvsqw_AfterDump)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -HI <NumberOfGenerations> -Exec
#Changes the number of backup generations to keep

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -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_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -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_sqwmng_DumpDatabase=<NumericValue>
#in configuration file $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg