org.graylog.plugins.views.search.elasticsearch

Class ElasticsearchBackend

java.lang.Object

org.graylog.plugins.views.search.elasticsearch.ElasticsearchBackend

All Implemented Interfaces:

QueryBackend<ESGeneratedQueryContext>

public class ElasticsearchBackend
extends Object
implements QueryBackend<ESGeneratedQueryContext>

Constructor Summary

Constructors

Constructor and Description
ElasticsearchBackend(Map<String,javax.inject.Provider<ESSearchTypeHandler<? extends SearchType>>> elasticsearchSearchTypeHandlers, QueryStringParser queryStringParser, io.searchbox.client.JestClient jestClient, IndexRangeService indexRangeService, StreamService streamService, ESQueryDecorators esQueryDecorators)

Method Summary

Modifier and Type	Method and Description
QueryResult	doRun(SearchJob job, Query query, ESGeneratedQueryContext queryContext, Set<QueryResult> predecessorResults) Run the generated query as part of the given query job.
ESGeneratedQueryContext	generate(SearchJob job, Query query, Set<QueryResult> results) Generate a backend-specific query out of the logical query structure.
Optional<org.elasticsearch.index.query.QueryBuilder>	generateFilterClause(Filter filter, SearchJob job, Query query, Set<QueryResult> results)
QueryMetadata	parse(com.google.common.collect.ImmutableSet<Parameter> declaredParameters, Query query) Parse the query and return structural information about it.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.graylog.plugins.views.search.engine.QueryBackend

effectiveTimeRangeForResult, isAllMessages, run

Constructor Detail

ElasticsearchBackend

@Inject
public ElasticsearchBackend(Map<String,javax.inject.Provider<ESSearchTypeHandler<? extends SearchType>>> elasticsearchSearchTypeHandlers,
                                    QueryStringParser queryStringParser,
                                    io.searchbox.client.JestClient jestClient,
                                    IndexRangeService indexRangeService,
                                    StreamService streamService,
                                    ESQueryDecorators esQueryDecorators)

Method Detail

generate

public ESGeneratedQueryContext generate(SearchJob job,
                                        Query query,
                                        Set<QueryResult> results)

Description copied from interface: QueryBackend

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

Specified by:

generate in interface QueryBackend<ESGeneratedQueryContext>

Parameters:

job - currently executing job

query - the graylog query structure

results - the query result of the preceding queries

Returns:

a backend specific generated query

generateFilterClause

public Optional<org.elasticsearch.index.query.QueryBuilder> generateFilterClause(Filter filter,
                                                                                 SearchJob job,
                                                                                 Query query,
                                                                                 Set<QueryResult> results)

doRun

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

Description copied from interface: QueryBackend

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

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

Specified by:

doRun in interface QueryBackend<ESGeneratedQueryContext>

Parameters:

job - currently executing job

query - the individual query to run from the current job

queryContext - the generated query by QueryBackend.generate(SearchJob, Query, Set)

predecessorResults - the query result of the preceding queries

Returns:

the result for the query

parse

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

Description copied from interface: QueryBackend

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.

Specified by:

parse in interface QueryBackend<ESGeneratedQueryContext>