STILTS-TAPRESUME(1)

📦
version 3.5.4 · 5 versions
, in ubuntu stonking

💖 STILTS-TAPRESUME(1) 💖

okay bestie, welcome to the Stilts commands corner of the manual, this one's all about stilts-tapresume ✨

✨ NAME ✨

stilts-tapresume — resumes a previous query to a Table Access Protocol server 🫶

🌸 SYNOPSIS 🌸

stilts tapresume [joburl=<url-value>] [compress=true|false]
                 [poll=<millisec>] [progress=true|false]
                 [delete=finished|never|always|now] [ocmd=<cmds>]
                 [omode=out|meta|stats|count|checksum|cgi|discard|topcat|samp|tosql|gui]
                 [out=<out-table>] [ofmt=<out-format>]

👑 DESCRIPTION 👑

so like, tapresume can resume monitoring and data retrieval from an asynchronous Table Access Protocol query that's already been submitted. TAP is a Virtual Observatory protocol, iykyk 🔭

and the way that this works is that the pre-existing query might have been submitted by the tapquery command, or honestly by some completely different mechanism, no judgement 💅 Either way it essentially does the same job as tapquery but without the job submission stage. It waits until the query has completed, then retrieves the table result and processes it in accordance with the supplied parameters. And the query may or may not be deleted from the server as part of the operation — that's a whole thing we'll get to. 🌈

💅 OPTIONS 💅

  • joburl=<url-value> — the URL of a job created by submission of a TAP query which was created earlier and has not yet been deleted (by the client) or destroyed (by the server). This will usually be of the form <tap-url>/async/<job-id>. Fun fact bestie: you can also find out, and possibly retrieve results from the job, by pointing a web browser at this URL. iconic. 🦋
  • compress=true|false — if it's true, the service is requested to provide HTTP-level compression for the response stream (the Accept-Encoding header is set to "gzip", see RFC 2616). Not gonna lie, 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. tradeoffs, periodt. ✨
  • poll=<millisec> — the interval to wait between polling attempts, in milliseconds. Asynchronous TAP queries can only find out when they're complete by repeatedly polling the server to find out the job's status, which is giving very much "are we there yet" energy 😭 This parameter lets you set how often that happens. Attempts to set it too low (<50) will be rejected on the assumption that you're thinking in seconds. so embarrassing, don't do it. 💀
  • progress=true|false — if this parameter is set true, updates on the status of the asynchronous UWS job are reported to standard output as they become available. Heads up tho: this parameter is ignored in synchronous mode. 🙈
  • delete=finished|never|always|now — determines under what circumstances the UWS job is to be deleted from the server when its data is no longer required. If it's not deleted, then the job is left on the TAP server and it can be accessed via the normal UWS REST endpoints or using tapresume until it is destroyed by the server. so like, it just chills there. 👑

Possible values:

  • finished: delete only if the job finished, successfully or not
  • never: do not delete
  • always: delete on command exit
  • now: delete and return immediately
  • ocmd=<cmds> — 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 SUN/256. 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 — and the sequence of commands given in this way defines the processing pipeline which is performed on the table. stack it up bestie 🧚

Commands may alternatively 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, and lines which are blank or which start with a '#' character are ignored. A backslash character '\fR' at the end of a line joins it with the following line.

  • omode=out|meta|stats|count|checksum|cgi|discard|topcat|samp|tosql|gui — 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. But 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. no cap. ⭐

Possible values are

  • out
  • meta
  • stats
  • count
  • checksum
  • cgi
  • discard
  • topcat
  • samp
  • tosql
  • gui

Use the help=omode flag or see SUN/256 for more information. 🌸

  • 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".

  • ofmt=<out-format> — specifies the format in which the output table will be written (one of the ones in SUN/256 — 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. And 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".

🎀 SEE ALSO 🎀

If the package stilts-doc is installed, the full documentation SUN/256 is available in HTML format: file:///usr/share/doc/stilts/sun256/index.html

💜 VERSION 💜

STILTS version 3.5.4-debian

This is the Debian version of Stilts, which lack the support of some file formats and network protocols. For differences see file:///usr/share/doc/stilts/README.Debian

ngl bestie, some file formats and network protocols are just not supported in this Debian build, that's the vibe. check that README for the deets. 🫶

🌟 AUTHOR 🌟

Mark Taylor (Bristol University)

okay that's the whole thing, you ate it, I'm obsessed 💖 that was the Stilts commands manual, STILTS-TAPRESUME(1), dated Mar 2017, page footer and all. go poll something. 💅✨

📦 where this page comes from