Solr SubqueryQuery pipeline stage configuration specifications
The Solr Subquery query pipeline stage is used to query external collections.
The Solr Subquery stage runs a query and adds the results to the pipeline Request object.
The query must return results in JSON format, so that they can be added to the query pipeline.
|
When entering configuration values in the UI, use unescaped characters, such as \t for the tab character. When entering configuration values in the API, use escaped characters, such as \\t for the tab character.
|
Solr query to another collection. Returned results can be used to join results or boost main results
skip - boolean
Set to true to skip this stage.
Default: false
label - string
A unique label for this stage.
<= 255 characters
condition - string
Define a conditional script that must result in true or false. This can be used to determine if the stage should process or not.
asyncConfig - Asynchronous Execution Config
enabled - boolean
Run the expensive data loading or processing part of this stage in a separate thread allowing the pipeline to continue executing. The results of this asynchronous execution can be merged into the pipeline request using a downstream "Merge Async Results" stage.
Default: false
asyncId - string
A unique value to use as reference in downstream "Merge Async Results" stages.
key - stringrequired
The key used to join these results onto the pipeline context.
Default: subquery-results
collection - stringrequired
The name of the collection to query. String templates can be used, for example use '<ctx.collection>' to search in the main collection for the incoming request.
handler - stringrequired
The Solr request handler to query
Default: select
method - stringrequired
What HTTP method to use to query Solr
Default: POST
Allowed values: GETPOST
parentParams - array[string]
rollupKeys - array[string]
params - array[object]required
Any additional query parameters to include in the request. String templates can be used here, for example <ctx.someContextKey>
object attributes:{key
required : {
display name: Parameter Name
type: string
}value
: {
display name: Parameter Value
type: string
}}
headers - array[object]
object attributes:{key
required : {
display name: Parameter Name
type: string
}value
: {
display name: Parameter Value
type: string
}}