ADQL function names

The ADQL standard itself does not impose any restrictions on the names that may be used for user defined functions.

To avoid name collisions when solving common problems, we should prefix user defined functions with an acronym that represents the institute, department or archive where the function originates.

If the Wide Field Astronomy Unit (WFAU) prefix user defined functions with wfau:

    wfau_align()
    wfau_convert()

If the German Astrophysical Virtual Observatory (GAVO) adopted a similar naming convention:

    gavo_align()
    gavo_convert()

This would enable the VO to support different implementations of similar functions without conflicts:

    wfau_align()
    gavo_align()

    wfau_convert()
    gavo_convert()

Note that the prefix indicates the origin of the function implementation, not the identity of the TAP service providing the function. If another TAP service uses one of the WFAU function implementations, the function name should keep the wfau prefix to indicate the origin of the implementation.

    wfau_align()

If one of the GAVO functions is adopted as part of an IVOA standard, then we could use the ivo prefix to indicate that it is an IVOA standard function.

    ivo_align()

For backwards compatibility, a TAP services could provide the same function using different names:

    gavo_align()  -- original GAVO version
    ivo_align()   -- IVOA standard version

The same TAP service could also provide the WFAU implementation of the align() function:

    gavo_align()  -- original GAVO version
    wfau_align()  -- alternative WFAU version
    ivo_align()  -- IVOA standard  version

The following table acts as an informal registry of function prefix names.

prefix name link
ivo IVOA standard functions http://ivoa.net/
wfau Wide Field Astronomy Unit, Institute for Astronomy, University of Edinburgh http://www.roe.ac.uk/ifa/wfau/
gavo German Astrophysical Virtual Observatory http://www.g-vo.org/pmwiki/

If you would like to to participate, please add your prefix to the table.

If you are adding new user defined functions to your TAP services, consider adding a prefix to the function name to indicate where the function comes from.

If you already have user define functions in your TAP services, introduce alternative names for them with an appropriate prefix and gradually encourage your users to use the prefixed names.


Edit | Attach | Print version | History: r5 | r4 < r3 < r2 < r1 | Backlinks | Raw View | Raw edit | More topic actions...
Topic revision: r1 - 2017-04-12 - DaveMorris
 
This site is powered by the TWiki collaboration platformCopyright © 2008-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback