SQWareProduction:mongodb:bin:sqwmng CompactDatabase.ksh

De WikiFr_dbSQWare
Aller à : navigation, rechercher

Presentation

Script $gvsqw_MngBin/sqwmng_CompactDatabase.ksh :




Aide en ligne

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

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

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

DESCRIPTION
   sqwmng_CompactDatabase.ksh compacte les tables de la databases
SUPPORT
   MongoDB versions supportees: 2.4 <= v <= 5.1

PARAMETERS
     -I  instance       : Instance cible pour compact tables.
     -D   databasename  : Database.
OPTIONS
     -h    help         : Affichage de l'aide complete.
     -s                 : Affichage des exemples d'utilisation.
     -FC   type         : Force true/false (par defaut true).
     -PF   num          : Padding factor.
     -FRT  return_code  : Valeur forcee du code retour sur erreur
     -AddMail email     : Adresse Email a ajouter a 'pmexpdba@gmail.com'.
     -SendReport        : Envoi du rapport d'execution.
     -Dist              : Pour connexion distante a la database (change $gvsqw_ConnectString par $gvsqw_DistConnectString ).
     -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).
     -Exec              : Execute les commandes generees (par defaut, affiche les commandes generees)

Information.png
Information:
Pour etre sur d'avoir une aide a jour, reportez vous directement a l'aide en ligne du script avec l'option -h .


Traitement de l'erreur

Erreurs de parse des arguments

Ce type de message est genere:

Lack 'MNG_SID' parameter, Utilisation: sqwmng_CompactDatabase.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).

Information.png
Information:
L'envoi de mail peut être désactivé par l'option -NoMail pour une exécution.


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).

Information.png
Information:
L'envoi de mail peut être désactivé par l'option -NoMail pour une exécution.


Exemples d'utilisation

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

#Standard (Locale) help for script sqwmng_CompactDatabase.ksh:
# desc compacte les tables de la databases

# XXXXX : -FC
# XXXXX : -PF
# XXXXX : -Dist

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

$gvsqw_MngBin/sqwmng_CompactDatabase.ksh -Locale fr -h
#Affichage de l'aide en ligne pour ce script avec forçage de la locale 'fr' (Locale par défaut gérée par la variable gvsqw_Locale)

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

$gvsqw_MngBin/sqwmng_CompactDatabase.ksh -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com'
#Ajoute la liste de mail à l'adresse par défaut gérée par la variable gvsqw_GlobalMail

$gvsqw_MngBin/sqwmng_CompactDatabase.ksh -I $MNG_SID -D <DbName> -NoMail
#Desactive l'envoi de mail sur erreur a $gvsqw_GlobalMail (par defaut, send on error)

$gvsqw_MngBin/sqwmng_CompactDatabase.ksh -SendReport
#Envoie la log par mail à la fin du traitement même s'il n'y a pas d'erreur

$gvsqw_MngBin/sqwmng_CompactDatabase.ksh -I $MNG_SID -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_CompactDatabase=<NumericValue>
#dans le fichier de configuration $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg
Information.png
Information:
Pour être sûr que les exemples sont exacts, reportez-vous directement à l'option d'aide en ligne du script -s .