man8db/KEYreport

Table of Contents

Name

KEYreport - database key tables report generator

Synopsis

KEYreport [type] < list_of_tuples > alarms_report

Description

This program generates reports on the BusKeys, CmdKeys, CPTkeys, CrKeys, CtKeys, DFkeys, DataKeys, DevKeys, DrvKeys, IconKeys, JkKeys, NPTkeys, OwnKeys, PgKeys, RefKeys, and ScaKeys tables.

A set of SQL queries and other tools are used to extract the necessary information from the database and massage it into a form suitable for use with this program.

The input should contain one tuple per line. Lines are terminated by a newline. Fields within a tuple are separated by a |.

Type Argument

The following values are valid arguments for type.
BusKeys

generate the BusKeys table report.
CmdKeys

generate the CmdKeys table report.
CPTkeys

generate the CPTkeys table report.
CrKeys

generate the CrKeys table report.
CtKeys

generate the CtKeys table report.
DFkeys

generate the DFkeys table report.
DataKeys

generate the DataKeys table report.
DevKeys

generate the DevKeys table report.
DrvKeys

generate the DrvKeys table report.
IconKeys

generate the IconKeys table report.
JkKeys

generate the JkKeys table report.
NPTkeys

generate the NPTkeys table report.
OwnKeys

generate the OwnKeys table report.
PgKeys

generate the PgKeys table report.
RefKeys

generate the RefKeys table report.
ScaKeys

generate the ScaKeys table report.

BusKeys report tuple format

The following fields from the BusKeys table are used and appear as input to this program in this order: BusNme, BusVal, and BusDesc.

CmdKeys report tuple format

The following fields from the CmdKeys table are used and appear as input to this program in this order: CmdNme, CmdVal, and CmdDesc.

CPTkeys report tuple format

The following fields from the CPTkeys table are used and appear as input to this program in this order: CPTnme, CPTval, CPTdesc, and CPTdesc2.

CrKeys report tuple format

The following fields from the CrKeys table are used and appear as input to this program in this order: CrNme, CrVal, and CrDesc.

CtKeys report tuple format

The following fields from the CtKeys table are used and appear as input to this program in this order: CtNme, CtVal, and CtDesc.

DFkeys report tuple format

The following fields from the CtKeys table are used and appear as input to this program in this order: DFnme, DFval, and DFdesc.

DataKeys report tuple format

The following fields from the DataKeys table are used and appear as input to this program in this order: DtNme, DtVal, and DtDesc.

DevKeys report tuple format

The following fields from the DevKeys table are used and appear as input to this program in this order: DevTypeK, DevTypeV, and DevDesc.

DrvKeys report tuple format

The following fields from the DrvKeys table are used and appear as input to this program in this order: DrvNme, DrvVal, and DrvDesc.

IconKeys report tuple format

The following fields from the IconKeys table are used and appear as input to this program in this order: IconNme, IconVal, and IconDesc.

JkKeys report tuple format

The following fields from the JkKeys table are used and appear as input to this program in this order: JKtype, JKval, and JKdesc.

NPTkeys report tuple format

The following fields from the NPTkeys table are used and appear as input to this program in this order: NPTnme, NPTval, and Comments.

OwnKeys report tuple format

The following fields from the OwnKeys table are used and appear as input to this program in this order: OwnNme, OwnVal, and OwnDesc.

PgKeys report tuple format

The following fields from the PgKeys table are used and appear as input to this program in this order: PgNme, PgVal, and PgDesc.

RefKeys report tuple format

The following fields from the RefKeys table are used and appear as input to this program in this order: RefNme, RefVal, RefAttNme, and RefDesc.

ScaKeys report tuple format

The following fields from the ScaKeys table are used and appear as input to this program in this order: ScaNme, ScaVal, and Comments.

Examples


#
# produce some individual table reports
#
psql -d testdb -qt -f BusKeys.pqry | KEYreport BusKeys > BusKeys.lst
psql -d testdb -qt -f RefKeys.pqry | KEYreport RefKeys > RefKeys.lst

Notes

Some SQL queries will probably have output which requires the use of WStrim(8) to properly format the data for use by this program.

The QueKeys report is probably obsolete because the table probably obsolete and hasn’t been removed yet.

There may be some reports which can be had in other ways...

Yes, some of the field names in the database are less than consistent...

Manual page revision

$Id: KEYreport.8,v 1.0 1999/02/09 18:16:21 kitchen Exp $


Table of Contents