SQWareProduction:sybase:bin:sqwsyb GatherStructure.ksh
Contents
Presentation
Script $gvsqw_SybBin/sqwsyb_GatherStructure.ksh :
Gather Sybase 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_SybBin/sqwsyb_GatherStructure.ksh -h
Content of this assistance :
Sourcing sqwsyb_Global.lib v2024.07 SQWareProduction for Sybase (dbSQWare) ...
Usage: sqwsyb_GatherStructure.ksh [-h] -I <dataserver> [+ options]
DESCRIPTION
sqwsyb_GatherStructure.ksh gather databases structure
SUPPORT
Sybase supported versions: 12.0 <= v <= 16.0
PARAMETERS
-I dataserver : Target dataserver.
OPTIONS
-h : Display the full usage.
-s : Display samples of usage.
-FRT code : Force return code value on error.
-Dist : For distant connection to database (change $gvsqw_DbaUser to $gvsqw_DistDbaUser ).
-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 'dataserver' parameter, Usage: sqwsyb_GatherStructure.ksh [-h] -S|-I <dataserver> [+ options] For full help : sqwsyb_GatherStructure.ksh -h
If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:
No send mail because you are in connected mode !!! Lack 'dataserver' 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_sybase : " (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_sybase (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_sybase : " (See help customize this variable).
Usage examples
Sourcing sqwsyb_Global.lib v2024.07 SQWareProduction for Sybase (dbSQWare) ... #Standard help for script sqwsyb_GatherStructure.ksh: $gvsqw_SybBin/sqwsyb_GatherStructure.ksh -h #Display online help for this script $gvsqw_SybBin/sqwsyb_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_SybBin/sqwsyb_GatherStructure.ksh -s #Display usage examples for this script $gvsqw_SybBin/sqwsyb_GatherStructure.ksh -I $DSQUERY #Gather structures for target instance $gvsqw_SybBin/sqwsyb_GatherStructure.ksh -I $DSQUERY -Dist #Gather Sybase structure for the non-local instance $DSQUERY 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_SybBin/sqwsyb_GatherStructure.ksh -I $DSQUERY -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' #Add the mail list to the default address managed by the variable gvsqw_GlobalMail $gvsqw_SybBin/sqwsyb_GatherStructure.ksh -I $DSQUERY -SendReport #Send the log by email at the end of the treatment even if there is no error $gvsqw_SybBin/sqwsyb_GatherStructure.ksh -I $DSQUERY -NoMail #Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) $gvsqw_SybBin/sqwsyb_GatherStructure.ksh -I $DSQUERY -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_sqwsyb_GatherStructure=<NumericValue> #in configuration file $gvsqw_SybBin/../etc_cust/sqwsyb_GlobalVar.cfg
