SQWareProduction:adabas:bin:sqwada DeleteCheckpoints.ksh

From Wiki_dbSQWare
Jump to: navigation, search

Presentation

Script $gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh :


Supress checkpoints



Online help

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

Sourcing sqwada_Global.lib v2024.01 SQWareProduction for Adabas (dbSQWare) ... 
\nUsage: sqwada_DeleteCheckpoints.ksh [-h] -I <instance> [+ options]\n
DESCRIPTION
   sqwada_DeleteCheckpoints.ksh Delete Checkpoints
SUPPORT
   Adabas supported versions: 6.3 <= v <= 6.4\n
PARAMETERS
     -I  instance       : Target instance.
OPTIONS
     -h    help         : 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.
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -Locale   locale   : Force Locale for help display (fr,en).
     -Exec              : Execute commands (default, display generated commands).\n
Nuvola apps information.png
Note:
To be sure the aid is accurate, refer directly to the online help script -h option.


Error management

Errors passing arguments

This type of message is generated:

Lack 'DBID' parameter, Usage: sqwada_DeleteCheckpoints.ksh [-h] -I <instance> [+ options]
For full help : sqwada_DeleteCheckpoints.ksh -h\n

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 'DBID' 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_adabas : " (See help customize this variable).

Nuvola apps information.png
Note:
Sending mail can be disabled by the option -NoMail for one execution.


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_adabas (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_adabas : " (See help customize this variable).

Nuvola apps information.png
Note:
Sending mail can be disabled by the option -NoMail for one execution.


Usage examples

Sourcing sqwada_Global.lib v2024.01 SQWareProduction for Adabas (dbSQWare) ... 

#Standard help for script sqwada_DeleteCheckpoints.ksh:

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -h
#Display online help for this script

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -Locale en -h
#Display online help for this script with forcing of the 'en' locale (default locale managed by the variable gvsqw_Locale)

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -s
#Display usage examples for this script

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com'
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -SendReport
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -I $DBID -NoMail
#Deactivate sendmail on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_AdaBin/sqwada_DeleteCheckpoints.ksh -I $DBID -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_sqwada_DeleteCheckpoints=<NumericValue>
#in configuration file $gvsqw_AdaBin/../etc_cust/sqwada_GlobalVar.cfg
Nuvola apps information.png
Note:
To be sure the examples are accurate, refer directly to the online help script -s option.