Version 2
Copyright © 2004-2012 Delaware Environmental Observing System
Published: August 20th 2004
| Revision History | ||
|---|---|---|
| Revision 1.1 | 2004/08/20 | GEQ |
| Initial version | ||
| Revision 1.2 | 2004/09/09 | GEQ |
| Added the offset option. | ||
| Revision 1.3 | 2004/11/19 | GEQ |
| Added the sheffilename option. | ||
| Revision 1.4 | 2005/03/25 | GEQ |
| Major revision to the command line arguments, removed those beginning "SHEF". | ||
| Revision 1.5 | 2006/07/13 | GEQ |
| Corrected description of program and other errors. | ||
| Revision 2.1 | 2006/09/26 | GEQ |
| Incremented version number of this document to 2. | ||
Abstract
This technical note describes the DEOS shefout program, and the options for its use.
Table of Contents
The DEOS shefout function provides the capability to extract data from the database for a specified time period, create a SHEF format file and transfer it to a designated recipient host.
The program is executed by the command shefout from the command line.
shefout { -u user-name | --user user-name } { -p password | --password password } { -d database | --database database } { -s stream | --stream-name stream } [ -t timestring | --time timestring ] [ -o value | --offset value ] [ -r value | --range value ] [ -v value | --verbosevalue ] [ -h | --help ]
The shefout program uses database configuration parameters to determine the data streams recipient data.
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.
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.
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.
The specification for the stream option is:
{ -s stream name | --stream stream name | --stream=stream name }
This option specifies the stream name for retrieval. This is a required argument.
The specification for the time option is:
[ -t timestring | --time timestring | --time=timestring ]
This option specifies a timestamp for data extraction to begin. The time string format can be either YYYYMMDDHHMMSS or YYYY-MM-DD HH:MM:SS. If the latter is used, the string must be placed in quotes.
The specification for the offset option is:
[ -o value | --offset value | --offset=value ]
This option specifies the time interval by which the entered date will be corrected. The value is assumed to be in minutes. Positive values are assumed to point the date to earlier times. This option is intended to be used for real-time use as in a cron.
The specification for the range option is:
[ -r value | --range value | --range=value ]
This option specifies the time interval over which a process is to be performed. The value is assumed to be in minutes. Default is 60.
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.
The following database tables provide configuration options for the shefout program.