SQWareProduction:postgres:bin:sqwpg AnalyzeDatabase.ksh
Contents
Presentation
Script $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh :
Update statistics of all tables for the database
Use command: analyse local table <TableName>
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -h
Content of this assistance :
Sourcing sqwpg_Global.lib v2024.07 SQWareProduction for PostgreSQL (dbSQWare) ... Usage: sqwpg_AnalyzeDatabase.ksh [-h] -I instance -D databasename [+ options] DESCRIPTION sqwpg_AnalyzeDatabase.ksh analyze tables of database SUPPORT PostgreSQL supported versions: 9.0 <= v <= 16 PARAMETERS -I instance : Target instance to analyze tables. -D databasename : Target database. OPTIONS -h : Display the full usage. -s : Display samples of usage. -FRT code : Force return code value on error. -AddMail email : Email address to add at 'pmexpdba@gmail.com'. -SendReport : Send execution log report. -Opt option : Additional options for command line, ex: - 'VERBOSE' - 'FULL' - 'FULL ANALYZE' - 'FULL VERBOSE ANALYZE' -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 'PG_SID' parameter, Usage: sqwpg_AnalyzeDatabase.ksh [-h] -I instance -D databasename [+ options] For full help : sqwpg_AnalyzeDatabase.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 'PG_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_postgres : " (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_postgres (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_postgres : " (See help customize this variable).
Usage examples
Sourcing sqwpg_Global.lib v2024.07 SQWareProduction for PostgreSQL (dbSQWare) ... #Standard help for script sqwpg_AnalyzeDatabase.ksh: $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -h #Display online help for this script $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -Locale en -h #Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale) $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -s #Display usage examples for this script $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_SID -D <DbName> #Display generated commands without execute them ! $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_SID -D <DbName> -Exec #Execute commands to update statistics of all tables on the database <DbName> $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_SID -D <DbName> -Dist -Exec #Analyze all tables for the database <DbName> of the non-local instance $PG_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_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_SID -D <DbName> -Opt '<Option>' -Exec #Execute the script with option <Option> $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_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_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_SID -D <DbName> -SendReport -Exec #Send the log by email at the end of the treatment even if there is no error $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_SID -D <DbName> -NoMail -Exec #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_PgBin/sqwpg_AnalyzeDatabase.ksh -I $PG_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_sqwpg_AnalyzeDatabase=<NumericValue> #in configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg