SQWareProduction:postgres:bin:sqwpg GatherStructure.ksh
Contents
Presentation
Script $gvsqw_PgBin/sqwpg_GatherStructure.ksh :
Gather PostgreSQL structure and put them in SQWareRepository
Summary of collection:
- Tables list and options
- Columns list, types and options
- Indexes list, types and options
Online help
The online help is available for most scripts with the -h option.
Ex: $gvsqw_PgBin/sqwpg_GatherStructure.ksh -h
Content of this assistance :
Sourcing sqwpg_Global.lib v2024.07 SQWareProduction for PostgreSQL (dbSQWare) ...
Usage: sqwpg_GatherStructure.ksh [-h] -I <instance> [+ options]
DESCRIPTION
sqwpg_GatherStructure.ksh databases structures
SUPPORT
PostgreSQL supported versions: 9.0 <= v <= 16
PARAMETERS
-I instance : Target instance.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-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 ).
-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 'PG_SID' parameter, Usage: sqwpg_GatherStructure.ksh [-h] -I <instance> [+ options] For full help : sqwpg_GatherStructure.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_GatherStructure.ksh: $gvsqw_PgBin/sqwpg_GatherStructure.ksh -h #Display online help for this script $gvsqw_PgBin/sqwpg_GatherStructure.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_GatherStructure.ksh -s #Display usage examples for this script $gvsqw_PgBin/sqwpg_GatherStructure.ksh -I $PG_SID #Gather structures for target instance $PG_SID $gvsqw_PgBin/sqwpg_GatherStructure.ksh -I $PG_SID -Dist #Gather PostgreSQL structure 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_GatherStructure.ksh -I $PG_SID -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' #Add the mail list to the default address managed by the variable gvsqw_GlobalMail $gvsqw_PgBin/sqwpg_GatherStructure.ksh -I $PG_SID -SendReport #Send the log by email at the end of the treatment even if there is no error $gvsqw_PgBin/sqwpg_GatherStructure.ksh -I $PG_SID -NoMail #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_PgBin/sqwpg_GatherStructure.ksh -I $PG_SID -FRT <NumericValue> #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_GatherStructure=<NumericValue> #in configuration file $gvsqw_PgBin/../etc_cust/sqwpg_GlobalVar.cfg
