![]() |
ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }
Which is in the format of a Tcl command, ldasJob, with two required arguments:
Returns information on database schema such as names of table columns, keys, column data types.
Calling convention (all on a single line):
ldasJob { -name "username" -password "********" -email "user@foobar.edu"} {descMetaData -returnprotocol URL -returnformat ilwd LIGO_LW -table { Tcl list } -column { Tcl list } -type { Tcl list } -key { Tcl list } -database dsname }
Option Descriptions:
-returnprotocol:
http ftp file port
NOTE: Embedded spaces in the argument to the -returnprotocol
option will cause the request to fail.
-returnformat: ilwd LIGO_LW
-table: all tabname
The table option returns the column names of the specified table or
of all tables; this option is overrided by either the
-key option or
-type option
if their option argument is not none.
-column: all none colname
The argument of the -column option can be one of:
The column option is used when requesting the data attributes of
columns in tables; all returns data attributes of all columns
of table specified in -table option; if a column name
is specified, the data attributes for that column is returned.
This option must be none when using the
-key option or
-type option
-type: all none
The type option returns the data attributes of column or
all columns as specified in the
-column option
belonging to the table specified in the
-table option.
-key: none primary foreign
The key option returns the primary or foreign key for
table specified in
-table option.
The -column option
must be set to none since it is not used with this option.
If none is specified, the -key option is not
used.
The returnprotocol specifies the destination that
the result of the command should be delivered to.
The argument to the -returnprotocol option conforms
to the usual browser conventions for URL's for determining
the location of the results of the user request.
The http, ftp, and file options
cause a URL pointer to the location of the results to be
returned by e-mail.
The possible formats of the argument are:
The argument of the -returnformat option is the
name of the data type to use in formatting the result
of the user request.
The possible output formats currently supported by the system
are ilwd text,
and LIGO_LW (an XML format).
The argument of the -table option can be one of:
The argument of the -type option can be one of:
The argument of the -key option can be one of:
The argument of -database option is a valid database dataset name for the site that the command applies e.g. cit_1 and cit_test are dataset names for site ldas-dev, lho_1 and lho_test are dataset names for site ldas-wa etc. For dsnames of sites, please visit the LDAS database link on each ldas site web page. If this option is not specified, insertion is done from the default database.
Examples of descMetaData command:
Note that there is a maximum row limit (configurable in resource file) imposed on retrieving the results so if the result set exceeds this limit, the set is truncated in the output. There will be an indication in the email reply to the user if the full set of results gets truncated.