SQWareProduction:oracle:bin:sqwora CopyDmpdp.ksh

From Wiki_dbSQWare
Revision as of 21:11, 29 November 2020 by BatchUser (talk | contribs) (Updated by BatchUser)
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Presentation

Script $gvsqw_OraBin/sqwora_CopyDmpdp.ksh :


Copy dmpdp files by rsync
Actions:

  • Copy dmpdp files get or put


The script can also:

  • send email report of CopyDmpdp
  • run shell script before load
  • run shell script after load



Online help

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

Sourcing sqwora_Global.lib v2025.06 SQWareProduction for Oracle (dbSQWare) ... 

Usage: sqwora_CopyDmpdp.ksh [-h] -I <instance> -FileIdent <fileident> [-GetInf <u@h:path> or -PutInf <u@h:path>] [+ options]

DESCRIPTION
   sqwora_CopyDmpdp.ksh copy dmpdp by get or put method
SUPPORT
   Oracle supported versions: 10gR2 <= v <= 23ai

PARAMETERS
     -I  instance       : Target instance.
     -FileIdent  txt    : File identifier of dump to load (ex: ExpdpFull_MYORA or ExpdpMYSCH_ or ...).
     [
     -GetInf  u@h:path  : user@host:path to retrieve dump from distant source.
     OR
     -PutInf  u@h:path  : user@host:path to push dump to distant host.
     ]
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -RD  directory     : Local directory to get or put dmpdp (by default /$(echo ${HOME}|cut -d/ -f2)/backup/${ORACLE_SID}/expdp).
     -FRT       code    : Force return code value on error.
     -Before scriptname : Script to execute before copy dump.
     -After  scriptname : Script to execute after copy dump.
     -AddMail   email   : Email address to add at 'demo-sqwarebox@dbsqware.com'.
     -SendReport        : Send execution log report.
     -NoMail            : Deactivate sendmail on error to demo-sqwarebox@dbsqware.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -Exec              : Execute the copy (by default, display generated commands).

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 'FileIdent' parameter, Usage: sqwora_CopyDmpdp.ksh [-h] -I <instance> -FileIdent <fileident> [-GetInf <u@h:path> or -PutInf <u@h:path>] [+ options]
For full help : sqwora_CopyDmpdp.ksh -h

If you are connecting through a terminal, no mail will be sent and you will have more this kind of message:

Begining     : 2020-11-29 20:10:09
End          : 2020-11-29 20:10:10
Duration     : 00:00:01 

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).

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

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


Usage examples

Sourcing sqwora_Global.lib v2025.06 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_CopyDmpdp.ksh:

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -h
#Display online help for this script

$gvsqw_OraBin/sqwora_CopyDmpdp.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_CopyDmpdp.ksh -s
#Display usage examples for this script

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -PutInf <user@host:path>
#Generate commands but don't execute them !

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -PutInf <user@host:path> -Exec
#Copy put, if the file is identified by <fileident>

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -GetInf <user@host:path> -RD <path> -Exec
#Copy get to local directory <path> (by default value is /orabackup/$ORACLE_SID/expdp manage by $gvsqw_RootExpdp)

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -GetInf <user@host:path> -Before <script> -Exec
#Execute the script <script> then do "Copy get"

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent ExpdpFull_MYORA -GetInf <user@host:path> -After $Home/scripts/XXX.ksh -Exec
#Copy get to local directory /orabackup/$ORACLE_SID/tmp/expdp, if the file is identified by ExpdpFull_MYORA <fileident> at <Host>:<Path> with <user> then execute the script $Home/scripts/XXX.ksh

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -GetInf <user@host:path> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -GetInf <user@host:path> -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -GetInf <user@host:path> -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_OraBin/sqwora_CopyDmpdp.ksh -I $ORACLE_SID -FileIdent <fileident> -GetInf <user@host:path> -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_sqwora_CopyDmpdp=<NumericValue>
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg
Note:
To be sure the examples are accurate, refer directly to the online help script -s option.