Skip to content

Commit

Permalink
Merge pull request #26 from gmantele/issue-16-udf-catalogue
Browse files Browse the repository at this point in the history
Add a note about the the UDF catalogue
  • Loading branch information
gmantele committed May 26, 2021
2 parents 59a423e + d6c3e86 commit b7849f5
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 1 deletion.
18 changes: 18 additions & 0 deletions ADQL.tex
Original file line number Diff line number Diff line change
Expand Up @@ -1475,6 +1475,18 @@ \subsubsection{Coordsys}
clients are advised to pass an empty string here. Future versions of this
specification may remove this parameter from the listed functions.

This coordinate system argument was originally intended to carry information on
a reference system or other coordinate system metadata. This was helpful in
order to deal with data specified in different coordinate systems while
performing geometric operations. It was up to the ADQL service to perform
the appropriate conversion to make these operations possible. Now this argument
is deprecated and will later be removed, the users should explicitly ask for
such conversion. If this behavior is desired, the ADQL implementers have to
allow it through User Defined Functions. Then, it is recommended to define them
as declared in the \CatalogueUDF.
% Catalogue of {ADQL} User Defined Functions - Endorsed Note 1.0+
% http://www.ivoa.net/documents/udf-catalogue/index.html

\subsubsection{Predicate functions}
\label{sec:functions.geom.predicate}

Expand Down Expand Up @@ -2455,6 +2467,12 @@ \subsubsection{Overview}
ivo_string_agg()
\end{verbatim}

In order to avoid different signatures for the same functions, it is recommended
that ADQL implementers follow as much as possible the User Defined Function
signatures listed in the \CatalogueUDF.
% Catalogue of {ADQL} User Defined Functions - Endorsed Note 1.0+
% http://www.ivoa.net/documents/udf-catalogue/index.html

%If metadata on a user defined function is available, this should be used. For
%example function names and cardinality of arguments should be checked against
%metadata where available.
Expand Down
2 changes: 2 additions & 0 deletions ivoa-cite.tex
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@
\newcommand{\STCSSpec} {\IvoaCite{stcsspec} {std:STCS} {STC-S specification}}
\newcommand{\ObsCoreSpec} {\IvoaCite{obscorespec} {2017ivoa.spec.0509L} {ObsCore specification}}

\newcommand{\CatalogueUDF} {\IvoaCite{udfcat} {2021ivoa.spec.0310C} {Catalogue of ADQL User Defined Functions}}

%
% Useful macros for referring to figures, sections and appendices in a consistent style.
\newcommand{\FigureRef}[1]{Figure \ref{#1}\xspace}
Expand Down
2 changes: 1 addition & 1 deletion ivoatex

0 comments on commit b7849f5

Please sign in to comment.