SQWareProduction:postgres:bin:sqwpg ArchiveXlog.ksh

Presentation

Script $gvsqw_PgBin/sqwpg_ArchiveXlog.ksh :

archive xlog/wal

Online help

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

Usage: sqwpg_ArchiveXlog.ksh [-h] -I <instance> [+ options]

DESCRIPTION
   sqwpg_ArchiveXlog.ksh for archive xlog/wal
SUPPORT
   PostgreSQL supported versions: 9.0 <= v <= 16

PARAMETERS
     -I  instance       : Target instance.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -f    filename     : Absolute filename of xlog/wal to archive.
     -FRT       code    : Force return code value on error.
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Locale    locale  : Force Locale for help display (fr,en).
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).

Error management

Errors passing arguments

This type of message is generated:

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

#Standard help for script sqwpg_ArchiveXlog.ksh:

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

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

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

$gvsqw_PgBin/sqwpg_ArchiveXlog.ksh -I $PG_SID -Exec
#Execute archiving of xlog/wal

$gvsqw_PgBin/sqwpg_ArchiveXlog.ksh -I $PG_SID -f <FileName> -Exec
#Execute archiving of the xlog/wal file <Filename> only

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

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