/usr/share/doc/stilts/sun256/tapquery-usage.html is in stilts-doc 3.1.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 | <html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" type="text/css" href="sun-style.css">
<title>Usage</title>
</head>
<body>
<hr>
<a href="secB.21.2.html">Next</a> <a href="tapquery.html">Previous</a> <a href="tapquery.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.21.2.html">Examples</a><br>
<b>Up: </b><a href="tapquery.html">tapquery: Queries a Table Access Protocol server</a><br>
<b>Previous: </b><a href="tapquery.html">tapquery: Queries a Table Access Protocol server</a><br>
<hr>
<h3><a name="tapquery-usage">B.21.1 Usage</a></h3>
<p>The usage of <code>tapquery</code> is
<pre>
stilts <stilts-flags> tapquery nupload=<count> ufmtN=<in-format>
uploadN=<tableN> ucmdN=<cmds> ocmd=<cmds>
omode=out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui
out=<out-table> ofmt=<out-format>
upnameN=<adql-identifier> tapurl=<url-value>
adql=<query-text> parse=true|false
sync=true|false maxrec=<nrow>
destruction=<iso8601>
executionduration=<seconds>
compress=true|false
upvotformat=TABLEDATA|BINARY|BINARY2
language=<lang-name> poll=<millisec>
progress=true|false
delete=finished|never|always
</pre>
If you don't have the <code>stilts</code> script installed,
write "<code>java -jar stilts.jar</code>" instead of
"<code>stilts</code>" - see <a href="invoke.html">Section 3</a>.
The available <code><stilts-flags></code> are listed
in <a href="stilts-flags.html">Section 2.1</a>.
For programmatic invocation, the Task class for this
command is <code>uk.ac.starlink.ttools.task.TapQuerier</code>.
</p>
<p>Parameter values are assigned on the command line
as explained in <a href="task-args.html">Section 2.3</a>.
They are as follows:
</p>
<p>
<dl>
<dt><strong><code>adql = <query-text></code> <em>(String)</em></strong></dt>
<dd>Astronomical Data Query Language string specifying the
TAP query to execute.
ADQL/S resembles SQL, so this string will likely start with
"SELECT".
</dd>
<dt><strong><code>compress = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If true, the service is requested to provide HTTP-level
compression for the response stream
(Accept-Encoding header is set to "<code>gzip</code>",
see RFC 2616).
This does not guarantee that compression will happen
but if the service honours this request it may result in
a smaller amount of network traffic
at the expense of more processing on the server and client.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>delete = finished|never|always</code> <em>(DeleteMode)</em></strong></dt>
<dd>Determines under what circumstances the UWS job is to be
deleted from the server when its data is no longer required.
If it is not deleted, then the job is left on the TAP server
and it can be accessed via the normal UWS REST endpoints
until it is destroyed by the server.
<p>Possible values:
<ul>
<li><code>finished</code>: delete only if the job finished, successfully or not
</li>
<li><code>never</code>: do not delete
</li>
<li><code>always</code>: delete in any case
</li>
</ul>
</p>
<p>[Default: <code>finished</code>]
</p>
</dd>
<dt><strong><code>destruction = <iso8601></code> <em>(String)</em></strong></dt>
<dd>Posts an updated value of the UWS DESTRUCTION parameter
to the query job before it starts.
This only makes sense for asynchronous jobs
(<code>sync</code>=false).
<p>The supplied value should be an ISO-8601-like string,
giving the new requested job destruction time.
The service is not obliged to honour this request.
See <a href="http://www.ivoa.net/documents/UWS/20101010/">UWS v1.0</a>, sec 2.2.3.3.
</p>
</dd>
<dt><strong><code>executionduration = <seconds></code> <em>(Long)</em></strong></dt>
<dd>Posts an updated value of the UWS EXECUTIONDURATION parameter
to the query job before it starts.
This only makes sense for asynchronous jobs
(<code>sync</code>=false).
<p>The supplied value is an integer giving the maximum number
of wall-clock seconds for which the job is permitted to
execute before being forcibly terminated.
A value of zero indicates unlimited duration.
The service is not obliged to honour this request.
See <a href="http://www.ivoa.net/documents/UWS/20101010/">UWS v1.0</a>, sec 2.2.3.4.
</p>
</dd>
<dt><strong><code>language = <lang-name></code> <em>(String)</em></strong></dt>
<dd>Language to use for the ADQL-like query.
This will usually be "ADQL" (the default),
but may be set to some other value supported by the service,
for instance a variant indicating a different ADQL version.
Note that at present, setting it to "PQL" is not sufficient
to submit a PQL query.
<p>[Default: <code>ADQL</code>]
</p>
</dd>
<dt><strong><code>maxrec = <nrow></code> <em>(Long)</em></strong></dt>
<dd>Sets the requested maximum row count for the result of
the query.
The service is not obliged to respect this, but in the case
that it has a default maximum record count, setting this value
may raise the limit.
If no value is set, the service's default policy will be used.
</dd>
<dt><strong><code>nupload = <count></code> <em>(Integer)</em></strong></dt>
<dd>The number of upload tables for this task.
For each of the upload tables N
there will be associated parameters
<code>ufmtN</code>, <code>uploadN</code> and <code>ucmdN</code>.
<p>[Default: <code>0</code>]
</p>
</dd>
<dt><strong><code>ocmd = <cmds></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/filter/ProcessingStep.html">ProcessingStep[]</a>)</em></strong></dt>
<dd>Specifies processing to be performed 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 <a href="filterSteps.html">Section 6.1</a>.
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.
<p>Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "<code>@filename</code>"
causes the file <code>filename</code> 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.
</p>
</dd>
<dt><strong><code>ofmt = <out-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format in which the output table will be written
(one of the ones in <a href="outFormats.html">Section 5.2.2</a> - matching is
case-insensitive and you can use just the first few letters).
If it has the special value
"<code>(auto)</code>"
(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.
<p>This parameter must only be given if
<code>omode</code>
has its default value of "<code>out</code>".
</p>
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>omode = out|meta|stats|count|cgi|discard|topcat|samp|tosql|gui</code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/mode/ProcessingMode.html">ProcessingMode</a>)</em></strong></dt>
<dd>The mode in which the result table will be output.
The default mode is <code>out</code>, which means that
the result will be written as a new table to disk or elsewhere,
as determined by the <code>out</code> and <code>ofmt</code>
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
(<code><mode-args></code>)
are required to determine the exact behaviour.
<p>Possible values are
<ul>
<li><code>out</code></li>
<li><code>meta</code></li>
<li><code>stats</code></li>
<li><code>count</code></li>
<li><code>cgi</code></li>
<li><code>discard</code></li>
<li><code>topcat</code></li>
<li><code>samp</code></li>
<li><code>tosql</code></li>
<li><code>gui</code></li>
</ul>
Use the <code>help=omode</code> flag
or see <a href="outModes.html">Section 6.4</a> for more information.
</p>
<p>[Default: <code>out</code>]
</p>
</dd>
<dt><strong><code>out = <out-table></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/TableConsumer.html">TableConsumer</a>)</em></strong></dt>
<dd>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.
<p>This parameter must only be given if
<code>omode</code>
has its default value of "<code>out</code>".
</p>
<p>[Default: <code>-</code>]
</p>
</dd>
<dt><strong><code>parse = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether an attempt will be made to check
the syntax of the ADQL prior to submitting the query.
If this is set true, and if a syntax error is found,
the task will fail with an error before any attempt is made
to submit the query.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>poll = <millisec></code> <em>(Integer)</em></strong></dt>
<dd>Interval to wait between polling attempts, in milliseconds.
Asynchronous TAP queries can only find out when they are
complete by repeatedly polling the server to find out the
job's status. This parameter allows you to set how often
that happens.
Attempts to set it too low (<50)
will be rejected on the assumption that you're thinking in
seconds.
<p>[Default: <code>5000</code>]
</p>
</dd>
<dt><strong><code>progress = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>If this parameter is set true, progress of the job is
reported to standard output as it happens.
<p>[Default: <code>true</code>]
</p>
</dd>
<dt><strong><code>sync = true|false</code> <em>(Boolean)</em></strong></dt>
<dd>Determines whether the TAP query is submitted in synchronous
or asynchronous mode.
Synchronous (<code>true</code>)
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 (<code>false</code>)
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
<a href="tapresume.html"><code>tapresume</code></a>
to pick it up for you later instead.
In most cases <code>false</code> (the default) is preferred.
<p>[Default: <code>false</code>]
</p>
</dd>
<dt><strong><code>tapurl = <url-value></code> <em>(<a href="http://docs.oracle.com/javase/6/docs/api/java/net/URL.html">URL</a>)</em></strong></dt>
<dd>The base URL of a Table Access Protocol service.
This is the bare URL without a trailing "/[a]sync".
<p>The default values of the various endpoints
(sync and async query submission, tables metadata,
service-provided examples etc)
use this URL as a parent
and append standard sub-paths.
However, other parameters (<code>syncurl</code>, <code>asyncurl</code>, ...)
are provided so that the different endpoints
can be set individually if required.
</p>
</dd>
<dt><strong><code>ucmdN = <cmds></code> <em>(<a href="http://andromeda.star.bris.ac.uk/starjavadocs/uk/ac/starlink/ttools/filter/ProcessingStep.html">ProcessingStep[]</a>)</em></strong></dt>
<dd>Specifies processing to be performed on
upload table #N as specified by parameter <code>uploadN</code>,
before any other processing has taken place.
The value of this parameter is one or more of the filter
commands described in <a href="filterSteps.html">Section 6.1</a>.
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.
<p>Commands may alteratively be supplied in an external file,
by using the indirection character '@'.
Thus a value of "<code>@filename</code>"
causes the file <code>filename</code> 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.
</p>
</dd>
<dt><strong><code>ufmtN = <in-format></code> <em>(String)</em></strong></dt>
<dd>Specifies the format of upload table #N as specified by parameter <code>uploadN</code>.
The known formats are listed in <a href="inFormats.html">Section 5.2.1</a>.
This flag can be used if you know what format your
table is in.
If it has the special value
<code>(auto)</code> (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.
<p>[Default: <code>(auto)</code>]
</p>
</dd>
<dt><strong><code>uploadN = <tableN></code> <em>(<a href="http://www.starlink.ac.uk/stil/javadocs/uk/ac/starlink/table/StarTable.html">StarTable</a>)</em></strong></dt>
<dd>The location of upload table #N.
This may take one of the following forms:
<ul>
<li>A filename.</li>
<li>A URL.</li>
<li>The special value "<code>-</code>",
meaning standard input.
In this case the input format must be given explicitly
using the <code>ufmtN</code>
parameter.
Note that not all formats can be streamed in this way.
</li>
<li>A system command line with
either a "<code><</code>" character at the start,
or a "<code>|</code>" character at the end
("<code><syscmd</code>" or
"<code>syscmd|</code>").
This executes the given pipeline and reads from its
standard output.
This will probably only work on unix-like systems.
</li>
</ul>
In any case, compressed data in one of the supported compression
formats (gzip, Unix compress or bzip2) will be decompressed
transparently.
</dd>
<dt><strong><code>upnameN = <adql-identifier></code> <em>(String)</em></strong></dt>
<dd>Identifier to use in server-side expressions for uploaded
table #N.
In ADQL expressions, the table should be referred to as
"<code>TAP_UPLOAD.<label></code>".
<p>The value must syntactically be an ADQL identifier
(<code>[A-Za-z][A-Za-z0-9_]*</code>).
</p>
<p>[Default: <code>upN</code>]
</p>
</dd>
<dt><strong><code>upvotformat = TABLEDATA|BINARY|BINARY2</code> <em>(uk.ac.starlink.votable.VOTableWriter)</em></strong></dt>
<dd>Determines how any uploaded tables will be serialized
for transmission to the TAP server.
The supplied string is the name of one of the defined
VOTable serialization formats.
The choice shouldn't affect any results, though it may affect
required bandwidth, and some services may (though should not)
have non-standard requirements for serialization format.
<p>[Default: <code>TABLEDATA</code>]
</p>
</dd>
</dl>
</p>
<hr><a href="secB.21.2.html">Next</a> <a href="tapquery.html">Previous</a> <a href="tapquery.html">Up</a> <a href="index.html">Contents</a> <br> <b>Next: </b><a href="secB.21.2.html">Examples</a><br>
<b>Up: </b><a href="tapquery.html">tapquery: Queries a Table Access Protocol server</a><br>
<b>Previous: </b><a href="tapquery.html">tapquery: Queries a Table Access Protocol server</a><br>
<hr><i>STILTS - Starlink Tables Infrastructure Library Tool Set<br>Starlink User Note256<br>STILTS web page:
<a href="http://www.starlink.ac.uk/stilts/">http://www.starlink.ac.uk/stilts/</a><br>Author email:
<a href="mailto:m.b.taylor@bristol.ac.uk">m.b.taylor@bristol.ac.uk</a><br>Mailing list:
<a href="mailto:topcat-user@jiscmail.ac.uk">topcat-user@jiscmail.ac.uk</a><br></i></body>
</html>
|