SQWareProduction:mysql:bin:sqwmys RestoreDatabase.ksh

From Wiki_dbSQWare
Jump to navigation Jump to 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 v2025.10 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 <= 9.2
   MariaDB supported versions: 5.5 <= v <= 11.8

PARAMETERS
     -I  instance       : Target instance to restore.
     -DT DatabaseTarget : Target database.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -F  file           : Dump file to restore (by default take the latest).
     -DS DatabaseSource : Source database (by default same than -DT).
     -DD date_dump      : Dump date to restore (by default take the latest).
     -RD directory      : Directory holding dump file (by default $HOME/mys_dump/$MYSQL_SID).
     -Drop              : Drop database before load (by default, Enable).
     -NoMail            : Deactivate sendmail on error demo-sqwarebox@dbsqware.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 'demo-sqwarebox@dbsqware.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       code    : Force return code value on error.
     -Exec              : Restore (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 '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).

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

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


Usage examples

Sourcing sqwmys_Global.lib v2025.10 SQWareProduction for MySQL (dbSQWare) ... 

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

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

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -s
#Display usage examples for this script

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName>
#Generate commands but don't execute them !

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -Exec
#Restore database <DbName> \$lvsqw_CopyType

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -DS <DbsName> -F <FileName> -Exec
#Restore database <DbName> from the backup <FileName> (lastest by default) of database source <DbsName>

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -RD <DirName> -Exec
#Directory holding dump file

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -DD <Date> -Exec
#Select the dump to restore dy date (by default take the latest)

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -NoDrop -Exec
#Do not drop database before load (by default locale managed by $gvsqw_DropDb)

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -Drop -Create -Exec
#Drop database before load, use locale from instance $MYSQL_SID for all create commands (by default locale managed by $gvsqw_CreateDb)

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -Drop -NoCreate -Exec
#Drop database before load, use locale from mysqldump for all create commands (by default locale managed by $gvsqw_CreateDb)

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -OptionsMySQL <option> -Exec
#Additional options during mysql command

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> OptionsBeforeMySQL <option> -Exec
#Additional options before mysql command

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -Verbose -Exec
#Add -vv option to mysql cmd when restore

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com' -Exec
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -SendReport -Exec
#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 -DT <DbName> -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_MysBin/sqwmys_RestoreDatabase.ksh -I $MYSQL_SID -DT <DbName> -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
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:mysql:bin:sqwmys_RestoreDatabase.ksh&oldid=18236"