Interface Query<T>

All Superinterfaces:
Iterable<T>, PaginationContext<Query<T>>, ParameterContext<Query<T>>

public interface Query<T> extends Iterable<T>, PaginationContext<Query<T>>, ParameterContext<Query<T>>
An immutable object representing both the query and the result. The result is obtained lazily when one of the methods in this interface is executed first time. The query is executed only once. Further calls will just return the previously cached results. If you intend to re-execute the query to obtain fresh data you need to build another instance using a QueryBuilder.
  • Method Details

    • getQueryString

      String getQueryString()
      Returns the Ickle query string.
    • list

      List<T> list()
      Returns the results of a search as a list.
      list of objects that were found from the search.
    • execute

      QueryResult<T> execute()
      Executes the query (a SELECT statement). Subsequent invocations cause the query to be re-executed.

      Executing a DELETE is also allowed. No results will be returned in this case but the number of affected entries will be returned as the hit count in the QueryResult.

      QueryResult with the results.
    • executeStatement

      int executeStatement()
      Executes a data modifying statement (typically a DELETE) that does not return results; instead it returns an affected entries count. This method cannot be used to execute a SELECT.

      NOTE: Paging params (firstResult/maxResults) are NOT allowed.

      the number of affected (deleted) entries
    • getResultSize

      @Deprecated int getResultSize()
      since 10.1. This will be removed in 12. It's closest replacement is QueryResult.hitCount() which returns an optional long.
      Gets the total number of results matching the query, ignoring pagination (startOffset, maxResults).
      total number of results.
    • getProjection

      @Deprecated String[] getProjection()
      since 11.0. This method will be removed in next major version. To find out if a query uses projections use hasProjections()
      the values for query projections or null if the query does not have projections.
    • hasProjections

      boolean hasProjections()
      Indicates if the parsed query has projections (a SELECT clause) and consequently the returned results will actually be Object[] containing the projected values rather than the target entity.
      true if it has projections, false otherwise.
    • getStartOffset

      long getStartOffset()
    • startOffset

      Query<T> startOffset(long startOffset)
      Specified by:
      startOffset in interface PaginationContext<T>
    • getMaxResults

      int getMaxResults()
    • maxResults

      Query<T> maxResults(int maxResults)
      Specified by:
      maxResults in interface PaginationContext<T>
    • hitCountAccuracy

      Integer hitCountAccuracy()
      current hitCountAccuracy if present
      See Also:
    • hitCountAccuracy

      Query<T> hitCountAccuracy(int hitCountAccuracy)
      Limit the required accuracy of the hit count for the indexed queries to an upper-bound. Setting the hit-count-accuracy could improve the performance of queries targeting large data sets.
      hitCountAccuracy - The value to apply
      this, for method chaining
    • getParameters

      Map<String,Object> getParameters()
      Returns the named parameters Map.
      Specified by:
      getParameters in interface ParameterContext<T>
      the named parameters (unmodifiable) or null if the query does not have parameters
    • setParameter

      Query<T> setParameter(String paramName, Object paramValue)
      Sets the value of a named parameter.
      Specified by:
      setParameter in interface ParameterContext<T>
      paramName - the parameters name (non-empty and not null)
      paramValue - a non-null value
    • setParameters

      Query<T> setParameters(Map<String,Object> paramValues)
      Sets multiple named parameters at once. Parameters names cannot be empty or null. Parameter values must not be null.
      Specified by:
      setParameters in interface ParameterContext<T>
      paramValues - a Map of parameters
    • iterator

      CloseableIterator<T> iterator()
      Returns a CloseableIterator over the results. Please close the iterator when you are done with processing the results.
      Specified by:
      iterator in interface Iterable<T>
      the results of the query as an iterator.
    • entryIterator

      <K> CloseableIterator<Map.Entry<K,T>> entryIterator()
      Returns a CloseableIterator over the results, including both key and value. Please close the iterator when you are done with processing the results. The query cannot use projections.
      the results of the query as an iterator.
    • timeout

      Query<T> timeout(long timeout, TimeUnit timeUnit)
      Set the timeout for this query. If the query hasn't finished processing before the timeout, a SearchTimeoutException will be thrown. For queries that use the index, the timeout is handled on a best effort basis, and the supplied time is rounded to the nearest millisecond.
    • local

      Query<T> local(boolean local)
      Set the query execution scope
      local - if true, query will be restricted to the data present in the local node, ignoring the other members of the clusters