SQWareProduction:generic

From Wiki_dbSQWare
Revision as of 17:33, 5 April 2014 by BatchUser (talk | contribs) (Updated by BatchUser)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Presentation

Usage

It's the module locally operating of generic.
It is entirely written in ksh and sql.
It allows to manage the operation for generic.
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 !
Installation guide for SQWareProduction for generic

Explanation of directories

Directories located in $gvsqw_GenBin:

  • 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.


Naming convention of files

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

bin

sqwgen_NetBackup.ksh

Script $gvsqw_GenBin/bin/sqwgen_NetBackup.ksh:

backup with NetBackup dump/backup files See the detailed help for sqwgen_NetBackup.ksh

sqwgen_ParallelRun.ksh

Script $gvsqw_GenBin/bin/sqwgen_ParallelRun.ksh:

Manages the execution of unix commands in parallel mode
Takes in parameter file with unix command to execute
You can choose:

  • The parallel degree
  • Aggressiveness of run (number of seconds between two runs)
  • Aggressiveness of check end (number of seconds between two checks of end)


See the detailed help for sqwgen_ParallelRun.ksh

sqwgen_RunJob.ksh

Script $gvsqw_GenBin/bin/sqwgen_RunJob.ksh:

Run <gvsqw_RdbmsName> scripts and generate log and error file
based on $gvsqw_RootCfg/sqw<gvsqw_RdbmsRoot>_Jobs.cfg configuration file
compress and purge oldest log files See the detailed help for sqwgen_RunJob.ksh


etc

sqwgen_DbRefVar.cfg

Configuration file $gvsqw_GenBin/../etc/sqwgen_DbRefVar.cfg:
Global var for SQWareRepository connexion
It contains the operating variables of SQWareProduction.

Nuvola apps information.png
Note:
You can overload variables contain in $gvsqw_GenBin/../etc/sqwgen_DbRefVar.cfg

by the same variables in $gvsqw_GenBin/../etc_cust/sqwgen_DbRefVar.cfg for all your environnement
or in $HOME/sqwConfig/sqwgen_DbRefVar.cfg specifically for this user.

See the detailed help for sqwgen_DbRefVar.cfg

sqwgen_GlobalVar.cfg

Configuration file $gvsqw_GenBin/../etc/sqwgen_GlobalVar.cfg:
Generic global var
It contains the operating variables of SQWareProduction.

Nuvola apps information.png
Note:
You can overload variables contain in $gvsqw_GenBin/../etc/sqwgen_GlobalVar.cfg

by the same variables in $gvsqw_GenBin/../etc_cust/sqwgen_GlobalVar.cfg for all your environnement
or in $HOME/sqwConfig/sqwgen_GlobalVar.cfg specifically for this user.

See the detailed help for sqwgen_GlobalVar.cfg

sqwgen_IndicatorsVar.cfg

Configuration file $gvsqw_GenBin/../etc/sqwgen_IndicatorsVar.cfg:
Generic global var for indicators scripts
It contains the operating variables of SQWareProduction.

Nuvola apps information.png
Note:
You can overload variables contain in $gvsqw_GenBin/../etc/sqwgen_IndicatorsVar.cfg

by the same variables in $gvsqw_GenBin/../etc_cust/sqwgen_IndicatorsVar.cfg for all your environnement
or in $HOME/sqwConfig/sqwgen_IndicatorsVar.cfg specifically for this user.

See the detailed help for sqwgen_IndicatorsVar.cfg

.profile

Sample file for .profile $gvsqw_GenBin/../etc/.profile:
Sample of lines to add to .profile of generic users.
See the detailed help for .profile

.profile_confort

File to put aliases $gvsqw_GenBin/../etc/.profile_confort:
Contains confort aliases of SQWareProduction for RDBMS generic.

Nuvola apps information.png
Note:
You can overload confort environnement $gvsqw_GenBin/../etc/.profile_confort

with $gvsqw_GenBin/../etc_cust/.profile_confort for all your environnement
or with $HOME/edtConfig/.profile_confort specifically for this user .


See the detailed help for .profile_confort


lib

sqwgen_GatherIndicators.lib

shell functions library $gvsqw_GenBin/../lib/sqwgen_GatherIndicators.lib:
lib for sqw..._GatherIndicators.ksh

Nuvola apps information.png
Note:
You can overload functions contained in $gvsqw_GenBin/../lib/sqwgen_GatherIndicators.lib

by function with same name in $gvsqw_GenBin/../lib_cust/sqwgen_GatherIndicators.lib for all your environnement
or by $HOME/sqwConfig/sqwgen_GatherIndicators.lib specifically for this user .


See the detailed help for sqwgen_GatherIndicators.lib

sqwgen_Global.lib

shell functions library $gvsqw_GenBin/../lib/sqwgen_Global.lib:
central generic lib of global fonctions

Nuvola apps information.png
Note:
You can overload functions contained in $gvsqw_GenBin/../lib/sqwgen_Global.lib

by function with same name in $gvsqw_GenBin/../lib_cust/sqwgen_Global.lib for all your environnement
or by $HOME/sqwConfig/sqwgen_Global.lib specifically for this user .


See the detailed help for sqwgen_Global.lib

sqwgen_InsertIndicators.lib

shell functions library $gvsqw_GenBin/../lib/sqwgen_InsertIndicators.lib:
generic fonctions to insert into SQWareRepository

Nuvola apps information.png
Note:
You can overload functions contained in $gvsqw_GenBin/../lib/sqwgen_InsertIndicators.lib

by function with same name in $gvsqw_GenBin/../lib_cust/sqwgen_InsertIndicators.lib for all your environnement
or by $HOME/sqwConfig/sqwgen_InsertIndicators.lib specifically for this user .


See the detailed help for sqwgen_InsertIndicators.lib

sqwgen_NetBackup.lib

shell functions library $gvsqw_GenBin/../lib/sqwgen_NetBackup.lib:
lib for sqwgen_NetBackup.ksh

Nuvola apps information.png
Note:
You can overload functions contained in $gvsqw_GenBin/../lib/sqwgen_NetBackup.lib

by function with same name in $gvsqw_GenBin/../lib_cust/sqwgen_NetBackup.lib for all your environnement
or by $HOME/sqwConfig/sqwgen_NetBackup.lib specifically for this user .


See the detailed help for sqwgen_NetBackup.lib


help

Contains help files for -s option of bin scripts.


spm

SQL query toolkit
See the detailed help for spm


Retrieved from "https://wiki.dbsqware.com/index.php?title=SQWareProduction:generic&oldid=4077"