SQWareProduction:oracle:bin:sqwora GatherStructure.ksh
Contents
Presentation
Script $gvsqw_OraBin/sqwora_GatherStructure.ksh :
Gather Oracle 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_OraBin/sqwora_GatherStructure.ksh -h
Content of this assistance :
Sourcing sqwora_Global.lib v2024.07 SQWareProduction for Oracle (dbSQWare) ...
Usage: sqwora_GatherStructure.ksh [-h] -I <instance> [+ options]
DESCRIPTION
sqwora_GatherStructure.ksh gather databases structure
SUPPORT
Oracle supported versions: 8.0 <= v <= 21c
PARAMETERS
-I instance : Target instance.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-FRT return_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_DbaUser to $gvsqw_DistDbaUser@$ORACLE_SID ).
-Locale locale : Force Locale for help display (fr,en).
-NoMail : Deactivate sendmail on error to pmexpdba@gmail.com (by default, send on error).
Error management
Errors passing arguments
This type of message is generated:
Lack instance parameter, Usage: sqwora_GatherStructure.ksh [-h] -I <instance> [+ options] For full help : sqwora_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 instance 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_oracle : " (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_oracle (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_oracle : " (See help customize this variable).
Usage examples
Sourcing sqwora_Global.lib v2024.07 SQWareProduction for Oracle (dbSQWare) ... #Standard help for script sqwora_GatherStructure.ksh: $gvsqw_OraBin/sqwora_GatherStructure.ksh -h #Display online help for this script $gvsqw_OraBin/sqwora_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_OraBin/sqwora_GatherStructure.ksh -s #Display usage examples for this script $gvsqw_OraBin/sqwora_GatherStructure.ksh -I $ORACLE_SID #Gather Oracle structure for instance $ORACLE_SID (no need for -Exec) $gvsqw_OraBin/sqwora_GatherStructure.ksh -I $ORACLE_SID -Dist #Gather Oracle structure with distant connection on non-local instance $ORACLE_SID #You need to register credentials to use for distant connection to the instance (user and so on) in file $gvsqw_DistPasswdFile $gvsqw_OraBin/sqwora_GatherStructure.ksh -I $ORACLE_SID -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' #Add the mail list to the default address managed by the variable gvsqw_GlobalMail $gvsqw_OraBin/sqwora_GatherStructure.ksh -I $ORACLE_SID -SendReport #Send the log by email at the end of the treatment even if there is no error $gvsqw_OraBin/sqwora_GatherStructure.ksh -I $ORACLE_SID -NoMail #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_OraBin/sqwora_GatherStructure.ksh -I $ORACLE_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_sqwora_GatherStructure=<NumericValue> #in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg
