SQWareProduction:mssql:bin:sqwmsq GatherStructure.ksh

Presentation

Script $gvsqw_MsqBin/sqwmsq_GatherStructure.ksh :

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

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

Aide en ligne

L'aide en ligne est accessible dans la plupart des scripts avec l'option -h.
Ex: $gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -h
Contenu de l'aide :

Sourcing sqwmsq_Global.lib v2024.07 SQWareProduction for MsSql (dbSQWare) ... 

Utilisation: sqwmsq_GatherStructure.ksh [-h] -I <FreeTdsAlias> [+ options]

DESCRIPTION
   sqwmsq_GatherStructure.ksh Collecte les structures des bases de donnees 
SUPPORT
   MsSql versions supportees: 2000 <= v <= 2022

PARAMETERS
     -I   Instance      : Instance cible (freeTds alias).
OPTIONS
     -FRT       code    : Valeur forcee du code retour sur erreur.
     -NoMail            : Desactive l'envoi de mail sur erreur a pmexpdba@gmail.com (par defaut, envoi sur erreur).
     -Locale    locale  : Force la Locale d'affichage de l'aide (fr,en).
     -AddMail   email   : Adresse Email a ajouter a 'pmexpdba@gmail.com'.
     -SendReport        : Envoi du rapport d'execution.
     -h                 : Affichage de l'aide complete.
     -s                 : Affichage des exemples d'utilisation.

Traitement de l'erreur

Erreurs de parse des arguments

Ce type de message est genere:

Lack 'FreeTdsAlias' parameter, Utilisation: sqwmsq_GatherStructure.ksh [-h] -I <FreeTdsAlias> [+ options]

Si vous vous connectez via un terminal, aucun mail ne sera envoyé et vous aurez plutôt ce type de message:

Not sending mail because you are in connected mode !!!
Lack 'FreeTdsAlias' parameter

Si vous n'êtes pas connecté à un terminal, le message d'erreur apparaît et est envoyé par mail à l'adresse contenue dans la variable $gvsqw_GlobalMail (Voir l'aide pour personnaliser cette variable). L'objet commence toujours par "$gvsqw_MailMsg_mssql : " (Voir l'aide pour personnaliser cette variable).

Execution errors

Que vous soyez ou non connecté à un terminal, le message d'erreur apparaît et un mail contenant un résumé des erreurs de traitement est envoyé à l'adresse contenue dans la variable $gvsqw_GlobalMail (Voir l'aide pour personnaliser cette variable). L'objet commence toujours par "$gvsqw_MailMsg_mssql : " (Voir l'aide pour personnaliser cette variable).

Exemples d'utilisation

Sourcing sqwmsq_Global.lib v2024.07 SQWareProduction for MsSql (dbSQWare) ... 

#Standard (Locale) help for script sqwmsq_GatherStructure.ksh:


$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -h
#Affichage de l'aide en ligne pour ce script

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -Locale fr -h
#Affichage de l'aide en ligne pour ce script avec forcage de la locale 'fr' (Locale par defaut geree par $gvsqw_Locale)

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -s
#Affichage des exemples d'utilisation pour ce script

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -I $Alias
#Collecte les structures de l'instance cible 

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -I $Alias -AddMail 'mymail1@mydomaine.com,mymail2@mydomaine.com'
#Ajoute la liste de mail a l'adresse par defaut geree par $gvsqw_GlobalMail

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -I $Alias -SendReport
#Envoie la log par mail a la fin du traitement meme s'il n'y a pas d'erreur (par defaut, seulement en cas d'erreur)

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -I $Alias -NoMail
#Desactive l'envoi de mail sur erreur a $gvsqw_GlobalMail (par defaut, seulement en cas d'erreur)

$gvsqw_MsqBin/sqwmsq_GatherStructure.ksh -I $Alias -FRT <NumericValue>
#Force le code retour a '<NumericValue>' sur erreur (si pas d'erreur, "exit 0"!)
#Vous pouvez aussi forcer le code retour de ce script pour tous
#si vous settez la variable d'environnement: $gvsqw_ForcedReturnCodeScript_sqwmsq_GatherStructure=<NumericValue>
#dans le fichier de configuration $gvsqw_MsqBin/../etc_cust/sqwmsq_GlobalVar.cfg