SQWareProduction:mysql:bin:sqwmys DumpDatabase.ksh

From Wiki_dbSQWare
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Presentation

Script $gvsqw_MysBin/sqwmys_DumpDatabase.ksh :


Generate mysqlDump of database compressed by pipe
Script makes purge of old generation automatically
You can also choose:

  • different retention policy
  • add option to mysqlDump command
  • make Dump in consistent mode



Online help

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

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

Usage: sqwmys_DumpDatabase.ksh [-h] -I instance -D databasename [+ options]

DESCRIPTION
   sqwmys_DumpDatabase.ksh mysqldump of database
SUPPORT
   MySql   supported versions: 5.0 <= v <= 8.3
   MariaDB supported versions: 5.5 <= v <= 11.4

PARAMETERS
     -I  instance       : Target instance to mysqldump.
     -D  databasename   : Database for mysqldump.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -RD directory      : Directory to write dump file (by default $HOME/mys_dump/$MYSQL_SID).
     -HI   nb_gen       : Number of generations to keep (by default: 2).
     -Opt  option       : Additional options for mysqldump.
     -ZIP extension     : Compressor extension gz,bz2,Z,none (by default: gz).
     -FRT       code    : Force return code value on error.
     -Dist              : For distant connection to database (change $gvsqw_ConnectString to $gvsqw_DistConnectString ).
     -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).
     -Consistent        : Lock for consistent mode (by default, no lock).
     -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_DumpDatabase.ksh [-h]  -I instance -D databasename [+ options]
For full help : sqwmys_DumpDatabase.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.05 SQWareProduction for MySQL (dbSQWare) ... 

#Standard help for script sqwmys_DumpDatabase.ksh:


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

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

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

$gvsqw_MysBin/sqwmys_DumpDatabase.ksh -I $MYSQL_SID -D <DbName> -Exec
#Generate mysqlDump of database <DbName> on instance $MYSQL_SID compressed by pipe

$gvsqw_MysBin/sqwmys_DumpDatabase.ksh -I $MYSQL_SID -D <DbName> -RD -Exec
#Directory to write dump file

$gvsqw_MysBin/sqwmys_DumpDatabase.ksh -I $MYSQL_SID -D <DbName> -Dist -Exec
#Generate mysqlDump of database <DbName> for the non-local instance $MYSQL_SID with distant connection
#You need to register credentials to use for distant connection to the instance (user and so on) in file $gvsqw_DistPasswdFile

$gvsqw_MysBin/sqwmys_DumpDatabase.ksh -I $MYSQL_SID -D <DbName> -ZIP <ZipExtension> -Exec
#Execute generated commands and compress it (gz,bz2,Z,none)

$gvsqw_MysBin/sqwmys_DumpDatabase.ksh -I $MYSQL_SID -D <DbName> -Consistent -HI 4 -Exec
#Makes consistent Dump and keep 4 generations

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

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

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

$gvsqw_MysBin/sqwmys_DumpDatabase.ksh -I $MYSQL_SID -D <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_DumpDatabase=<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.