Documentation

Documentation Protocol d'accès aux Tables (TAP)

Protocol d'accès aux Tables (TAP)

Le CCDA permet de lancer une requête sur nos bases de données au moyen de TAP-1.0. Avec ce service, vous pouvez interroger les bases de données au moyen de HTTP et récupérer les réponses en formats CSV, TSV ou VOTable. Le client TOPCAT est un excellent outil pour interagir avec le service TAP.

Exemple

Pour interroger toutes les observations qui coupent un cercle et qui sont calibrées ou qui tiennent lieu de produits avancés, exécutez une requête au moyen de l'adresse URL suivante: http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/tap/sync?

http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/tap/sync?REQUEST=doQuery&LANG=ADQL&QUERY=SELECT * FROM caom2.Observation AS o JOIN caom2.Plane AS p ON o.obsID=p.obsID WHERE INTERSECTS(p.position_bounds, CIRCLE('ICRS', 180, 5, 2)) = 1 AND p.calibrationLevel >= 1

Cliquez ci-dessous sur le lien pour exécuter la requête et télécharger les résultats vers votre navigateur.

L'onglet ADQL de la page Recherche avancée du CCDA affiche l'ADQL exact qui a servi lors de votre requête. Examinez l'onglet ADQL pour vous familiariser avec les tableaux de la base de données CAOM-2.0 du CCDA.

Téléchargement de données

Le tableau caom2.Plane comporte une colonne planeURI. Cette adresse URI peut servir à télécharger les fichiers propres au plan au moyen d'une adresse URL respectant le format suivant: http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/caom2obs/auth-pkg?ID=${planeURI} , où ${planeURI} désigne la valeur tirée de la colonne planeURI obtenue à la suite de la requête. Veuillez noter que certaines données sont exclusives; si vous tentez d'utiliser la colonne planeURI pour obtenir des données exclusives, le système vous invite à vous authentifier.

Exemple

Ci-dessous figure un script BASH qui permet le téléchargement de toutes les observations liées à la proposition (proposal_id) 13BF10.

#!/bin/bash
export proposal_id=13BF10
export tap_url=http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/tap/auth-sync
export download_url=http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/AdvancedSearch/package
export USERNAME=john_doe
export PASSWORD=secret
export REQUEST=doQuery
export LANG=ADQL
export FORMAT=CSV
export QUERY=select+planeURI+from+caom2.Observation+as+o+JOIN+caom2.Plane+as+p+on+o.obsID%3Dp.obsID+where+o.proposal_id=\'${proposal_id}\'
for planeURI in `curl -u ${USERNAME}:${PASSWORD} "${tap_url}?REQUEST=${REQUEST}&LANG=${LANG}&FORMAT=${FORMAT}&QUERY=${QUERY}"`
do
curl -u ${USERNAME}:${PASSWORD} -J -O -L "${download_url}?ID=${planeURI}"
done

Métadonnées exclusives

Certaines métadonnées du tableau caom2.Plane sont exclusives. Pour afficher les enregistrements exclusifs, utilisez la commande auth-sync au lieu de la commande sync dans les adresses URL précitées et ajoutez votre nom d'utilisateur et votre mot de passe.

Construits ADQL non reconnus

Présentement, les fonctions ADQL suivantes ne sont pas reconnues: ALL et DISTINCT dans une fonction d'agrégat PI RAND TRUNCATE (AVG, COUNT, MIN, MAX, COUNT).

Détails

La principale utilisation de notre service TAP consiste à explorer notre catalogue d'observations. Les métadonnées de toutes les observations enregistrées dans le CCDA se trouvent dans la base de données Common Archive Observation Model (CAOM-2.0). Vous pouvez interroger les tableaux de la base de données CAOM-2.0 au moyen du service TAP. Les principaux tableaux sont les suivants:

  • caom2.Observation: Ce tableau présente les observations (poses ou piles de poses).
  • caom2.Plane: Ce tableau présente les produits de données individuels créés à partir d'une observation précise, comme une image BRUTE, une image TRAITÉE ou un catalogue de sources.

Pour utiliser le service TAP, construisez une requête ADQL et affichez cette requête sur l'adresse URL d'un service TAP. Pour faciliter le travail, utilisez un outil comme TOPCAT; vous pouvez aussi utiliser un outil comme cURL. Les adresses URL des services TAP sont les suivantes:

resourcedescription
http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/tap/async Requêtes asynchrones; la destination VOSpace où sont enregistrés les résultats.
http://www.cadc-ccda.hia-iha.nrc-cnrc.gc.ca/tap/sync Requêtes synchrones; affiche les résultats de la requête.

Autres affichages dans notre collection

Outre la base de données CAOM-2.0, ce service propose aussi des affichages de notre collection de métadonnées qui respectent diverses normes liées aux tableaux IVOA:

  • caom.SIAv1: affichage sur CAOM-2.0 qui donne accès à des images calibrées; le résultat en format VOTable est compatible avec la spécification Simple Image Access (SIA), version 1.0.
  • ivoa.ObsCore: prototype du modèle physique ObsCore du projet ObsTap.

Autres exemples (avec des requêtes)

Ci-dessous figurent quelques exemples de requêtes (avec les paramètres obligatoires minimaux) qui devraient fonctionner et donner un nombre modeste de résultats. Veuillez noter que la requête elle-même doit être correctement codée, étant donné qu'elle comporte des espaces et d'autres caractères spéciaux. Vous pouvez exécuter ces requêtes au moyen de points d'extrémité /caom/async ou /caom/sync; la marche à suivre détaillée fait l'objet des spécifications UWS et TAP. Nous proposons ci-dessous quelques adresses URL en direct qui utilisent le point d'extrémité /caom/sync.

Requête pour un affichage SIA portant sur des observations qui contiennent une position:

REQUEST=doQuery
LANG=ADQL
QUERY=select * from caom2.SIAv1
      where CONTAINS(POINT('ICRS', 180, 5), position_bounds) = 1

Faites-en l'essai

Requête pour un affichage ObsCore visant des observations qui coupent un cercle:\

REQUEST=doQuery
LANG=ADQL
QUERY=select * from ivoa.ObsCore
      where INTERSECTS(s_region, CIRCLE('ICRS', 180, 5, 2)) = 1

Faites-en l'essai

Requête qui vise une colonne et un tableau inexistants et qui devrait échouer:

REQUEST=doQuery
LANG=ADQL
QUERY=select noSuchColumn from noSuchTable

Faites-en l'essai