org.graylog.plugins.views.search.engine

Interface QueryBackend<T extends GeneratedQueryContext>

Type Parameters:

T - the type of the generated query

All Known Implementing Classes:

ElasticsearchBackend

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, Set<QueryResult> predecessorResults) Run the generated query as part of the given query job.
default AbsoluteRange	effectiveTimeRangeForResult(Query query, QueryResult queryResult)
T	generate(SearchJob job, Query query, Set<QueryResult> predecessorResults) Generate a backend-specific query out of the logical query structure.
default boolean	isAllMessages(TimeRange timeRange)
QueryMetadata	parse(com.google.common.collect.ImmutableSet<Parameter> parameters, Query query) Parse the query and return structural information about it.
default QueryResult	run(SearchJob job, Query query, GeneratedQueryContext generatedQueryContext, Set<QueryResult> predecessorResults)

Method Detail

generate

T generate(SearchJob job,
           Query query,
           Set<QueryResult> predecessorResults)

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

Parameters:

job - currently executing job

query - the graylog query structure

predecessorResults - the query result of the preceding queries

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,
                        Set<QueryResult> predecessorResults)

doRun

QueryResult doRun(SearchJob job,
                  Query query,
                  T queryContext,
                  Set<QueryResult> predecessorResults)

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, Set)

predecessorResults - the query result of the preceding queries

Returns:

the result for the query

Throws:

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

parse

QueryMetadata parse(com.google.common.collect.ImmutableSet<Parameter> parameters,
                    Query query)

Parse the query and return structural information about it.

This method decomposes the backend-specific query and returns information about used parameters, optionally the AST for syntax highlight and other information the UI can use to offer help.