SQWareProduction:mysql:bin:sqwmys RestoreDatabase.ksh

From Wiki_dbSQWare
Jump to: navigation, search

Presentation

Script $gvsqw_MysBin/sqwmys_RestoreDatabase.ksh :




Online help

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

Sourcing sqwmys_Global.lib v2024.01 SQWareProduction for MySQL (dbSQWare) ... 

Usage: sqwmys_RestoreDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> [[+ options]]

DESCRIPTION
   sqwmys_RestoreDatabase.ksh restore $lvsqw_CopyType 
SUPPORT
   MySql   supported versions: 5.0 <= v <= 8.1
   MariaDB supported versions: 5.5 <= v <= 11.1

PARAMETERS
     -I  instance       : Target instance to restore.
     -DT DatabaseTarget : Target database.
OPTIONS
     -h  help           : Display the full usage.
     -s                 : Display samples of usage.
     -F  file           : Dump file to restore (default take the latest).
     -DS DatabaseSource : Source database (by default same than -DT).
     -DD date_dump      : Dump date to restore (default take the latest).
     -RD directory      : Directory holding dump file (default $HOME/mys_dump/$MYSQL_SID).
     -Drop              : Drop database before load (by default, Enable).
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
     -NoDrop            : Do not drop database before load (by default, Enable).
     -Create            : Create database before load with instance default character set (by default, Enable).
     -Verbose           : Add -vv option to mysql cmd when restore.
     -NoCreate          : No create database before load (by default, Enable).
     -AddMail email     : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -OptionsMySQL  opt : Additional options during mysql command (by default, ).
     -OptionsBeforeMySQL opt : Additional options before mysql command (by default, ).
     -Locale   locale   : Force Locale for help display (fr,en).
     -FRT  return_code  : Force return code value on error.
     -Exec              : Restore (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 'MYSQL_SID' parameter, Usage: sqwmys_RestoreDatabase.ksh [[-h]] -I instance -DT <DatabaseTarget> [[+ options]]
For full help : sqwmys_RestoreDatabase.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 'MYSQL_SID' 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_mysql : " (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_mysql (See help customize this variable). The subject line will always start by "$gvsqw_MailMsg_mysql : " (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 sqwmys_Global.lib v2024.01 SQWareProduction for MySQL (dbSQWare) ... 

#Standard help for script sqwmys_RestoreDatabase.ksh:
# restore \$lvsqw_CopyType

# XXXXX : -DS
# XXXXX : -RD
# XXXXX : -DD
# XXXXX : -Drop
# XXXXX : -Create
# XXXXX : -NoDrop
# XXXXX : -Verbose
# XXXXX : -NoCreate

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -h
#Display online help for this script

$gvsqw_MysBin/sqwmys_RestoreDatabase.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_MysBin/sqwmys_RestoreDatabase.ksh -s
#Display usage examples for this script

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

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

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -NoMail
#Deactivate sendmail on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -Exec
#Execute generated commands

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -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_sqwmys_RestoreDatabase=<NumericValue>
#in configuration file $gvsqw_MysBin/../etc_cust/sqwmys_GlobalVar.cfg

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