SQWareProduction:postgres:bin:sqwpg VacuumAllDatabases.ksh

From Wiki_dbSQWare
Revision as of 15:44, 2 July 2021 by BatchUser (talk | contribs) (Updated by BatchUser)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Presentation

Script $gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh :


Run of sqwpg_VacuumDatabase.ksh in parallel mode
You can choose:

  • The parallel degree
  • Aggressiveness of run (number of seconds between two runs)
  • Aggressiveness of check end (number of seconds between two checks of end)


Filters to generate database list (you can mix all off them):

  • Include list of database
  • Exclude list of database
  • Include like clause
  • Exclude like clause
  • Where clause



Online help

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

Sourcing sqwpg_Global.lib v2025.10 SQWareProduction for PostgreSQL (dbSQWare) ... 

Usage: sqwpg_VacuumAllDatabases.ksh [-h] -I instance [+ options]

DESCRIPTION
   sqwpg_VacuumAllDatabases.ksh vacuum tables of databases in parallel
SUPPORT
   PostgreSQL supported versions: 9.0 <= v <= 17

PARAMETERS
     -I  instance       : Target instance to vacuum.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -P    Nb threads   : Number of threads in parallel (by default 2).
     -ID   listdb       : List of databases to run vacuum tables (by default all).
     -ED   listdb       : List of databases to exclude.
     -IL   likeclause   : Like clause to generate databases list (example: 'db%').
     -EL   likeclause   : Like clause to exclude databases (example: 'nodb%').
     -WCD  whereclause  : Where clause to generate databases list.
     -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 'demo-sqwarebox@dbsqware.com'.
     -SendReport        : Send execution log report.
     -Opt  option       : Additional options for command line, ex:'VERBOSE'.
     -Analyze           : Enable 'ANALYZE' option (by default, Analyze='Disable').
     -NoAnalyze         : Disable 'ANALYZE' option (by default, Analyze='Disable').
     -Dist              : For distant connection to database (change $gvsqw_ConnectString to $gvsqw_DistConnectString ).
     -NoMail            : Deactivate sendmail on error demo-sqwarebox@dbsqware.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -Exec              : Execute commands (by default, display generated commands).
Note:
To be sure the aid is accurate, refer directly to the online help script -h option.


Error management

Errors passing arguments

This type of message is generated: 

Lack 'PG_SID' parameter, Usage: sqwpg_VacuumAllDatabases.ksh [-h]  -I instance [+ options]
For full help : sqwpg_VacuumAllDatabases.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).

Note:
Sending mail can be disabled by the option -NoMail for one execution.


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

Note:
Sending mail can be disabled by the option -NoMail for one execution.


Usage examples

Sourcing sqwpg_Global.lib v2025.10 SQWareProduction for PostgreSQL (dbSQWare) ... 

#Standard help for script sqwpg_VacuumAllDatabases.ksh:


$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -h
#Display online help for this script

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.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_VacuumAllDatabases.ksh -s
#Display usage examples for this script

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID
#Generate commands but don't execute them !

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -Exec
#Execute vacuum on all database

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -Dist -Exec
#Execute vacuum on all tables for all the databases 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_VacuumAllDatabases.ksh -I $PG_SID -Opt '<Option>' -Exec
#Execute the script with option <Option>

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -AGR 20 -Exec
#Set the waiting time in seconds between two command run, 20s here

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -AGE 30 -Exec
#Set the waiting time in seconds between two end checks, 30s here

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -ID 'DbName1,DbName2' -Exec
#Execute generated commands for only the 2 specified databases

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -ED 'DbName3,DbName4' -Exec
#Execute generated commands except for the 2 specified databases

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -IL '%_PROD' -Exec
#Clause like to generate dynamic database list to include (example: 'dbprod%')

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -EL '%_TESTS' -Exec
#Clause like to generate dynamic database list to exclude (example: 'dbtest%')

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -WCD '<condition>' -Exec
#Clause where to generate dynamic database list to include

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -P <NumericValue> -Exec
#Run sqwpg_VacuumDatabase.ksh script with a parallel degree of '<NumericValue>'
#Use by default the variable gvsqw_NbThreadXXX in $gvsqw_PgBin/../etc/sqwpg_GlobalVar.cfg
#You can change this default on all your environnement if you set this variable
#in configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg

$gvsqw_PgBin/sqwpg_VacuumAllDatabase.ksh -I $PG_SID -Analyze -Exec
#Runthe script sqwpg_VacuumAllDatabase.ksh with Analyze
#By default, it uses the gvsqw_VacuumAnalyze variable (Analyze='$gvsqw_VacuumAnalyze').
#You can change the default for the entire environment by setting this variable
#in the configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -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_VacuumAllDatabases.ksh -I $PG_SID -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_SID -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_PgBin/sqwpg_VacuumAllDatabases.ksh -I $PG_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_sqwpg_VacuumAllDatabases=<NumericValue>
#in configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg
Note:
To be sure the examples are accurate, refer directly to the online help script -s option.


Retrieved from "https://wiki.dbsqware.com/index.php?title=SQWareProduction:postgres:bin:sqwpg_VacuumAllDatabases.ksh&oldid=18285"