Solr Search Query API
 | Query module for the Solr index. Allows performing Solr queries using XWiki's Query API |
| Type | JAR |
| Category | |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
The Solr Search Query API is exposed using the Query Module API:
#set ($query = $services.query.createQuery($queryStatement, 'solr'))
#set ($discard = $query.setLimit(10).setOffset(0))
#set ($discard = $query.bindValue('sort', "score desc"))
#set ($discard = $query.bindValue('fq', '{!q.op=AND} type:DOCUMENT locales:(en OR fr) hidden:false'))
#set ($searchResponse = $query.execute()[0])
#foreach ($searchResult in $searchResponse.results)
#displaySearchResult($searchResult)
#end
In the example above $searchResponse is an instance of QueryResponse. You should read the Solr schema design to understand what you can search for using this API.
Standard Search Parameters
When we execute a search query we can specify configuration parameters that influence the search results. Let's see what are the most common query parameters:
| Parameter | Description |
|---|---|
| q | Defines a query using standard query syntax. This parameter is mandatory |
| q.op | Specifies the default operator for query expressions. Possible values are "AND" or "OR" |
| qf | Query fields: specifies the fields in the index on which to perform the query by default. Of course these have to be indexed fields. E.g. qf="title^10.0 doccontent^2.0" |
| fl | Field list: the list of fields that should be included in each search result. Of course, these must be stored fields. E.g. fl="title,doccontent" |
| sort | Specifies the sort field. E.g. sort="title_sort asc". Search results are sorted by relevance score by default. |
| fq | Filter query: additional constraints to satisfy besides the query |
| facet | Whether to activate faceting or not |
| facet.field | Specifies a faceting field. E.g face.field="creator" |
| hl | Whether to activate highlighting or not |
| hl.fl | Highlighting field list: the list of fields for which you want highlighting |
Custom Search Parameters
| Name | Description | Version |
|---|---|---|
| xwiki.multilingualFields | The list of multilingual fields that will be expanded in the search query. This way, a user can write a query on the "title" field and all the "title_<language>" variations of the field will be used in the query. The list of languages for which a field is expanded is taken from the 'xwiki.supportedLocales' query parameter (see below). Default value: title, doccontent, doccontentraw, comment, objcontent, propertyvalue, attcontent, property.*, object.* | 5.3+ |
| xwiki.supportedLocales | The list of supported locales. This is used to expand the fields specified by xwiki.multilingualFields in search queries. Default value:
| 5.3+ |
| xwiki.typedDynamicFields | The list of typed (non-string) dynamic fields that will be expanded in the search query. The names of these fields are suffixed with the name of their data type (e.g. *_int is a dynamic integer field). This allows users to write a query like this: property.Blog.BlogPostClass.publishDate:[NOW-1MONTH TO NOW] which will be expanded into: property.Blog.BlogPostClass.publishDate_boolean:[NOW-1MONTH TO NOW] OR property.Blog.BlogPostClass.publishDate_int:[NOW-1MONTH TO NOW] OR ... property.Blog.BlogPostClass.publishDate_date:[NOW-1MONTH TO NOW] Default value: property.* | 5.3+ |
| xwiki.dynamicFieldTypes | See the dynamic field definitions in schema.xml. Default value: boolean, int, long, float, double, string, date | 5.3+ |
You can see more parameters in solrconfig.xml. Search parameters are set using the Query Module API:
Faceting on Object Properties (5.3+)
You can enable a facet on an XObject property using the Query Module API:
where:
- Test.TestClass is the class name
- staticList1 is the property name
- 'string' suffix means the property was indexed/stored verbatim (without being analysed). See the Solr Schema for details.
Then you can trigger the search facet with a search query like this:
You'll have to customize the facet display to make it look nicer, but it should work nevertheless without any changes to the search UI.
Sorting on Object Properties (5.3+)
You can sort the document search results based on a property value using the Query Module API:
Test.TestCass is the class name and staticList1 is the property name. The 'sortString' suffix is the dynamic type that is used for sorting. See the Solr Schema for details.
Note that Solr doesn't support sorting on multivalued fields. The documentation says:
Sorting can be done on the "score" of the document, or on any multiValued="false" indexed="true" field provided that field is either non-tokenized (ie: has no Analyzer) or uses an Analyzer that only produces a single Term (ie: uses the KeywordTokenizer).
If you try to sort on a multivalued field you'll get:
at org.apache.solr.schema.SchemaField.checkSortability(SchemaField.java:155)
That's why we use dedicated 'sortXXX' fields that are single valued. The consequence is that only the last value of a property is used for sorting (you can have multiple values either because the property supports multiple selection or because there are multiple objects of the same type on the indexed document).
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).
You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-search-solr-query 7.1.1):
- org.xwiki.platform:xwiki-platform-query-manager 7.1.1
- org.xwiki.platform:xwiki-platform-search-solr-api 7.1.1
- org.xwiki.platform:xwiki-platform-oldcore 7.1.1
- org.xwiki.platform:xwiki-platform-model 7.1.1
