Create and Manage a Query Cache

This task shows you how to:

See Also
About Query Cache

Create a Query Cache

Before you begin: You can add multiple query caches to the same command.
  1. In the Administration Console, go to Search > Search API.
  2. Under Commands, select /search-api > Search cache.
  3. Under Search cache, click Add search cache and create one of the following:
    • Consistent: creates a new cache every time the index is updated.
    • Time-based: keeps a query in cache for N seconds.
  4. (Optional) Under warm-up queries, define one or more queries to cache automatically.
    • Enter the query and any parameters as they appear in the search URL.
    • For example, to search for “new york city” while restricting the search to the sl0 search logic, enter: q=new%20york%20city&logic=sl0
    • For details on available parameters, see Appendix - Search API Parameters.
    • (Optional) Modify the other configuration options from their default values.
  5. Click Apply.

Store Warm-Up Queries Only in a Cache

In the search cache settings for your search-api command, clear the cache queries options.

Know if Your Query Comes from Cache

Before you begin: This procedure assumes that you have indexed documents.
  1. In the browser, open the search-api service at BASEPORT +10 with your query or #all.

    For example, http://localhost:10010/search-api/search?q=%23all

  2. The search results <Stats> node returns:
    • When not cached: <Stats status="ok" queueTime="0" ... />
    • When cached: <Stats status="from_cache" cache="CACHE_NAME" .... />