SQWareProduction:postgres:bin:sqwpg DumpDatabase.ksh

Presentation

Script $gvsqw_PgBin/sqwpg_DumpDatabase.ksh :

Generate pg_dump of database
Script makes purge of old generation automatically
You can also choose:

• different retention policy
• add option to pg_dump command
• choose compressor

Online help

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

Sourcing sqwpg_Global.lib v2024.07 SQWareProduction for PostgreSQL (dbSQWare) ... 

Usage: sqwpg_DumpDatabase.ksh [-h] -I instance -D databasename [+ options]

DESCRIPTION
   sqwpg_DumpDatabase.ksh pg_dump of database
SUPPORT
   PostgreSQL supported versions: 9.0 <= v <= 16

PARAMETERS
     -I  instance       : Target instance to pg_dump.
     -D  databasename   : Target database.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -F  format         : Format of pg_dump (p,t,c,d).
     -RD directory      : Directory to write dump file (by default /pgbackup/$PG_SID).
     -HI   nb_gen       : Number of generations to keep (by default: 2).
     -Opt  option       : Modify default options for pg_dump.
     -ZIP extension     : Compressor extension gz,bz2,Z,none (by default: gz).
     -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 ).
     -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 (by default, display generated commands).

Error management

Errors passing arguments

This type of message is generated:

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


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

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

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName>
#Generate commands but don't execute them !

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -Exec
#Execute pg_dump on target database

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -Dist -Exec
#Execute a pg_dump of database <DbName> for 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_DumpDatabase.ksh -I $PG_SID -D <DbName> -RD -Exec
#Generate dump on directory target (by default /pgbackup/$PG_SID)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -ForceDump -Exec
#Execute dump even the cluster is in recovery mode (By default 'Disable')

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -NoForceDump -Exec
#Execute dump execpt if the cluster is in recovery mode (By default 'Disable')

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -Opt '<Option>' -Exec
#Execute the script with option <Option>

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -ZIP <ZipExtension> -F <Format> -Exec
#Execute generated commands and compress (gz,bz2,Z,none) with format pg_dump (p,t,c,d)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -HI <NumberOfGenerations> -Exec
#Change number of Generation to keep

$gvsqw_PgBin/sqwpg_DumpDatabase.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_DumpDatabase.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_DumpDatabase.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_DumpDatabase.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_DumpDatabase=<NumericValue>
#in configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg