SQWareProduction:postgres:bin:sqwpg DumpDatabase.ksh

Presentation

Script $gvsqw_PgBin/sqwpg_DumpDatabase.ksh :

Generate pg_dump de la database
Le script purge les anciennes generations automatiquement
Vous pouvez aussi choisir:

• une politique de backup differente
• ajouter une option a la commande pg_dump
• choisir un compresseur

Aide en ligne

L'aide en ligne est accessible dans la plupart des scripts avec l'option -h.
Ex: $gvsqw_PgBin/sqwpg_DumpDatabase.ksh -h
Contenu de l'aide :

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

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

DESCRIPTION
   sqwpg_DumpDatabase.ksh pg_dump de la base de donnees
SUPPORT
   PostgreSQL versions supportees: 9.0 <= v <= 16

PARAMETERS
     -I  instance       : Instance cible pour pg_dump.
     -D  databasename   : Base de donnees cible.
OPTIONS
     -h                 : Affichage de l'aide complete.
     -s                 : Affichage des exemples d'utilisation.
     -F  format         : Format du pg_dump (p,t,c,d).
     -RD directory      : Repertoire pour ecrire le fichier dump (par defaut /pgbackup/$PG_SID).
     -HI   nb_gen       : Nombre de generations a garder (par defaut: 2).
     -Opt  option       : Remplace les options par defaut pour pg_dump.
     -ZIP extension     : Compressor extension gz,bz2,Z,none (par defaut: gz).
     -FRT       code    : Valeur forcee du code retour sur erreur.
     -AddMail   email   : Adresse Email a ajouter a 'pmexpdba@gmail.com'.
     -SendReport        : Envoi du rapport d'execution.
     -Dist              : Pour connexion distante a la base de donnees (change $gvsqw_ConnectString par $gvsqw_DistConnectString ).
     -ForceDump         : Force le DUMP meme si le cluster est en recovery (par defaut, 'Disable').
     -NoForceDump       : Ne fait pas le DUMP si le cluster est en recovery (par defaut, 'Disable').
     -NoMail            : Desactive l'envoi de mail sur erreur a pmexpdba@gmail.com (par defaut, envoi sur erreur).
     -Locale    locale  : Force la Locale d'affichage de l'aide (fr,en).
     -Exec              : Execute les commandes generees (par defaut, affiche les commandes generees).

Traitement de l'erreur

Erreurs de parse des arguments

Ce type de message est genere:

Lack 'PG_SID' parameter, Utilisation: sqwpg_DumpDatabase.ksh [-h]  -I instance -D databasename [+ options]

Si vous vous connectez via un terminal, aucun mail ne sera envoyé et vous aurez plutôt ce type de message:

Not sending mail because you are in connected mode !!!
Lack 'PG_SID' parameter

Si vous n'êtes pas connecté à un terminal, le message d'erreur apparaît et est envoyé par mail à l'adresse contenue dans la variable $gvsqw_GlobalMail (Voir l'aide pour personnaliser cette variable). L'objet commence toujours par "$gvsqw_MailMsg_postgres : " (Voir l'aide pour personnaliser cette variable).

Execution errors

Que vous soyez ou non connecté à un terminal, le message d'erreur apparaît et un mail contenant un résumé des erreurs de traitement est envoyé à l'adresse contenue dans la variable $gvsqw_GlobalMail (Voir l'aide pour personnaliser cette variable). L'objet commence toujours par "$gvsqw_MailMsg_postgres : " (Voir l'aide pour personnaliser cette variable).

Exemples d'utilisation

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

#Standard (Locale) help for script sqwpg_DumpDatabase.ksh:


$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -h
#Affichage de l'aide en ligne pour ce script

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -Locale fr -h
#Affichage de l'aide en ligne pour ce script avec forcage de la locale 'fr' (Locale par defaut geree par $gvsqw_Locale)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -s
#Affichage des exemples d'utilisation pour ce script

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName>
#Genere les commandes mais ne les execute pas !

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -Exec
#Lance un pg_dump sur la database cible

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -Dist -Exec
Execute un pg_dump de la base <DbName> de l'instance non locale $PG_SID avec une connexion distante
#Vous devez saisir toutes les informations d'authentification a utiliser pour la connexion distante a l'instance dans le fichier $gvsqw_DistPasswdFile

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -RD -Exec
#Genere un dump dans le repertoire cible (par defaut /pgbackup/$PG_SID)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -ForceDump -Exec
#Execute le dump meme si le cluster est en recovery mode (Par defaut 'Disable')

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -NoForceDump -Exec
#Execute le dump sauf si le cluster est en recovery mode (Par defaut 'Disable')

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

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -ZIP <ZipExtension> -F <Format> -Exec
#Execute les commandes generees et les compresse (gz,bz2,Z,none) avec le format pg_dump (p,t,c,d)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -HI <NumberOfGenerations> -Exec
#Change le nombre de generation a garder

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Ajoute la liste de mail a l'adresse par defaut geree par $gvsqw_GlobalMail

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -SendReport -Exec
#Envoie la log par mail a la fin du traitement meme s'il n'y a pas d'erreur (par defaut, seulement en cas d'erreur)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -NoMail -Exec
#Desactive l'envoi de mail sur erreur a $gvsqw_GlobalMail (par defaut, seulement en cas d'erreur)

$gvsqw_PgBin/sqwpg_DumpDatabase.ksh -I $PG_SID -D <DbName> -FRT <NumericValue> -Exec
#Force le code retour a '<NumericValue>' sur erreur (si pas d'erreur, "exit 0"!)
#Vous pouvez aussi forcer le code retour de ce script pour tous
#si vous settez la variable d'environnement: $gvsqw_ForcedReturnCodeScript_sqwpg_DumpDatabase=<NumericValue>
#dans le fichier de configuration $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg