Difference between revisions of "SQWareProduction:mysql:bin:sqwmys GatherStructure.ksh"

From Wiki_dbSQWare
Jump to: navigation, search
m (Updated by BatchUser)
m (Updated by BatchUser)
 
(2 intermediate revisions by the same user not shown)
(No difference)

Latest revision as of 15:44, 2 July 2021

Presentation

Script $gvsqw_MysBin/sqwmys_GatherStructure.ksh :


Gather MySql structure and put them in SQWareRepository
Summary of collection:

  • Tables list and options
  • Columns list, types and options
  • Indexes list, columns and options



Online help

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

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

Usage: sqwmys_GatherStructure.ksh [-h] -I <instance> [+ options]

DESCRIPTION
   sqwmys_GatherStructure.ksh gather databases structure
SUPPORT
   MySql   supported versions: 5.0 <= v <= 8.3
   MariaDB supported versions: 5.5 <= v <= 11.4

PARAMETERS
     -I  instance       : Target instance.
OPTIONS
     -h                 : Display the full usage.
     -s                 : Display samples of usage.
     -FRT       code    : Force return code value on error.
     -AddMail   email   : Email address to add at 'pmexpdba@gmail.com'.
     -SendReport        : Send execution log report.
     -Dist              : For distant connection to database (change $gvsqw_ConnectString to $gvsqw_DistConnectString ).
     -Locale    locale  : Force Locale for help display (fr,en).
     -NoMail            : Deactivate sendmail on error pmexpdba@gmail.com (by default, send on error).
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_GatherStructure.ksh [-h] -I <instance> [+ options]
For full help : sqwmys_GatherStructure.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.07 SQWareProduction for MySQL (dbSQWare) ... 

#Standard help for script sqwmys_GatherStructure.ksh:


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

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

$gvsqw_MysBin/sqwmys_GatherStructure.ksh -I $MYSQL_SID
#Gather MySql structure and put them in SQWareRepository

$gvsqw_MysBin/sqwmys_GatherStructure.ksh -I $MYSQL_SID -Dist
#Gather MySql structure 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_GatherStructure.ksh -I $MYSQL_SID -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com'
#Add the mail list to the default address managed by the variable gvsqw_GlobalMail

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

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

$gvsqw_MysBin/sqwmys_GatherStructure.ksh -I $MYSQL_SID -FRT <NumericValue>
#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_GatherStructure=<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.


Retrieved from "https://wiki.dbsqware.com/index.php?title=SQWareProduction:mysql:bin:sqwmys_GatherStructure.ksh&oldid=18228"