LIGO.gif

The descData User Commands (Meta Macros)

All user commands have the form:

ldasJob { -name {} -password {} -email {} } { userCmd -opt1 {} ... }

Which is in the format of a Tcl command, ldasJob, with two required arguments:

  1. A Tcl list of user information consisting of username, password, and e-mail address. All fields must be filled or the command will be rejected.
  2. A user command in the form of a Tcl list, for which there exists a "meta" macro file which can be expanded into Tcl code which can then be evaluated by the LDAS system.
    An argument must be provided to every option field for any given command or the command will be rejected.
    Some option fields will accept a "null" argument consisting of a matching pair of braces "{}" with no interposed space.
    Meta macros consist of a prototype declaration of the arguments for the given user command, and a template describing the calling order of API specific blocks of Tcl code which are concatenated into a larger block comprising the complete request, which can then be distributed by the assistant manager for interpretation by the low level API's.
    These API specific blocks are maintained as API specific macro files consisting of immediately interpretable Tcl code.
The only descData command we have now is used to retrieve database schema information via the metadata API:

descMetaData arrow_right.gif


Examples of descMetaData command:

  • for LDAS registered user foo to request column names from all database tables in ilwd format and have the results delivered via user foo's email, submit:

    ldasJob   { -name   "foo"   -password   "********"   -email   "foo@foobar.edu"}   {descMetaData   -returnprotocol   "foo@foobar.edu"   -returnformat   ilwd   -table   all   -column   none   -type   none   -key   none   }

    Result in ilwd

  • for LDAS registered user foo to request data attributes from ringdown table, have the results output in Ligo LW format and delivered to user foo's email, submit:

    ldasJob   { -name   "foo"   -password   "********"   -email   "foo@foobar.edu"}   {descMetaData   -returnprotocol   "foo@foobar.edu"   -returnformat   LIGO_LW   -table   ringdown   -column   none   -type   all   -key   none   }

    Result in LIGO_LW

  • for LDAS registered user foo to request primary keys from statistics tables in ilwd format and have the results delivered via user foo's email, submit:

    ldasJob   { -name   "foo"   -password   "********"   -email   "foo@foobar.edu"}   {descMetaData   -returnprotocol   "foo@foobar.edu"   -returnformat   ilwd   -table   statistics   -column   none   -type   none   -key   primary   }

    Result in ilwd

  • for LDAS registered user foo to request primary keys from statistics tables in ilwd format from database cit_1 instead of default database and have the results delivered via user foo's email, submit:

    ldasJob   { -name   "foo"   -password   "********"   -email   "foo@foobar.edu"}   {descMetaData   -returnprotocol   "foo@foobar.edu"   -returnformat   ilwd   -table   statistics   -column   none   -type   none   -key   primary   -database   cit_1   }

    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.

    arrow_up.gif Back to Top arrow_up.gif