SQWareProduction:mongodb:bin:sqwmng DumpDatabase.ksh

Presentation

Script $gvsqw_MngBin/sqwmng_DumpDatabase.ksh :

mongodump de la database

Aide en ligne

L'aide en ligne est accessible dans la plupart des scripts avec l'option -h.
Ex: $gvsqw_MngBin/sqwmng_DumpDatabase.ksh -h
Contenu de l'aide :

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

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

DESCRIPTION
   sqwmng_DumpDatabase.ksh mongodump de la base de donnees
SUPPORT
   MongoDB versions supportees: 2.4 <= v <= 5.1

PARAMETERS
     -I  instance       : Instance cible pour mongodump.
     -D  databasename   : Base de donnees.
OPTIONS
     -h                 : Affichage de l'aide complete.
     -s                 : Affichage des exemples d'utilisation.
     -HI   nb_gen       : Nombre de generations a garder (par defaut: 2).
     -Opt  option       : Options additionnelles pour mongodump.
     -FRT       code    : Valeur forcee du code retour sur erreur.
     -Dist              : Pour connexion distante a la base de donnees (change $gvsqw_ConnectString par $gvsqw_DistConnectString ).
     -AddMail   email   : Adresse Email a ajouter a 'pmexpdba@gmail.com'.
     -SendReport        : Envoi du rapport d'execution.
     -NoMail            : Desactive l'envoi de mail sur erreur a pmexpdba@gmail.com (par defaut, envoi sur erreur).
     -Locale    locale  : Force la Locale d'affichage de l'aide (fr,en).
     -Tar               : Execute un tar du rep genere apres le mongodump (par defaut : Tar).
     -NoTar             : N'execute un tar du rep genere apres le mongodump (par defaut : Tar).
     -Exec              : Execute les commandes generees (par defaut, affiche les commandes generees).

Traitement de l'erreur

Erreurs de parse des arguments

Ce type de message est genere:

Lack 'MNG_SID' parameter, Utilisation: sqwmng_DumpDatabase.ksh [-h]  -I instance -D databasename [+ options]

Si vous vous connectez via un terminal, aucun mail ne sera envoyé et vous aurez plutôt ce type de message:

Not sending mail because you are in connected mode !!!
Lack 'MNG_SID' parameter

Si vous n'êtes pas connecté à un terminal, le message d'erreur apparaît et est envoyé par mail à l'adresse contenue dans la variable $gvsqw_GlobalMail (Voir l'aide pour personnaliser cette variable). L'objet commence toujours par "$gvsqw_MailMsg_mongodb : " (Voir l'aide pour personnaliser cette variable).

Execution errors

Que vous soyez ou non connecté à un terminal, le message d'erreur apparaît et un mail contenant un résumé des erreurs de traitement est envoyé à l'adresse contenue dans la variable $gvsqw_GlobalMail (Voir l'aide pour personnaliser cette variable). L'objet commence toujours par "$gvsqw_MailMsg_mongodb : " (Voir l'aide pour personnaliser cette variable).

Exemples d'utilisation

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

#Standard (Locale) help for script sqwmng_DumpDatabase.ksh:

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -h
#Affichage de l'aide en ligne pour ce script

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -Locale fr -h
#Affichage de l'aide en ligne pour ce script avec forcage de la locale 'fr' (Locale par defaut geree par $gvsqw_Locale)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -s
#Affichage des exemples d'utilisation pour ce script

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName>
#Genere les commandes mais ne les execute pas !

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -Exec
#Execute un mongodump de la database cible

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -Dist -Exec
Execute un mongodump de la base <DbName> avec une connexion distante pour l'instance non locale $MNG_SID
#Vous devez saisir toutes les informations d'authentification a utiliser pour la connexion distante a l'instance dans le fichier $gvsqw_DistPasswdFile

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -OPT <Option> -Exec
#Ajoute l(es) option(s) <Option> a la commande mongodump

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -Tar -Exec
#Execute un tar du rep genere apres le mongodump (par defaut : $gvsqw_AfterDump)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -NoTar -Exec
#N'execute un tar du rep genere apres le mongodump (par defaut : $gvsqw_AfterDump)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -HI <NumberOfGenerations> -Exec
#Change le nombre de generations de backup a garder

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Ajoute la liste de mail a l'adresse par defaut geree par $gvsqw_GlobalMail

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -SendReport -Exec
#Envoie la log par mail a la fin du traitement meme s'il n'y a pas d'erreur (par defaut, seulement en cas d'erreur)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -NoMail -Exec
#Desactive l'envoi de mail sur erreur a $gvsqw_GlobalMail (par defaut, seulement en cas d'erreur)

$gvsqw_MngBin/sqwmng_DumpDatabase.ksh -I $MNG_SID -D <DbName> -FRT <NumericValue> -Exec
#Force le code retour a '<NumericValue>' sur erreur (si pas d'erreur, "exit 0"!)
#Vous pouvez aussi forcer le code retour de ce script pour tous
#si vous settez la variable d'environnement: $gvsqw_ForcedReturnCodeScript_sqwmng_DumpDatabase=<NumericValue>
#dans le fichier de configuration $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg