Difference between revisions of "SQWareProduction:oracle:bin:sqwora Export.ksh"

From Wiki_dbSQWare
Jump to: navigation, search
(→‎Aide en ligne)
m (Updated by BatchUser)
 
(15 intermediate revisions by 3 users not shown)
Line 1: Line 1:
−
== Présentation ==
+
{{SQWareProductionBinHelp|oracle|Ora|ora|sqwora_Export.ksh|
−
Script $gvsqw_OraBin/sqwora_Export.ksh:<br>
+
{{SQWareProduction_sqwora_Export.ksh_presentation}}
−
Oracle exports
+
|
−
<br><br>
+
{{SQWareProduction_sqwora_Export.ksh_help}}
−
== Aide en ligne ==
+
|
−
L'aide ligne est disponible pour la majorité des scripts avec l'option '''-h''' .<br>
 
−
Ex: $gvsqw_OraBin/sqwora_Export.ksh -h<br>
 
−
Voici le contenu de cette aide :
 
 
<pre>
 
<pre>
−
 
+
Lack instance parameter, Usage: sqwora_Export.ksh [-h] -I <instance> -T <ExpType> [+ options]
−
Usage: sqwora_Export.ksh [-h] -I <instance> -T <type_exp> [+ options]
 
−
 
 
−
DESCRIPTION
 
−
  sqwora_Export.ksh export script
 
−
 
 
−
PARAMETERS
 
−
    -I  instance      : Target instance for export.
 
−
    -T  type_exp      : Type of export (full,schema,structure,parfile,tables).
 
−
OPTIONS
 
−
    -h  help          : Display the full usage.
 
−
    -H  nb_gen        : Number of generations to keep (default: 1).
 
−
    -FU  owner        : Schema to export.
 
−
    -PAR parfile      : Parfile to use.
 
−
    -LTB list          : List of tables to export (owner.table1,owner.tables2,...).
 
−
    -ZIP extension    : Compressor extension gz,bz2,Z,none (default: gz).
 
−
    -DIR dir_dump      : Export directory (default: /$(echo ${HOME}|cut -d/ -f2)/ora_dump/exp).
 
−
    -DLOG dir_log      : Log directory (default: /$(echo $HOME|cut -d/ -f2)/ora_dump/log).
 
−
    -NoMail            : Desactivate sendmail on error to dba (by default, send on error).
 
−
    -Exec              : Execute export (default, display generated commands).
 
−
 
 
−
</pre>
 
−
{{Information | Pour être sur que l'aide est précise, reportez-vous directement à l'aide en ligne du script}}
 
−
<br>
 
−
 
 
−
== Erreurs ==
 
−
=== Erreurs de passage d'arguments ===
 
−
Ce type de message est généré:
 
−
<pre>
 
−
Lack instance parameter, Usage: sqwora_Export.ksh [-h] -I <instance> -T <type_exp> [+ options]
 
 
For full help : sqwora_Export.ksh -h
 
For full help : sqwora_Export.ksh -h
 
</pre>
 
</pre>
−
Si vous êtes connectez avec un terminal, aucun mail ne sera envoyé et vous aurez en plus ce genre de message:
+
|
 
<pre>
 
<pre>
−
No send mail because you are in connected mode !!!
+
Not sending mail because you are in connected mode !!!
 
Lack instance parameter
 
Lack instance parameter
 
</pre>
 
</pre>
−
Si vous n'êtes pas connecté à un terminal, le message d'erreur apparait et est envoyé par mail à l'adresse contenue dans la variable $gvsqw_Mail_oracle ([[SQWareProduction:oracle:etc:sqwora_GlobalVar.cfg#gvsqw_Mail_oracle|Voir l'aide pour customiser cette variable]]). Le sujet du mail commencera toujours par "$gvsqw_MailMsg_oracle : " ([[SQWareProduction:oracle:etc:sqwora_GlobalVar.cfg#gvsqw_MailMsg_oracle|Voir l'aide pour customiser cette variable]]).<br>
+
|
−
{{Information | L'envoi de mail peut être désactivé par l'option '''-NoMail'''}}<br>
+
{{SQWareProduction_sqwora_Export.ksh_example}}
−
 
+
}}
−
 
 
−
=== Erreurs lors de l'exécution ===
 
−
 
 
−
== Exemples d'utilisation ==
 
−
$gvsqw_OraBin/sqwora_Export.ksh <br>
 
−
$gvsqw_OraBin/sqwora_Export.ksh <br>
 

Latest revision as of 16:09, 7 April 2024

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.07 SQWareProduction for Oracle (dbSQWare) ... 

Usage: sqwora_Export.ksh [-h] -I <instance> -T <ExpType> [+ 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                 : Display the full usage.
     -s                 : Display samples of usage.
     -HI  nb_gen        : Number of generations to keep (by 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 (by 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.
     -RD   dir_dump     : Export directory (by default: /$(echo ${HOME}|cut -d/ -f2)/backup/${ORACLE_SID}/exp).
     -DLOG dir_log      : Log directory (by 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 (by 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 <ExpType> [+ 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.07 SQWareProduction for Oracle (dbSQWare) ... 

#Standard help for script sqwora_Export.ksh:


$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 (by default locale managed by $gvsqw_Locale)

$gvsqw_OraBin/sqwora_Export.ksh -s
#Display usage examples for this script

$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 <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> -DLOG <DirLog> -Exec
#Change the directory to use for the logfiles to : <DirExport> (by default is /orabackup/${ORACLE_SID}/exp/log)

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -PAR <parfile> -Exec
#Execute the backups by adding the parameters contained in the file <parfile>

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

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T schema -FU <SchemaName> -PutInf <user@host:path> -Exec
#Export the schema <SchemaName>, copy dump files and put it in <host:path>

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -Pdb <pdb_name> -Exec
#Specify pugable database name <pdb_name> for multitenant environnements

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -HI <NbGeneration> -Exec
#define the number of expdp version of data to keep for this job

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -P <NumericValue> -Exec
#Run sqwora_Expdp.ksh script with a parallel degree of '<NumericValue>'
#Use by default the variable gvsqw_NbThreadXXX in $gvsqw_OraBin/../etc/sqwora_GlobalVar.cfg
#You can change this default on all your environnement if you set this variable
#in configuration file $gvsqw_OraBin/../etc_cust/sqwora_GlobalVar.cfg

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -OPT '<options>' -Exec
#Add the option(s) <options> to the expdp job

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -sysdba -Exec
#Set the user as '/ as sysdba' for the expdp job

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -NoConsistent -Exec
#Remove 'flashback_time=systimestamp' option (set by default)

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -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_Export.ksh -I $ORACLE_SID -T <ExpType> -SendReport -Exec
#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
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error) -Exec

$gvsqw_OraBin/sqwora_Export.ksh -I $ORACLE_SID -T <ExpType> -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.


Retrieved from "https://wiki.dbsqware.com/index.php?title=SQWareProduction:oracle:bin:sqwora_Export.ksh&oldid=26693"