SearchExamples

Wiki Reorganisation
This page has been classified for reorganisation. It has been given the category MOVE.
The content of this page will be revised and moved to one or more other pages in the new wiki structure.

Examples for ESGF Search Services

Examples of generic REST query

• example: ' http://localhost:8080/esg-search/ws/rest/search/ ' will return all documents in the system (files and datasets as separate records), with no constraints

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=Dataset will return all datasets' in the system, with no constraints

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=File ' will return all files in the system, with no constraints

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=Dataset&text=atmos ' will return all datasets in the system matching the string "atmos"

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=Dataset&experiment=decadal2000 ' will return all datasets in the system tagged with the facet experiment="decadal2000"

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=Dataset&experiment=decadal2000&cf_variable=Air Temperature' will return all datasets in the system matching the compound facet constraints on experiment and cf_variable

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=File&cf_variable=Specific Humidity' will return all files inthe system that contain the variable "Specific Humidity" (provided that information was harvested)

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=File&parent_id=obs4cmip5.NASA-JPL.AQUA.AIRS.mon ' will return all files in the system that belong to the dataset with id=obs4cmip5.NASA-JPL.AQUA.AIRS.mon

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=Dataset&foo=bar ' will not match any datasets in the system, since most likely no dataset has been tagged with a facet "foo" with value "bar".

• example: ' http://localhost:8080/esg-search/ws/rest/search/?text=>$ ' is a valid query that returns no results (the value of text is escaped)

• example: ' http://localhost:8080/esg-search/ws/rest/search/?experiment=>$ ' is an invalid query because the value of the facet "experiment" contains invalid characters (an exception is thrown).

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=File&tracking_id=e5cbe269-9b03-4b5a-a690-321c64d7b5dd ' will return a file with the specific tracking_id, if found

• example: ' http://localhost:8080/esg-search/ws/rest/search/?type=File&variable=hus ' will return all files containing the variable 'hus'

Examples of REST query by id

• example: ' http://localhost:8080/esg-search/ws/rest/searchById/?id=obs4cmip5.NASA-JPL.AQUA.AIRS.mon ' will return the one document (a dataset) with the specified id

• example: ' http://localhost:8080/esg-search/ws/rest/searchById/?id=obs4cmip5.* ' will return all documents (datasets and files) that have an id starting with "cmip5."

• example: ' http://localhost:8080/esg-search/ws/rest/searchById/?id=obs4cmip5.*&type=File ' will return all files that have an id matching "cmip5.*"

• note: if a more complex query by id is needed, the more generic endpoint /search/ endpoint can be used, for example: ' http://localhost:8080/esg-search/ws/rest/search/?text=id:obs4cmip5.*&type=Dataset&experiment=decadal2000 '

Examples of REST query by time stamp

• example: ' http://localhost:8080/esg-search/ws/rest/searchByTimeStamp/?from=2010-01-01T00:00:00Z&to=2011-01-01T00:00:001Z '

• example: ' http://localhost:8080/esg-search/ws/rest/searchByTimeStamp/?from=2010-01-01T00:00:00Z&to=NOW '

• example: ' http://localhost:8080/esg-search/ws/rest/searchByTimeStamp/?from=2010-01-01T00:00:00Z&to=NOW&type=Dataset '

Record of type "Dataset" returned as Solr XML

 <doc>
  <float name="score">1.0</float>
  <arr name="cf_variable"><str>Land Area Fraction</str></arr>
  <arr name="cmor_table"><str>fx</str></arr>
  <arr name="creation_time"><str>2010-12-22 14:21:09</str></arr>
  <arr name="description"><str>pcmdi-test model output prepared for CMIP5 Historical</str></arr>
  <arr name="drs_id"><str>cmip5.output.PCMDI.pcmdi-test.historical.fx.atmos.fx.r0i0p0</str></arr>
  <arr name="ensemble"><str>r0i0p0</str></arr>
  <arr name="experiment"><str>historical</str></arr>
  <arr name="forcing"><str>Nat</str></arr>
  <arr name="format"><str>netCDF, CF-1.4</str></arr>
  <str name="id">cmip5.output.PCMDI.pcmdi-test.historical.fx.atmos.fx.r0i0p0</str>
  <arr name="institute"><str>PCMDI</str></arr>
  <str name="metadata_format">THREDDS</str>
  <str name="metadata_url">http://pcmdi3.llnl.gov/thredds/esgcet/catalog.xml</str>
  <arr name="model"><str>pcmdi-test</str></arr>
  <arr name="product"><str>output</str></arr>
  <arr name="project"><str>cmip5</str></arr>
  <arr name="realm"><str>atmos</str></arr>
  <long name="size">126168</long>
  <arr name="time_frequency"><str>fx</str></arr>
  <date name="timestamp">2011-04-20T12:48:50.44Z</date>
  <arr name="title"><str>project=CMIP5 / IPCC Fifth Assessment Report, model=PCMDI, experiment=historical, time_frequency=fx, modeling realm=atmos, ensemble=r0i0p0, version=1</str></arr>
  <str name="type">Dataset</str>
  <str name="url">http://pcmdi3.llnl.gov/thredds/esgcet/18/cmip5.output.PCMDI.pcmdi-test.historical.fx.atmos.fx.r0i0p0.v1.html#cmip5.output.PCMDI.pcmdi-test.historical.fx.atmos.fx.r0i0p0.v1</str>
  <arr name="variable"><str>sftlf</str></arr>
  <str name="version">1</str>
 </doc>

Record of type "File" returned as Solr XML

 <doc>
  <float name="score">1.0</float>
  <arr name="cf_variable"><str>Snow Amount</str></arr>
  <arr name="file_id"><str>pcmdi.ipcc4.GFDL.gfdl_cm2_0.picntrl.mon.land.run1.snw_A1.000101-050012.nc</str></arr>
  <arr name="file_size"><long>311193404</long></arr>
  <arr name="file_url"><str>http://pcmdi3.llnl.gov/thredds/fileServer/ipcc4_picntrl/land/mo/snw/gfdl_cm2_0/run1/snw_A1.000101-050012.nc</str><str>gsiftp://pcmdi3.llnl.gov:2811//ipcc/picntrl/land/mo/snw/gfdl_cm2_0/run1/snw_A1.000101-050012.nc</str></arr>
  <arr name="file_version"><str>1</str></arr>
  <str name="id">pcmdi.ipcc4.GFDL.gfdl_cm2_0.picntrl.mon.land.run1.v1.snw_A1.000101-050012.nc</str>
  <arr name="mod_time"><str>2004-11-04 12:05:49</str></arr>
  <arr name="parent_id"><str>pcmdi.ipcc4.GFDL.gfdl_cm2_0.picntrl.mon.land.run1</str></arr>
  <arr name="service"><str>HTTPServer|HTTPServer|http://pcmdi3.llnl.gov/thredds/fileServer/ipcc4_picntrl/land/mo/snw/gfdl_cm2_0/run1/snw_A1.000101-050012.nc</str><str>GridFTP|GridFTP|gsiftp://pcmdi3.llnl.gov:2811//ipcc/picntrl/land/mo/snw/gfdl_cm2_0/run1/snw_A1.000101-050012.nc</str></arr>
  <arr name="service_type"><str>HTTPServer</str><str>GridFTP</str></arr>
  <date name="timestamp">2011-04-20T12:48:49.566Z</date>
  <arr name="title"><str>snw_A1.000101-050012.nc</str></arr>
  <str name="type">File</str>
  <arr name="variable"><str>snw</str></arr>
 </doc>