CMR Harvesting Best Practices

Both NASA EOSDIS data providers and external organizations require mechanisms to enable harvesting the metadata in NASA's Common Metadata Repository.  While NASA EOSDIS data providers are often looking for both collection (dataset) and granule metadata in order to validate the CMR's holdings against their local archives, other organizations will primarily focus on harvesting collection level metadata to copy into their own unique repositories. 

The CMR's harvesting functionality was implemented to better the use cases in a way that the following criteria are met:

1. Large result sets can be retrieved
2. While iterating through result sets, the results remain consistent
3. Performance of other queries in the system are unaffected
4. Changes to inventory are easily discoverable

In order to meet those criteria, an important new concept named 'scrolling' must be introduced.  After introducing the scrolling concept we will walk through 3 categories of use cases related to harvesting:

1. Populating External Systems
2. Capturing Inventory Changes
3. Synchronizing External Systems with the CMR

CMR Search Basics

This document assumes that the reader is familiar with basic usage of the CMR Search API. You can find more information about the CMR Search API here - CMR Client Partner User Guide, and API documentation here - https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html.

Scrolling

Before jumping into the use cases, we should first introduce the scrolling feature on the CMR Search API. Many of the use cases will involve iterating through large results sets of data, and the way that is accomplished via the CMR APIs is by using the scroll query parameter.

Those familiar with the CMR API have potentially used the paging parameters page_num and page_size or offset. There are two downsides to paging that make it not suited well for harvesting:

1. In between search calls data can be ingested or deleted which means that the same result may show up in multiple calls or data can be missed when going through the pages.
2. Deep paging is inefficient for our Elasticsearch system. Queries for a high offset will take longer and can impact the performance of other queries in the system. As a result the CMR rejects requests for paging beyond the one millionth result for a search.

Scrolling addresses both of these issues and is the recommended way to harvest CMR metadata.

The scroll query parameter can be used on both the collections and granules search endpoints.

scroll - A boolean flag (true/false) that allows all results to be retrieved efficiently. page_size is supported with scroll while page_num and offset are not. If scroll is true then the first call of a scroll session sets the page size; page_size is ignored on subsequent calls.

Scrolling is only supported for parameter queries, but all query parameters are available with the exception of the page_num and offset parameters. The response format for scrolling queries is identical to the response for normal parameter queries with the exception of the addition of the CMR-Scroll-Id header. The CMR-Hits header is useful for determining the number of requests that will be needed to retrieve all the available results.

Scrolling is session based; the first search conducted with the scroll parameter set to true will return a session id in the form of a CMR-Scroll-Id header. This header should be included in subsequent searches until the desired number of results have been retrieved. Sessions time out after 10 minutes of inactivity; each new query before the timeout is reached with a given CMR-Scroll-Id header will reset the timeout to 10 minutes. Queries occurring after a session has timed out will result in an HTTP 404 status code and error message.

When all the results have been returned subsequent calls using the same CMR-Scroll-Id header will return an empty list.

We recommend using Client-Id header in all request: `Client-Id` - Indicates a name for the client using the CMR API. Specifying this helps Operations monitor query performance per client. It can also make it easier for them to identify your requests if you contact them for assistance.

Limitations: Scrolling through granules requires either a collection identifier or provider id to be included in the query to ensure that performance of other queries in the system are not impacted by a scroll query. 

Example

As a harvesting client, I want to retrieve all collection metadata.

curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?page_size=2000&scroll=true"

We are using a page size of 2000 because that is the maximum allowed page size for a single request for the CMR. This query will initiate our scrolling session and return the first 2000 results. There are two headers returned that I will pay attention to:

CMR-Hits: 32636 tells me how results there are total. I know that I will need to scroll 16 times to get through all of the results. I don't actually need to know this because I will just scroll until no more results are returned, but can be useful for someone just wanting to know how many results there are.

CMR-Scroll-Id: -1261131662 gives me back the scrolling session ID that I will need to supply to all subsequent queries.

I will continue paging through the results until no more results are returned

curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: -1261131662" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

My queries are all returning collection references. If I wanted to choose a different format I would use a different extension:

For example for the original metadata format for every collection I can call https://cmr.earthdata.nasa.gov/search/collections.native?scroll=true or for echo10 https://cmr.earthdata.nasa.gov/search/collections.echo10?scroll=true.

The full list of supported formats is documented here: https://cmr.earthdata.nasa.gov/search/site/docs/search/api.html#supported-result-formats

Populating External Systems

This category of use cases is for clients want to retrieve all or some subset of the metadata from the CMR in order to support an initial load of their system.

Collection Use Cases

As a harvesting client, I want to retrieve all collection metadata.

Documented in scrolling example above.

As a harvesting client, I want to retrieve all collection metadata based on a given tag (CWIC, FedEO)

Refer to the CMR Search API Documentation for a detailed explanation of tag features.

1. Initiate scroll session 

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?tag_key=org.ceos.wgiss.cwic.quality&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" https://cmr.earthdata.nasa.gov/search/collections?scroll=true

Granule Use Cases

As a harvesting client, I want to retrieve all granule metadata for a given collection

Using C193529899-LPDAAC_ECS as the example collection.

1. Initiate scroll session 

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/granules?collection_concept_id=C193529899-LPDAAC_ECS&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules?scroll=true&collection_concept_id=C193529899-LPDAAC_ECS"

Capturing Inventory Changes

Clients want to make sure they have the most recent data and have removed any data that is no longer valid.

Note that depending on the harvesting interval many of the collection searches will most likely return less than 2000 hits and as such scrolling is not required the majority of times. However for consistency and to be able to handle any case we recommend using scrolling for many of these use cases as well.

Collection Use Cases

As a harvesting client, I want to retrieve only the collection metadata which was revised after a given date.

1. Initiate scroll session

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?updated_since=2017-07-12T20:06:38.331Z&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

As a harvesting client, I want to retrieve only the collection metadata which was newly added to the CMR after a given date.

1. Initiate scroll session

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?created_at=2017-07-12T20:06:38.331Z&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

As a harvesting client, I want to identify the collection metadata which was deleted after a given date.

See https://cmr.sit.earthdata.nasa.gov/search/site/docs/search/api.html#deleted-collections for more details.

curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/deleted-collections?revision_date=2017-07-12T20:06:38.331Z

Granule Use Cases

As a harvesting client, I want to tell which collections have added granules since the last time I harvested.

1. Initiate scroll session

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?has_granules_created_at=2017-07-12T20:06:38.331Z,&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

As a harvesting client, I want to tell which collections have added or updated granules since the last time I harvested.

1. Initiate scroll session

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?has_granules_revised_at=2017-07-12T20:06:38.331Z,&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

As a harvesting client, I want to retrieve only the granule metadata which was newly added to the CMR after a given date.

1. Find collections which have newly added granules (same as the use case above "As a harvesting client, I want to tell which collections have added granules since the last time I harvested").

   1. Initiate scroll session to capture collection-ids

      curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?has_granules_created_at=2017-07-12T20:06:38.331Z,&page_size=2000&scroll=true"

   2. Scroll until no more results are returned

      curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

2. Initiate scroll session to retrieve granule results (pass in the collection IDs captured from step 1).

   curl -i -g -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/granules?created_at=2017-07-12T20:06:38.331Z&collection_concept_id[]=C1214471197-ASF&collection_concept_id[]=C1214470533-ASF&page_size=2000&scroll=true"

3. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules?collection_concept_id[]=C1214471197-ASF&collection_concept_id[]=C1214470533-ASF&scroll=true"

As a harvesting client, I want to retrieve only the granule metadata which was revised after a given date.

Currently there is not a way to check for collections which have had granule metadata created or revised after a given date (only newly created). The client will need to provide either a list of collection concept-ids or a provider id to limit the search against.

Example with provider-id of ASF:

1. Initiate scroll session

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/granules?updated_since=2017-07-12T20:06:38.331Z&provider=ASF&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules?provider=ASF&scroll=true"

3. Repeat the steps for each provider the client is harvesting.

Example with a list of collection concept IDs:

1. Initiate scroll session passing in all of the collection concept IDs the client is interested in. Note that the CMR will also accept a POST with a Content-type of application/x-www-form-urlencoded if there are a large number of collection concept IDs to pass in.

   curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/granules?updated_since=2017-07-12T20:06:38.331Z&collection_concept_id[]=C1214471197-ASF&collection_concept_id[]=C1214470533-ASF&page_size=2000&scroll=true"

2. Scroll until no more results are returned

   curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules?collection_concept_id[]=C1214471197-ASF&collection_concept_id[]=C1214470533-ASF&scroll=true"

As a harvesting client, I want an Atom feed of new and updated granules.

Identical to the use case above "As a harvesting client, I want to retrieve only the granule metadata which was revised after a given date" except the calls to the granules endpoints should use the extension .atom.

For example:

curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules.atom?collection_concept_id[]=C1214471197-ASF&collection_concept_id[]=C1214470533-ASF&scroll=true"

As a harvesting client, I want to identify the granule metadata which was deleted after a given date.

Support to be added with  CMR-4300 - Getting issue details... STATUS

Synchronizing External Systems with the CMR

Data providers have use cases which involve ensuring an external system is synchronized with the CMR. Use cases were captured from providers comments on Granule Reconciliation with CMR. All of the examples will use ASF as the provider.

Collection Use Cases

As a Data Provider, I want to ensure all of my collections are available in the CMR

1. Capture all of the entry titles for collections in your system.
2. Capture all of the entry titles for collections in the CMR. Note that the entry-title can be captured from multiple formats. In the XML references response the entry title is in the <name> tag. In the JSON response the entry title is in the title field.
   

   1. Initiate scrolling session

      curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections?provider=ASF&page_size=2000&scroll=true"

   2. Scroll until no more results are returned

      curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections?scroll=true"

3. Diff the two lists of entry titles.
4. Ingest any collections which were missing from the CMR.

As a Data Provider, I want to ensure there are no collections available in the CMR which are no longer in my system

The process is identical to the above use case except in step 4 the provider should delete the extra collections from the CMR.

As a Data Provider, I want to ensure all of my collections are up to date in the CMR

1. Capture the entry title and last update time for all collections in your system.
2. Capture the entry title and last update time for all collections in the CMR using the JSON format. The entry title is in the title field and last update is the updated field.

   1. Initiate scrolling session

      curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/collections.json?provider=ASF&page_size=2000&scroll=true"

   2. Scroll until no more results are returned

      curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/collections.json?scroll=true"

3. Compare the entry title and last update time for every collection in the two systems.
4. Ingest any collections for entry titles that were missing from the CMR or have a last update time not equal to the last update time in the source system.

Granule Use Cases

As a Data Provider, I want to ensure all of my granules are available in the CMR

For the best performance check all of the granules one collection at a time rather than for all granules for your provider at once.

1. Capture all of the granule URs for granules for the given collection in your system.
2. Capture all of the granule URs for granules for the given collection in the CMR. Note that the granule UR can be captured from multiple formats. In the XML references response the granule UR is in the <name> tag. In the JSON response the granule UR is in the title field.
   

   1. Initiate scrolling session

      curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/granules?collection_concept_id[]=C1214471197-ASF&page_size=2000&scroll=true"

   2. Scroll until no more results are returned

      curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules?collection_concept_id[]=C1214471197-ASF&scroll=true"

3. Diff the two lists of granule URs.
4. Ingest any granules which were missing from the CMR.
5. Repeat the same process for each collection.

As a Data Provider, I want to ensure there are no granules available in the CMR which are no longer in my system

As a Data Provider, I want to ensure all of my granules are up to date in the CMR

For the best performance check all of the granules one collection at a time rather than for all granules for your provider at once.

1. Capture the granule UR and last update time for all granules for the given collection in your system.
2. Capture the granule UR and last update time for all granules for the given collection in the CMR using the JSON format. The granule UR is in the title field and last update is the updated field.
   

   1. Initiate scrolling session

      curl -i -H "Client-Id: <client id>" "https://cmr.earthdata.nasa.gov/search/granules.json?collection_concept_id[]=C1214471197-ASF&page_size=2000&scroll=true"

   2. Scroll until no more results are returned

      curl -i -H "Client-Id: <client id>" -H "CMR-Scroll-Id: <scroll id>" "https://cmr.earthdata.nasa.gov/search/granules.json?collection_concept_id[]=C1214471197-ASF&scroll=true"

3. Compare the granule UR and last update time for every granule for the collection in the two systems.
4. Ingest any granules for granule URs that were missing from the CMR or have a last update time not equal to the last update time in the source system.
5. Repeat the same process for each collection.