SQWareProduction:generic:bin:sqwgen ExecSQL.ksh

Presentation

Script $gvsqw_GenBin/sqwgen_ExecSQL.ksh :

execute SQL file on instance

Online help

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

Sourcing sqwctl_Global.lib v2024.07 SQWareProduction for Central (dbSQWare) ... 

Usage: sqwgen_ExecSQL.ksh [-h] -I <instance> [+ options]

DESCRIPTION
   sqwgen_ExecSQL.ksh execute SQL file on instance
SUPPORT
   All rdbms type and version

PARAMETERS
     -I  instance       : Target instance.
     -F  FileName       : Filename to execute.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -Opt  option       : Additional options for sql connection.
     -FRT       code    : Force return code value on error.
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -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 ).
     -Exec              : Run commands (by default, display generated commands).

Error management

Errors passing arguments

This type of message is generated:

Lack instance parameter, Usage: sqwgen_ExecSQL.ksh [-h] -I <instance> [+ options]
For full help : sqwgen_ExecSQL.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 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_generic : " (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_generic (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_generic : " (See help customize this variable).

Usage examples

Sourcing sqwctl_Global.lib v2024.07 SQWareProduction for Central (dbSQWare) ... 

#Standard help for script sqwgen_ExecSQL.ksh:

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -h
#Display online help for this script

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -Locale en -h
#Display online help for this script with forcing of the 'en' locale (by default locale managed by $gvsqw_Locale)

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -s
#Display usage examples for this script

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName>
#Display all the generated commands by the script, whithout executing them

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName> -Exec
#Execute SQL file <FileName> on instance <Instance>

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName> -Opt '<Option>' -Exec
#Run the script with the optionnal SQL parameter <Option>

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Add the mail list to the default address managed by $gvsqw_GlobalMail (only this time)

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName> -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error (by default, send on error)

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName> -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_<gvsqw_RdbmsTrigram>/sqwgen_ExecSQL.ksh -I <Instance> -F <FileName> -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_sqwgen_ExecSQL=<NumericValue>
#in configuration file $gvsqw_<gvsqw_RdbmsTrigram>/../etc_cust/sqwgen_GlobalVar.cfg