New Query Format Available for Globus Search; Will Become Default in July

[Ada Nikolaidis]

We’ve recently released a new query format (query#1.0.0, scroll#1.0.0, and delete_by_query#1.0.0) for Globus Search that provides new filtering options and improved performance for faceted queries.

This also changes the way that filtered facets are counted, which may require updates to your queries.

Your existing Delete by Query and Scroll Query requests will continue to work as-is.

In many cases, your existing POST Queries will also continue to work as-is, with a key exception: Due to a necessary behavioral change, if your query uses facets, your results may be different when using query#1.0.0. In this new version, GFacetResult no longer automatically includes entries that would otherwise have been excluded by a GFilter specified in the GSearchRequest object’s filters targeting the faceted field.

This makes it possible to calculate facets that couldn’t be expressed using the legacy format. It is now possible to specify:

• Global filters that will be applied to both GMetaResult and GFacetResult (using the filters field in GSearchRequest)

• Filters that should only be applied to a specific GFacetResult (using the additional_filters field in GFacet)

• Filters that will be applied to GMetaResult documents without impacting facets (using the post_facet_filters field in GSearchRequest)

Please consult the documentation for additional details on GFacet in the query#1.0.0 format.

The query#1.0.0, scroll#1.0.0, and delete_by_query#1.0.0 formats will become the default on July 16, 2025.

If you want to begin testing this behavior now, you can manually specify these values in the @version field for their corresponding request types. (See POST Query, Scroll Query, and Delete-by-Query docs for details).

If you need to retain the legacy behavior for your requests after July 16, 2025, you may include an explicit @version specifier with the value 2017-09-01 in your requests. This legacy format will be removed on a subsequent, to-be-announced date.

If you have any questions, including whether or not this change impacts your Globus Search usage, please reach out via sup...@globus.org.

Ada Nikolaidis
Globus Software Engineering Manager
Globus.org | University of Chicago