Class VespaBackEndSearcher
- All Implemented Interfaces:
com.yahoo.component.Component
,com.yahoo.component.Deconstructable
,Comparable<com.yahoo.component.Component>
- Direct Known Subclasses:
FastSearcher
,VdsStreamingSearcher
- Author:
- baldersheim
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
for vespa-internal use only; consider renaming the summary classFields inherited from class com.yahoo.component.AbstractComponent
isDeconstructable
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionprotected abstract void
doPartialFill
(Result result, String summaryClass) protected abstract Result
Searches a search cluster This is an endpoint - searchers will never propagate the search to any nested searcher.void
Fill hit properties with data using the given summary class.protected VespaBackEndSearcher.FillHitsResult
fillHits
(Result result, DocsumPacket[] packets, String summaryClass) Fills the hits.protected final String
protected DocsumDefinitionSet
getDocsumDefinitionSet
(Query query) getDocumentDatabase
(Query query) final Logger
Returns a logger unique for the instance subclassfinal String
getName()
final void
init
(String serverId, SummaryParameters docSumParams, ClusterParams clusterParams, DocumentdbInfoConfig documentdbInfoConfig, SchemaInfo schemaInfo) Override this to implement your searcher.void
shutDown()
boolean
summaryNeedsQuery
(Query query) Returns whether we need to send the query when fetching summaries.protected void
transformQuery
(Query query) Methods inherited from class com.yahoo.search.cluster.PingableSearcher
ping
Methods inherited from class com.yahoo.search.Searcher
ensureFilled, process, toString
Methods inherited from class com.yahoo.component.chain.ChainedComponent
getAnnotatedDependencies, getDefaultAnnotatedDependencies, getDependencies, initDependencies
Methods inherited from class com.yahoo.component.AbstractComponent
clone, compareTo, deconstruct, getClassName, getId, getIdString, hasInitializedId, initId, isDeconstructable, setIsDeconstructable
-
Field Details
-
SORTABLE_ATTRIBUTES_SUMMARY_CLASS
for vespa-internal use only; consider renaming the summary class- See Also:
-
-
Constructor Details
-
VespaBackEndSearcher
public VespaBackEndSearcher()
-
-
Method Details
-
getName
-
getDefaultDocsumClass
-
getLogger
Description copied from class:Searcher
Returns a logger unique for the instance subclass -
doSearch2
Searches a search cluster This is an endpoint - searchers will never propagate the search to any nested searcher.- Parameters:
query
- the query to searchexecution
- the query execution context
-
doPartialFill
-
summaryNeedsQuery
Returns whether we need to send the query when fetching summaries. This is necessary if the query requests summary features or dynamic snippeting. -
getServerId
-
getDocumentDatabase
-
init
public final void init(String serverId, SummaryParameters docSumParams, ClusterParams clusterParams, DocumentdbInfoConfig documentdbInfoConfig, SchemaInfo schemaInfo) -
transformQuery
-
search
Description copied from class:Searcher
Override this to implement your searcher.Searcher implementation subclasses will, depending on their type of logic, do one of the following:
- Query processors: Access the query, then call execution.search and return the result
- Result processors: Call execution.search to get the result, access it and return
- Sources (which produces results): Create a result, add the desired hits and return it.
- Federators (which forwards the search to multiple subchains): Call search on the desired subchains in parallel and get the results. Combine the results to one and return it.
- Workflows: Call execution.search as many times as desired, using different queries. Eventually return a result.
Hits come in two kinds - concrete hits are actual content of the kind requested by the user, meta hits are hits which provides information about the collection of hits, on the query, the service and so on.
The query specifies a window into a larger result list that must be returned from the searcher through hits and offset; Searchers which returns list of hits in the top level in the result must return at least hits number of hits (or if impossible; all that are available), starting at the given offset. In addition, searchers are allowed to return any number of meta hits (although this number is expected to be low). For hits contained in nested hit groups, the concept of a window defined by hits and offset is not well defined and does not apply.
Error handling in searchers:
- Unexpected events: Throw any RuntimeException. This query will fail with the exception message, and the error will be logged
- Expected events: Create (new Result(Query, ErrorMessage) or add result.setErrorIfNoOtherErrors(ErrorMessage) an error message to the Result.
- Recoverable user errors: Add a FeedbackHit explaining the condition and how to correct it.
-
fill
Description copied from class:Searcher
Fill hit properties with data using the given summary class. Calling this on already filled results has no cost.This needs to be overridden by federating searchers to contact search sources again by propagating the fill call down through the search chain, and by source searchers which talks to fill capable backends to request the data to be filled. Other searchers do not need to override this.
-
fillHits
protected VespaBackEndSearcher.FillHitsResult fillHits(Result result, DocsumPacket[] packets, String summaryClass) Fills the hits.- Returns:
- the number of hits that we did not return data for, and an optional error message. when things are working normally we return 0.
-
getDocsumDefinitionSet
-
shutDown
public void shutDown()
-