SQWareProduction:postgres:bin:sqwpg BackupArchiveXlog.ksh

Presentation

Script $gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh :

Backup all archivelogs (often runned by the sqwarchmon daemon)

Online help

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

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

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

DESCRIPTION
   sqwpg_BackupArchiveXlog.ksh backup of ArchiveXlog
SUPPORT
   PostgreSQL supported versions: 9.0 <= v <= 16

PARAMETERS
     -I  instance       : Target instance to backup ArchiveXlog.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -P  Nb threads     : Force number of threads in parallel (by default: 2).
     -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.
     -ForcePitr         : Force the execution even if the cluster is in recovery mode (par defaut, 'Disable').
     -NoForcePitr       : Don't exec if the cluster is in recovery mode (par defaut, 'Disable').
     -Force             : Force the execution without trying to connect.
     -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_BackupArchiveXlog.ksh [-h]  -I instance [+ options]
For full help : sqwpg_BackupArchiveXlog.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.02 SQWareProduction for PostgreSQL (dbSQWare) ... 

#Standard help for script sqwpg_BackupArchiveXlog.ksh:


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

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

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh -I $PG_SID
#Display generated commands without execute them !

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh -I $PG_SID -Exec
#Execute backup of archivelogs 

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh -I $PG_SID -ForcePitr -Exec
#Execute backup of archivelogs even the cluster is in recovery mode (By default 'Disable')

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh -I $PG_SID -NoForcePitr -Exec
#Execute backup of archivelogs execpt if the cluster is in recovery mode (By default 'Disable')

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh -I $PG_SID -Force -P 12 -ZIP <ZipExtension> -Exec
#Force parallel execution 12 without connection attempt and compress them (gz,bz2,Z,none)

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.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_BackupArchiveXlog.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_BackupArchiveXlog.ksh -I $PG_SID -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

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

$gvsqw_PgBin/sqwpg_BackupArchiveXlog.ksh -I $PG_SID -P <NumericValue> -Exec
#Run sqwpg_AnalyzeDatabase.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