SQWareProduction:mongodb:bin:sqwmng CompactAllDatabases.ksh
Contents
Presentation
Script $gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh :
compact tables of databases in parallel
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -h
Content of this assistance :
Sourcing sqwmng_Global.lib v2024.02 SQWareProduction for MongoDB (dbSQWare) ...
Usage: sqwmng_CompactAllDatabases.ksh [-h] -I instance [+ options]
DESCRIPTION
sqwmng_CompactAllDatabases.ksh compact tables of databases in parallel
SUPPORT
MongoDB supported versions: 2.4 <= v <= 5.1
PARAMETERS
-I instance : Target instance to Compact.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-P Nb threads : Number of threads in parallel (by default 2).
-FC type : Force true/false (by default true).
-PF num : Adjust the Padding factor.
-ID listdb : List of databases to run compact tables (by default all).
-ED listdb : List of databases to exclude.
-IL likeclause : Like clause to generate databases list (example: 'db', egrep syntax!).
-EL likeclause : Like clause to exclude databases (example: 'nodb', egrep syntax!).
-WCD whereclause : Where clause to generate databases list (egrep syntax!).
-AGR Nb_sec : Nb of seconds between two runs (by default 1s).
-AGE Nb_sec : Nb of seconds between two checks of end (by default 10s).
-FRT code : Force return code value on error.
-AddMail email : Email address to add at 'pmexpdba@gmail.com'.
-SendReport : Send execution log report.
-Dist : For distant connection to database (change $gvsqw_ConnectString to $gvsqw_DistConnectString ).
-NoMail : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
-Locale locale : Force Locale for help display (fr,en).
-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_CompactAllDatabases.ksh [-h] -I instance [+ options] For full help : sqwmng_CompactAllDatabases.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.02 SQWareProduction for MongoDB (dbSQWare) ...
#Standard help for script sqwmng_CompactAllDatabases.ksh:
# XXXXX : -FC
# XXXXX : -PF
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -h
#Display online help for this script
$gvsqw_MngBin/sqwmng_CompactAllDatabases.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_CompactAllDatabases.ksh -s
#Display usage examples for this script
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -AGR 20 -Exec
#Set the waiting time in seconds between two command run, 20s here
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -AGE 30 -Exec
#Set the waiting time in seconds between two end checks, 30s here
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -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_CompactAllDatabases.ksh -I $MNG_SID -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -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_CompactAllDatabases=<NumericValue>
#in configuration file $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg
#############################
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -ID <listdb>
#Generate database list with 'in list':
#=> and name in ('$ListInclude')
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -ED <listdb> -Dist
#Generate database list with 'not in list':
#=> and name not in ('$ListExclude')
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -IL <likeclause>
#Generate database list with 'like':
#=> and name like 'LikeClause'
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -EL <likeclause>
#Generate database list with 'not like':
#=> and name not like 'NotLikeClause'
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -WCD <whereclause>
#Generate database list with 'where clause':
#=> and 'WhereClause'
$gvsqw_MngBin/sqwmng_CompactAllDatabases.ksh -I $MNG_SID -P <NumericValue> -Exec
#Run sqwmng_CompactAllDatabases.ksh script with a parallel degree of '<NumericValue>'
#Use by default the variable gvsqw_NbThreadXXX in $gvsqw_MgBin/../etc/sqwmng_GlobalVar.cfg
#You can change this default on all your environnement if you set this variable
#in configuration file $gvsqw_MngBin/../etc_cust/sqwmng_GlobalVar.cfg
