Difference between revisions of "SQWareProduction:general"

From Wiki_dbSQWare
Jump to: navigation, search
(convention de noms)
(Usage)
 
(29 intermediate revisions by the same user not shown)
Line 1: Line 1:
== présentation ==
+
== Presentation ==
=== utilisation ===
+
=== Usage ===
C'est le module d'exploitation en local des SGBDs. Il est entièrement écrit en ksh et sql.<br>
+
SQWareProduction, is the module locally operating of RDBMS.<br>
Il permet de gérer l'exploitation au sens large des SGBDs.<br>
+
It is entirely written in ksh and sql. <br>
<br>
+
It allows to manage the operation for RDBMS.<br>
Exemple d'utilisations de l'outil:
+
Example uses of the tool :
*Sauvegardes
+
*Backup
*Restaurations
+
*Recovery
*Calculs de statistiques
+
*Compute statistics
*Collecte d'indicateurs qui sont remontés sur le référentiel bdd [[SQWareRepository:general|SQWareRepository]]
+
*Indicators collection to store in referential database [[SQWareRepository:general|SQWareRepository]]
*Purge des logs
+
*Rotate logs
 
*....
 
*....
<br>
+
This module is deployed locally on the machine hosting the authorities to manage,  
Ce module est déployé en local sur les machines hébergeant les instances à gérer, ceci afin d'éviter tout points de faiblesse lié à un montage NFS ou autre. Le déploiement se fait par une simple commande grâce au module SQWareCentral et à l'inventaire se trouvant dans SQWareRepository !<br>
+
in order to avoid any points of weakness related to an NFS mount or whatever.  
 +
The deployment is done through a simple command SQWareCentral module using inventory located in SQWareRepository !<br>
 +
 
 +
Links to different plugins of the module SQWareProduction :
 +
*[[SQWareProduction:generic|Generic plugin]]
 +
*[[SQWareProduction:oracle|Plugin Oracle]]
 +
*[[SQWareProduction:sybase|Plugin Sybase]]
 +
*[[SQWareProduction:mysql|Plugin Mysql]]
 +
*[[SQWareProduction:mssql|Plugin Mssql]]
 +
*[[SQWareProduction:db2|Plugin DB2]]
 +
*[[SQWareProduction:postgres|Plugin PostgreSQL]]
 +
*[[SQWareProduction:cassandra|Plugin Cassandra]]
 +
*[[SQWareProduction:mongodb|Plugin MongoDB]]
 +
*[[SQWareProduction:adabas|Plugin Adabas]]
 +
*[[SQWareProduction:teradata|Plugin Teradata]]
 +
*[[SQWareProduction:ingres|Plugin Ingres]]
 +
[[Installation#SQWareProduction | Installation guide for SQWareProduction]]<br>
  
Liens vers les différentes parties du module SQWareProduction :
+
=== Explanation of directories ===
*[[SQWareProduction:oracle|Partie Oracle]]
+
Directories located in $gvsqw_<RdbmsTrigram>Bin (RdbmsTrigram=Ora,Syb,Mys,Msq,Db2,Pg,Ter,Cas,Ing):
*[[SQWareProduction:sybase|Partie Sybase]]
+
*bin : Directory containing standard scripts
*[[SQWareProduction:mysql|Partie Mysql]]
+
*bin_cust : Directory containing customs scripts for your environnement
*[[SQWareProduction:mssql|Partie Mssql]]
+
*etc : Directory containing the standard files of configuration
 +
*etc_cust : Directory containing the customs files of configuration for your environnement (overload standards)
 +
*help : Directory containing the standard files of help
 +
*help_cust : Directory containing the customs files of help for your environnement
 +
*lib : Directory containing the generic shell function librairies
 +
*lib_cust : Directory containing the generic shell function librairies (overload standards)
 +
*spm : Contain sql query toolkit
 +
*tools : Directory containing the standard scripts used on an ad hoc
 +
*tools_cust : Directory containing the customs scripts used on an ad hoc for your environnement
 +
*menu : Directory containing the standard menus
 +
*menu_cust : Directory containing the custom menus for your environnement
 +
{{Warning_custom}}
 
<br>
 
<br>
  
=== explication de l'arborescence ===
+
=== General architecture diagram SQWareProduction (when the module is locally installed) ===
Arborescences se trouvant dans $gvsqw_<TrigrammeSgbd>Bin (TrigrammeSgbd=Ora,Syb,Mys,Msq):
+
[[Image:General_SQWareProduction.jpg]]
*bin : Répertoire contenant les scripts standards
 
*bin_cust : Répertoire contenant les scripts customs à votre environnement
 
*etc : Répertoire contenant les fichiers de configuration standards
 
*etc_cust : Répertoire contenant les fichiers de configuration customs à votre environnement (surchangent les standards)
 
*lib : Répertoire contenant les librairies de fonctions shell génériques
 
*lib_cust : Répertoire contenant les librairies de fonctions shell customs à votre environnement (remplacent les standards)
 
*spm : Répertoire contenant les scripts d'un utilistaire permettant de lancer des requêtes sql standards déjà écrites pour vous
 
*tools : Répertoire contenant les scripts standards utilisés de manière ponctuelle
 
*tools_cust : Répertoire contenant les scripts customs à votre environnement utilisés de manière ponctuelle
 
*menu : Répertoire contenant les menus standards
 
*menu_cust : Répertoire contenant les menus customs à votre environnement
 
{{Warning_custom}}
 
  
== convention de noms des fichiers ==
+
== Naming convention of files ==
La majeure partie des fichiers sont nommés avec des préfixes:
+
The majority of files are named with prefixes:
* sqwora_* : pour Oracle
+
* sqwora_* : for Oracle
* sqwsyb_* : pour Sybase
+
* sqwsyb_* : for Sybase
* sqwmys_* : pour Mysql
+
* sqwmys_* : for Mysql
* sqwmsq_* : pour Mssql
+
* sqwmsq_* : for Mssql
La majeure partie des fichiers sont nommés avec des suffixes:
+
* sqwdb2_* : for DB2
* *.ksh : pour les scripts
+
* sqwpg_*  : for PostgreSQL
* *.cfg : pour les fichiers de configuration
+
* sqwter_* : for Teradata
* *.lib : pour les librairies de fonctions
+
* sqwcas_* : for Cassandra
 +
* sqwing_* : for Ingres
 +
<br>
 +
The majority of files are named with suffixes:
 +
* *.ksh : for scripts
 +
* *.cfg : for configuration files
 +
* *.lib : for function librairies
 +
* *.hlp : for help files
 
{{Warning_custom}}
 
{{Warning_custom}}
 
<br>
 
<br>
== convention de noms dans les scripts ==
+
 
 +
== Naming convention in scripts ==
 
{{ExpNomVars}}
 
{{ExpNomVars}}

Latest revision as of 16:15, 11 March 2018

Presentation

Usage

SQWareProduction, is the module locally operating of RDBMS.
It is entirely written in ksh and sql.
It allows to manage the operation for RDBMS.
Example uses of the tool :

  • Backup
  • Recovery
  • Compute statistics
  • Indicators collection to store in referential database SQWareRepository
  • Rotate logs
  • ....

This module is deployed locally on the machine hosting the authorities to manage, in order to avoid any points of weakness related to an NFS mount or whatever. The deployment is done through a simple command SQWareCentral module using inventory located in SQWareRepository !

Links to different plugins of the module SQWareProduction :

Installation guide for SQWareProduction

Explanation of directories

Directories located in $gvsqw_<RdbmsTrigram>Bin (RdbmsTrigram=Ora,Syb,Mys,Msq,Db2,Pg,Ter,Cas,Ing):

  • bin : Directory containing standard scripts
  • bin_cust : Directory containing customs scripts for your environnement
  • etc : Directory containing the standard files of configuration
  • etc_cust : Directory containing the customs files of configuration for your environnement (overload standards)
  • help : Directory containing the standard files of help
  • help_cust : Directory containing the customs files of help for your environnement
  • lib : Directory containing the generic shell function librairies
  • lib_cust : Directory containing the generic shell function librairies (overload standards)
  • spm : Contain sql query toolkit
  • tools : Directory containing the standard scripts used on an ad hoc
  • tools_cust : Directory containing the customs scripts used on an ad hoc for your environnement
  • menu : Directory containing the standard menus
  • menu_cust : Directory containing the custom menus for your environnement
Nuvola apps important.png
Warning:
Do not change the standard scripts and configuration files of dbSQWare.

Use directories *_cust for customizations. This will facilitate version upgrades.


General architecture diagram SQWareProduction (when the module is locally installed)

General SQWareProduction.jpg

Naming convention of files

The majority of files are named with prefixes:

  • sqwora_* : for Oracle
  • sqwsyb_* : for Sybase
  • sqwmys_* : for Mysql
  • sqwmsq_* : for Mssql
  • sqwdb2_* : for DB2
  • sqwpg_*  : for PostgreSQL
  • sqwter_* : for Teradata
  • sqwcas_* : for Cassandra
  • sqwing_* : for Ingres


The majority of files are named with suffixes:

  • *.ksh : for scripts
  • *.cfg : for configuration files
  • *.lib : for function librairies
  • *.hlp : for help files
Nuvola apps important.png
Warning:
Do not change the standard scripts and configuration files of dbSQWare.

Use directories *_cust for customizations. This will facilitate version upgrades.


Naming convention in scripts

In general, the following naming convention is used in all scripts of SQWareProduction:

  • gvsqw_ {} : global variable initialized by the environment and / or generic library
  • lvsqw_ {} : local variable initialized by the script and / or a specific library
  • gfsqw_ {} : function defined by a generic library
  • lfsqw_ {} : function defined by the script and / or a specific library