DEOS Data and Database Maintenance Component Operations Guide

DEOS Technical Note #11

Dr. Geoffrey E. Quelch

Research Fellow,
University of Delaware,
Center for Climatic Research


   University of Delaware
   NewarkDE 19716
   
  

Version 2

All material herein is copyright by the Delaware Environmental Observing System

Published: June 9th 2005

Revision History
Revision 1.12005/06/08GEQ
Initial version
Revision 1.22005/12/01GEQ
Added option to check pointers to field data files.
Revision 2.12006/09/26GEQ
Incremented version number of this document to 2.

Abstract

This technical note describes the DEOS maintain program, and the options for its use.


Table of Contents

Introduction
Running the Program
Command Line Options
User Option
Password Option
Database Option
Network Name Option
Check Radar File List Option
Check Field Data File List Option
Print Data Summary Option
Print Bad Network Data Option
Verbose Option
Help Option
Database Parameters
Networks
Operational Use

Introduction

The DEOS maintain program provides the functionality to report on, check and delete as requested data and database information in the current installation.

Running the Program

The program is executed by the command maintain from the command line.

maintain { -u user-name | --user user-name } { -p password | --password password } { -d database | --database database } [--check-radar-file-list] [--check-field-file-list] [--print-data-summary] [--print-bad-network-data] [ -n network-name | --network-name network-name ] [ -v value | --verbose value ] [ -h | --help ]

Command Line Options

The ingest program uses database configuration parameters to determine details of what to do with the various data streams it is presented.

User Option

The specification for the user option is:

{ -u username | --user username | --user=username }

This option will allow the program to connect to the database using the username provided. The user must already exist, and have sufficient permissions to access the database specified. This item is required.

Password Option

The specification for the password option is:

{ -p password | --password password | --password=password }

This option in combination with the username allows the program to connect to the database using the username provided. This item is required.

Database Option

The specification for the database option is:

{ -d database | --database database | --database=database }

This option will specify which database the program should use as a source of data, configuration items and a destination for any event logging items. This item is required.

Network Name Option

The specification for the network name option is:

[ -n name | --network-name name | --network-name=name ]

This option specifies the network name and is optional.

Check Radar File List Option

The specification for the check radar file list option is:

[--check-radar-file-list]

This option requests that the program check file pointers stored in the database actually point to the files indicated. Since the DPA data itself isn't stored, the data must be available from the original files.

Check Field Data File List Option

The specification for the check field data file list option is:

[--check-field-file-list]

This option requests that the program check file pointers stored in the database actually point to the files indicated.

Print Data Summary Option

The specification for the print data summary option is:

[--print-data-summary]

This option requests that the program retrieve and print out a the number of data items stored for each of the data types.

Print Bad Network Data Option

The specification for the print bad network data option is:

[--print-bad-network-data]

This option requests that the program print all data items for all stations in the in-use networks that are older then the configured threshold. If the network name option is provided to the program, this option only prints out data for that network. If no network name is provided, all in use networks are processed.

Verbose Option

The specification for the verbose option is:

[ -v value | --verbose value ]

The value provided for the verbose setting (a digit between 0 and 5) indicates how much output is generated, 0 being minimal and 5 being extremely verbose. Positive values of setting send data to the ELF, negative value also print the message to the screen. If no value is provided, the setting is assumed to be 1.

Help Option

The specification for the help option is:

[ -h | --help ]

This option prints a summary of all the command line options and exits.

Database Parameters

The following database tables provide configuration options for the ingest program.

Networks

This table contains data for the network associated with the specifiednetwork, such as network name and threshold parameters.

Operational Use

For operational use, it is expected that the maintain program be run from inside a UNIX cron system, and to be run at an appropriate time interval.