SQWareProduction:oracle:bin:sqwora Export.ksh

From Wiki_dbSQWare
Jump to: navigation, search

Presentation

Script $gvsqw_OraBin/sqwora_Export.ksh :


Generate Oracle export compressed by pipe
Type of export can be

  • full
  • schema
  • structure (full rows=no)
  • parfile
  • tables


Script makes purge of old generation automatically
You can also choose:

  • different retention policy
  • type of compression


- gzip
- bzip2
- compress
- none

  • different directory to put dump file
  • different directory to put log file



Online help

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

Sourcing sqwora_Global.lib v2024.01 SQWareProduction for Oracle (dbSQWare) ... 

Usage: sqwora_Export.ksh [-h] -I <instance> -T <type_exp> [+ options]

DESCRIPTION
   sqwora_Export.ksh export script
SUPPORT
   Oracle supported versions: 9iR2 <= v <= 21c

PARAMETERS
     -I  instance       : Target instance to export.
     -T  type_exp       : Type of export (full,schema,structure,parfile,tables).
OPTIONS
     -h  help           : Display the full usage.
     -s                 : Display samples of usage.
     -H   nb_gen        : Number of generations to keep (default: 1).
     -FU  owner         : Schema to export.
     -Pdb pdb_name      : pdb_name for multitenant.
     -PAR parfile       : Parfile to use.
     -ZIP extension     : Compressor extension gz,bz2,Z,none (default: gz).
     -FRT return_code   : Force return code value on error.
     -AddMail email     : Email address to add at 'pmexpdba@gmail.com'.
     -Consistent        : Export full in 'consistent=y'.
     -SendReport        : Send execution log report.
     -DIR dir_dump      : Export directory (default: /$(echo ${HOME}|cut -d/ -f2)/backup/${ORACLE_SID}/exp).
     -DLOG dir_log      : Log directory (default: /$(echo $HOME|cut -d/ -f2)/backup/${ORACLE_SID}/exp/log).
     -Sysdba            : '/ as sysdba' connection instead of $gvsqw_DbaUser.
     -NoMail            : Deactivate sendmail on error to pmexpdba@gmail.com (by default, send on error).
     -Locale   locale   : Force Locale for help display (fr,en).
     -Exec              : Execute export (default, display generated commands).

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 instance parameter, Usage: sqwora_Export.ksh [-h] -I <instance> -T <type_exp> [+ options]
For full help : sqwora_Export.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).

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_oracle (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_oracle : " (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 sqwora_Global.lib v2024.01 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_Export.ksh:



# XXXXX : -FU
# XXXXX : -Pdb
# XXXXX : -PAR
# XXXXX : -DLOG
# XXXXX : -Consistent
# XXXXX : -Sysdba

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

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

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

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

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -NoMail
#Deactivate sendmail on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -DIR <DirExport> -ZIP <ZipExtension> -Exec
#Execute generated commands and use export directory <DirExport> and compress them (gz,bz2,Z,none)

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType>
#Generate commands but don't execute them !

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T schema -O <SchemaName> -Exec
#Export schema <SchemaName>

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -H <HostName> -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_Export=<NumericValue>
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg



Nuvola apps information.png
Note:
To be sure the examples are accurate, refer directly to the online help script -s option.