The usage of tapquery
is
stilts <stilts-flags> tapquery nupload=<count> ufmtN=<in-format> uploadN=<tableN> ucmdN=<cmds> ocmd=<cmds> omode=<out-mode> <mode-args> out=<out-table> ofmt=<out-format> upnameN=<label> tapurl=<url-value> adql=<value> parse=true|false sync=true|false maxrec=<value> language=<value> poll=<int-value> progress=true|false delete=finished|never|alwaysIf 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:
adql = <value>
delete = finished|never|always
Possible values:
finished
: delete only if the job finished, successfully or notnever
: do not deletealways
: delete in any case[Default: finished
]
language = <value>
[Default: ADQL
]
maxrec = <value>
nupload = <count>
ufmtN
, uploadN
and ucmdN
.
[Default: 0
]
ocmd = <cmds>
The value of this parameter is one or more of the filter commands described in Section 6.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.
Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "@filename
"
causes the file filename
to be read for a list
of filter commands to execute. The commands in the file
may be separated by newline characters and/or semicolons.
ofmt = <out-format>
(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>
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
samp
plastic
tosql
help=omode
flag
or see Section 6.4 for more information.
[Default: out
]
out = <out-table>
This parameter must only be given if
omode
has its default value of "out
".
[Default: -
]
parse = true|false
[Default: false
]
poll = <int-value>
[Default: 5000
]
progress = true|false
[Default: true
]
sync = true|false
true
)
means that the result is retrieved over the same HTTP connection
that the query is submitted from.
This is uncomplicated, but means if the query takes a long time
it may time out and the results will be lost.
Asynchronous (false
)
means that the job is queued and results may be retrieved later.
Normally this command does the necessary waiting around and
recovery of the result, though with appropriate settings
you can get
tapresume
to pick it up for you later instead.
In most cases false
(the default) is preferred.
[Default: false
]
tapurl = <url-value>
ucmdN = <cmds>
The value of this parameter is one or more of the filter commands described in Section 6.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.
Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "@filename
"
causes the file filename
to be read for a list
of filter commands to execute. The commands in the file
may be separated by newline characters and/or semicolons.
ufmtN = <in-format>
(auto)
(the default),
then an attempt will be
made to detect the format of the table automatically.
This cannot always be done correctly however, in which case
the program will exit with an error explaining which
formats were attempted.
[Default: (auto)
]
uploadN = <tableN>
ufmtN
parameter.
upnameN = <label>
TAP_UPLOAD.<label>
".
[Default: upN
]