Package org.apache.solr.search

Interface QueryLimit

All Superinterfaces:
org.apache.lucene.index.QueryTimeout
All Known Implementing Classes:
CpuAllowedLimit, MemAllowedLimit, TimeAllowedLimit
public interface QueryLimit extends org.apache.lucene.index.QueryTimeout

  • Method Summary

    Modifier and Type
    Method
    Description
    default boolean
    adjustShardRequestLimit(ShardRequest sreq, String shard, org.apache.solr.common.params.ModifiableSolrParams params)
    Allow limit to adjust shard request parameters if needed.
    Object
    currentValue()
    A value representing the portion of the specified limit that has been consumed.

    Methods inherited from interface org.apache.lucene.index.QueryTimeout

    shouldExit

  • Method Details

    • currentValue

      Object currentValue()
      A value representing the portion of the specified limit that has been consumed. Reading this value should never affect the outcome (other than the time it takes to do it).
      Returns:
      an expression of the amount of the limit used so far, numeric if possible, if non-numeric it should have toString() suitable for logging or similar expression to the user.

    • adjustShardRequestLimit

      default boolean adjustShardRequestLimit(ShardRequest sreq, String shard, org.apache.solr.common.params.ModifiableSolrParams params)
      Allow limit to adjust shard request parameters if needed.
      Returns:
      true if the shard request should be skipped because a limit will be tripped after sending, during execution.