Next Previous Up Contents
Next: Examples
Up: taplint: Tests TAP services
Previous: taplint: Tests TAP services

B.21.1 Usage

The usage of taplint is

   stilts <stilts-flags> taplint
                                 stages=TMV|TME|TMS|TMC|CPV|CAP|AVV|QGE|QPO|QAS|UWS|MDQ|OBS|UPL|EXA[ ...]
                                 maxtable=<int-value> format=text|json
                                 report=[EWISF]+ maxrepeat=<int-value>
                                 truncate=<int-value> debug=true|false
                                 syncurl=<url-value> asyncurl=<url-value>
                                 tablesurl=<url-value>
                                 capabilitiesurl=<url-value>
                                 availabilityurl=<url-value>
                                 examplesurl=<url-value>
                                 [tapurl=]<url-value>
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. For programmatic invocation, the Task class for this command is uk.ac.starlink.ttools.task.TapLint.

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

asyncurl = <url-value>       (URL)
Sets the URL to use for the async endpoint of the TAP service. By default, this would be <tapurl>/async but you can set this parameter to some other location if required. If left blank, the default value is used.
availabilityurl = <url-value>       (URL)
Sets the URL to use for the availability endpoint of the TAP service. By default, this would be <tapurl>/availability but you can set this parameter to some other location if required. If left blank, the default value is used.
capabilitiesurl = <url-value>       (URL)
Sets the URL to use for the capabilities endpoint of the TAP service. By default, this would be <tapurl>/capabilities but you can set this parameter to some other location if required. If left blank, the default value is used.
debug = true|false       (Boolean)
If true, debugging output including stack traces will be output along with the normal validation messages.

[Default: false]

examplesurl = <url-value>       (URL)
Sets the URL to use for the examples endpoint of the TAP service. By default, this would be <tapurl>/examples but you can set this parameter to some other location if required. If left blank, the default value is used.
format = text|json       (OutputReporter)
Determines the format of the output. Possible values are text, json.

Note not all of the other parameters may be applicable to all output formats.

[Default: text]

maxrepeat = <int-value>       (Integer)
Puts a limit on the number of times that a single message will be repeated. By setting this to some reasonably small number, you can ensure that the output does not get cluttered up by millions of repetitions of essentially the same error.

[Default: 9]

maxtable = <int-value>       (Integer)
Limits the number of tables from the service that will be tested. Currently, this only affects stage MDQ. If the value is left blank (the default), or if it is larger than the number of tables actually present in the service, it will have no effect.
report = [EWISF]+       (String)
Letters indicating which message types should be listed. Each character of the string is one of the letters E, W, I, S, F with the following meanings:

[Default: EWISF]

stages = TMV|TME|TMS|TMC|CPV|CAP|AVV|QGE|QPO|QAS|UWS|MDQ|OBS|UPL|EXA[ ...]       (String[])
Lists the validation stages which the validator will perform. Each stage is represented by a short code, as follows: You can specify a list of stage codes, separated by spaces. Order is not significant.

Note that removing some stages may affect the operation of others; for instance table metadata is acquired from the metadata stages, and avoiding those will mean that later stages that use the table metadata to pose queries will not be able to do so with knowledge of the database schema.

[Default: TMV TME TMS TMC CPV CAP AVV QGE QPO QAS UWS MDQ OBS UPL EXA]

syncurl = <url-value>       (URL)
Sets the URL to use for the sync endpoint of the TAP service. By default, this would be <tapurl>/sync but you can set this parameter to some other location if required. If left blank, the default value is used.
tablesurl = <url-value>       (URL)
Sets the URL to use for the tables endpoint of the TAP service. By default, this would be <tapurl>/tables but you can set this parameter to some other location if required. If left blank, the default value is used.
tapurl = <url-value>       (URL)
The base URL of a Table Access Protocol service. This is the bare URL without a trailing "/[a]sync".

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 (syncurl, asyncurl, ...) are provided so that the different endpoints can be set individually if required.

truncate = <int-value>       (Integer)
Limits the line length written to the output.

[Default: 640]


Next Previous Up Contents
Next: Examples
Up: taplint: Tests TAP services
Previous: taplint: Tests TAP services

STILTS - Starlink Tables Infrastructure Library Tool Set
Starlink User Note256
STILTS web page: http://www.starlink.ac.uk/stilts/
Author email: m.b.taylor@bristol.ac.uk
Mailing list: topcat-user@jiscmail.ac.uk