org.graylog.plugins.views.search.engine

Interface QueryBackend<T extends GeneratedQueryContext>

Type Parameters:

T - the type of the generated query

public interface QueryBackend<T extends GeneratedQueryContext>

A search backend that is capable of generating and executing search jobs

Method Summary

Modifier and Type	Method and Description
QueryResult	doRun(SearchJob job, Query query, T queryContext) Run the generated query as part of the given query job.
default AbsoluteRange	effectiveTimeRangeForResult(Query query, QueryResult queryResult)
T	generate(SearchJob job, Query query, SearchConfig searchConfig) Generate a backend-specific query out of the logical query structure.
default boolean	isAllMessages(TimeRange timeRange)
default boolean	isOutOfLimit(TimeRange timeRange, org.joda.time.Period limit)
default boolean	isSearchTypeWithError(T queryContext, String searchTypeId)
default QueryResult	run(SearchJob job, Query query, GeneratedQueryContext generatedQueryContext)
default void	validateQueryTimeRange(Query query, SearchConfig config)
default Optional<SearchTypeError>	validateSearchType(Query query, SearchType searchType, SearchConfig searchConfig)

Method Detail

generate

T generate(SearchJob job,
           Query query,
           SearchConfig searchConfig)

Generate a backend-specific query out of the logical query structure.

Parameters:

job - currently executing job

query - the graylog query structure

searchConfig - additional cluster-wide search configuration like query time-range limit

Returns:

a backend specific generated query

isAllMessages

default boolean isAllMessages(TimeRange timeRange)

effectiveTimeRangeForResult

default AbsoluteRange effectiveTimeRangeForResult(Query query,
                                                  QueryResult queryResult)

run

default QueryResult run(SearchJob job,
                        Query query,
                        GeneratedQueryContext generatedQueryContext)

doRun

QueryResult doRun(SearchJob job,
                  Query query,
                  T queryContext)

Run the generated query as part of the given query job.

This method is typically being run in an executor and can safely block.

Parameters:

job - currently executing job

query - the individual query to run from the current job

queryContext - the generated query by generate(SearchJob, Query, SearchConfig)

Returns:

the result for the query

Throws:

RuntimeException - if the query could not be executed for some reason

validateSearchType

default Optional<SearchTypeError> validateSearchType(Query query,
                                                     SearchType searchType,
                                                     SearchConfig searchConfig)

isOutOfLimit

default boolean isOutOfLimit(TimeRange timeRange,
                             org.joda.time.Period limit)

isSearchTypeWithError

default boolean isSearchTypeWithError(T queryContext,
                                      String searchTypeId)

validateQueryTimeRange

default void validateQueryTimeRange(Query query,
                                    SearchConfig config)