SQWareProduction:postgres:bin:sqwpg CopyDumpDatabase.ksh

Presentation

Script $gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh :

Online help

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

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

Usage: sqwpg_CopyDumpDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> [[+ options]]

DESCRIPTION
   sqwpg_CopyDumpDatabase.ksh copy of dump $lvsqw_CopyType 
SUPPORT
   PostgreSQL supported versions: 9.0 <= v <= 16

PARAMETERS
     -I  instance       : Target instance to copy.
     -DT DatabaseTarget : Target database.
     [
     -GetInf  u@h:path  : user@host:path to retrieve dump from distant source.
     OR
     -PutInf  u@h:path  : user@host:path to push dump to distant host.
     OR
     -IS instance       : Source instance.
     -US hostname       : Source hostname.
     ]
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -F  file           : Dump file to copy (by default take the latest).
     -HI Nb             : Nb of generations to keep, only for get option (by default 1).
     -DD date_dump      : Dump date to copy (by default take the latest).
     -RD  directory     : Local directory to get or put dump file (by default /pgbackup/$PG_SID).
     -RDS directory     : Distant directory to get or put dump file (by default /pgbackup/$lvsqw_InstanceSource).
     -UUS     username  : Source unix user(by default, same as target).
     -FRT       code    : Force return code value on error.
     -Before scriptname : Script to execute before copy dump.
     -After  scriptname : Script to execute after copy dump.
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Locale    locale  : Force Locale for help display (fr,en).
     -Exec              : Copy files $lvsqw_CopyType (by default, display generated commands).

Error management

Errors passing arguments

This type of message is generated:

Lack 'GetInf' or 'PutInf' or 'SourceInstance+SourceHostname' parameter, Usage: sqwpg_CopyDumpDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> -IS <SourceInstance> -US <SourceHostname> [[+ options]]
For full help : sqwpg_CopyDumpDatabase.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 'GetInf' or 'PutInf' or 'SourceInstance+SourceHostname' 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_CopyDumpDatabase.ksh:

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

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

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

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

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh -I $PG_SID -D <DbName> -RD <directory> -Exec
#Generate dump on directory target (by default /pgbackup/$PG_SID)

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh -I $PG_SID -D <DbName> -DD <Date> -After <script> -Exec
#Precise the date of dump to be copied (by default, the lastest), then execute the script <script> after

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh -I $PG_SID -D <DbName> -F <File> -Before <script> -Exec
#Specify the file <File> to be copied, and execute the script <script> before

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh -I $PG_SID -D <DbName> -RDS <chemin> -Exec
#Directort for finding the dump file to copy (by default $gvsqw_RootDumpSource)

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh -I $PG_SID -D <DbName> -UUS <username> -Exec
#Execute the script as Source unix user (by default, same as target)

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

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.ksh -I $PG_SID -D <DbName> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Add the mail list to the default address managed by $gvsqw_GlobalMail

$gvsqw_PgBin/sqwpg_CopyDumpDatabase.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_CopyDumpDatabase.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_CopyDumpDatabase.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