SQWareProduction:mongodb:bin:sqwmng DumpDatabase.ksh

Presentation

Script $gvsqw_MngBin/sqwmng_DumpDatabase.ksh :

mongodump of database

Online help

The online help is available for most scripts with the -h option.
Ex: $gvsqw_MngBin/sqwmng_DumpDatabase.ksh -h
Content of this assistance :

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

Usage: sqwmng_DumpDatabase.ksh [-h] -I instance -D databasename [+ options]

DESCRIPTION
   sqwmng_DumpDatabase.ksh mongodump of database
SUPPORT
   MongoDB supported versions: 2.4 <= v <= 5.1

PARAMETERS
     -I  instance       : Target instance to mongodump.
     -D  databasename   : Database for mongodump.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -HI   nb_gen       : Number of generations to keep (by default: 2).
     -Opt  option       : Additional options for mongodump.
     -FRT       code    : Force return code value on error.
     -Dist              : For distant connection to database (change $gvsqw_ConnectString to $gvsqw_DistConnectString ).
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -Tar               : Tar generated dump dir after mongodump (by default : Tar).
     -NoTar             : Don't tar generated dump dir after mongodump (by default : Tar).
     -Exec              : Execute commands (by default, display generated commands).

Error management

Errors passing arguments

This type of message is generated:

Lack 'MNG_SID' parameter, Usage: sqwmng_DumpDatabase.ksh [-h]  -I instance -D databasename [+ options]
For full help : sqwmng_DumpDatabase.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.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