SQWareProduction:mysql:bin:sqwmys XtraBackup.ksh

From Wiki_dbSQWare
Revision as of 15:44, 2 July 2021 by BatchUser (talk | contribs) (Updated by BatchUser)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Presentation

Script $gvsqw_MysBin/sqwmys_XtraBackup.ksh :


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

  • different retention policy
  • different backup type full,inc
  • add option to XtraBackup command



Online help

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

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

Usage: sqwmys_XtraBackup.ksh [-h] -I instance [+ options]

DESCRIPTION
   sqwmys_XtraBackup.ksh XtraBackup of instance
SUPPORT
   MySql   supported versions: 5.0 <= v <= 9.2
   MariaDB supported versions: 5.5 <= v <= 11.8
    Before using this script, you must install XtraBackup utilities on your system !
    More information on https://www.percona.com/doc/percona-xtrabackup/LATEST/installation/yum_repo.html

PARAMETERS
     -I  instance       : Target instance to XtraBackup.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -Type type         : Type of backup full,inc (by default full).
     -Compress          : Enable --compress option.
     -RD   directory    : Directory to write backup (by default $HOME/XtraBackup/$MYSQL_SID).
     -HI   nb_gen       : Number of generations to keep (by default: 2).
     -Opt  option       : Additional options for XtraBackup of instance.
     -FRT       code    : Force return code value on error.
     -AddMail   email   : Email address to add at 'demo-sqwarebox@dbsqware.com'.
     -SendReport        : Send execution log report.
     -NoMail            : Deactivate sendmail on error demo-sqwarebox@dbsqware.com (by default, send on error).
     -Locale    locale  : Force Locale for help display (fr,en).
     -Exec              : Execute commands (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_XtraBackup.ksh [-h]  -I instance [+ options]
For full help : sqwmys_XtraBackup.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_XtraBackup.ksh:


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

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

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID
#Generate commands but don't execute them !

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -Exec
#Generate XtraBackup of instance $MYSQL_SID

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -Compress -Exec
#Enable --compress option for XtraBackup

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -RD <DirName> -Exec
#Local directory <DirName> to get or put XtraBackup

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -Type inc -HI 4 -Exec
#Makes incremental backup and keep 4 generations and change type of backup (full,inc)

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -Opt <option> -Exec
#Add the option(s) <Option> to the command line

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -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_XtraBackup.ksh -I $MYSQL_SID -SendReport -Exec
#Send the log by email at the end of the treatment even if there is no error

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -NoMail -Exec
#Disables sending an email on error to $gvsqw_GlobalMail (by default, send on error)

$gvsqw_MysBin/sqwmys_XtraBackup.ksh -I $MYSQL_SID -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_XtraBackup=<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_XtraBackup.ksh&oldid=18240"