SQWareProduction:postgres:bin:sqwpg DumpGlobalsOnly.ksh
Contents
Presentation
Script $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh :
Generate pg_Dumpall -g (--globals-only) compressed by pipe
Script makes purge of old generation automatically
You can also choose:
- different retention policy
- add option to pg_Dumpall command
- choose compressor
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -h
Content of this assistance :
Sourcing sqwpg_Global.lib v2024.01 SQWareProduction for PostgreSQL (dbSQWare) ... Usage: sqwpg_DumpGlobalsOnly.ksh [-h] -I instance [+ options] DESCRIPTION sqwpg_DumpGlobalsOnly.ksh pg_dumpall -g (--globals-only) SUPPORT PostgreSQL supported versions: 9.0 <= v <= 16 PARAMETERS -I instance : Target instance to pg_dumpall -g (--globals-only). OPTIONS -h help : Display the full usage. -s : Display samples of usage. -RD directory : Directory to write dump file (default /pgbackup/$PG_SID). -HI nb_gen : Number of generations to keep (default: 2). -Opt option : Additional options for pg_dumpall. -ZIP extension : Compressor extension gz,bz2,Z,none (default: gz). -FRT return_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 ). -ForceDump : Force the DUMP even if the cluster is in recovery mode (par defaut, 'Disable'). -NoForceDump : don't exec DUMP if the cluster is in recovery mode (par defaut, 'Disable'). -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 (default, display generated commands)
Error management
Errors passing arguments
This type of message is generated:
Lack 'PG_SID' parameter, Usage: sqwpg_DumpGlobalsOnly.ksh [-h] -I instance [+ options] For full help : sqwpg_DumpGlobalsOnly.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.01 SQWareProduction for PostgreSQL (dbSQWare) ... #Standard help for script sqwpg_DumpGlobalsOnly.ksh: # XXXXX : -RD # XXXXX : -Opt # XXXXX : -Dist $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -h #Display online help for this script $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -Locale en -h #Display online help for this script with forcing of the 'en' locale (default locale managed by the variable gvsqw_Locale) $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -s #Display usage examples for this script $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' #Add the mail list to the default address managed by the variable gvsqw_GlobalMail $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -SendReport #Send the log by email at the end of the treatment even if there is no error $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -I $PG_SID -NoMail #Deactivate sendmail on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -I $PG_SID -ZIP <ZipExtension> -F <Format> -Exec #Execute generated commands et les compresse (gz,bz2,Z,none) avec le format tar ou rsyncec $gvsqw_PgBin/sqwpg_DumpAllDatabases.ksh -I $PG_SID -HI <NumberOfGenerations> -Exec #Change number of Generation to keep $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.ksh -I $PG_SID #Generate commands but don't execute them ! $gvsqw_PgBin/sqwpg_DumpGlobalsOnly.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_DumpGlobalsOnly=<NumericValue> #in configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg