Next Previous Up Contents
Next: Examples
Up: regquery: Registry Querier
Previous: regquery: Registry Querier

A.3.1 Usage

The usage of regquery is

   stilts <stilts-flags> regquery query=<value> regurl=<value> ocmd=<cmds>
                                  omode=<out-mode> <mode-args> out=<out-table>
                                  ofmt=<out-format>

If you don't have the stilts script installed, write "java -jar stilts.jar" instead of "stilts" - see Section 3. The available <stilts-flags> are listed in Section 2.1.

Parameter values are assigned on the command line as explained in Section 2.3. They are as follows:

ocmd = <cmds>
Commands to operate on the output table, after all other processing has taken place. The value of this parameter is one or more of the filter commands described in Section 5.1. If more than one is given, they must be separated by semicolon characters (";"). This parameter can be repeated multiple times on the same command line to build up a list of processing steps. The sequence of commands given in this way defines the processing pipeline which is performed on the table.
ofmt = <out-format>
Specifies the format in which the output table will be written (one of the ones in Section 4.2 - matching is case-insensitive and you can use just the first few letters). If it has the special value "(auto)" (the default), then the output filename will be examined to try to guess what sort of file is required usually by looking at the extension. If it's not obvious from the filename what output format is intended, an error will result. This parameter must only be given if omode has its default value of "out". [Default: (auto)]
omode = <out-mode> <mode-args>
The mode in which the result table will be output. The default mode is out, which means that the result will be written as a new table to disk or elsewhere, as determined by the out and ofmt parameters. However, there are other possibilities, which correspond to uses to which a table can be put other than outputting it, such as displaying metadata, calculating statistics, or populating a table in an SQL database. For some values of this parameter, additional parameters (<mode-args>) are required to determine the exact behaviour. Possible values are out, meta, stats, count, cgi, discard, topcat, plastic and tosql. Use the help=omode flag or see Section 5.4 for more information. [Default: out]
out = <out-table>
The location of the output table. This is usually a filename to write to. If it is equal to the special value "-" (the default) the output table will be written to standard output. This parameter must only be given if omode has its default value of "out". [Default: -]
query = <value>
Text of an SQL WHERE clause defining which resource records you wish to retrieve from the registry. Some examples are: The special value "ALL" will attempt to retrieve all the records in the registry (though this is not necessarily a sensible thing to do). A full description of SQL syntax is beyond the scope of this documentation, but in general you want to use <field-name> like '<value> where '%' is a wildcard character. Logical operators and and or and parentheses can be used to group and combine expressions. You can find the various <field-name>s by executing one of the queries above and looking at the column names in the returned table.
regurl = <value>
The URL of a SOAP endpoint which provides suitable registry query services. [Default: http://voservices.net/registry/registry.asmx]


Next Previous Up Contents
Next: Examples
Up: regquery: Registry Querier
Previous: regquery: Registry Querier

STILTS - Starlink Tables Infrastructure Library Tool Set
Starlink User Note 256
STILTS web page: http://www.starlink.ac.uk/stilts/
Author email: m.b.taylor@bristol.ac.uk