Page tree
Skip to end of metadata
Go to start of metadata

The query syntax can be used in Squirro to search items.

Table of Contents

Introduction

Title and body fields are taken into account when searching.

By default the terms entered are or-combined with an additional clause that at least 1/3 of all terms must appear in a document to match. That means for a query with up to five terms, at least one must match and for a query between 6 and 8 terms, at least two terms must match and so on.

Boolean Operators

Use AND, OR, NOT, + (plus sign) or - (minus sign) to explicitly combine terms. Be aware that the operators need to be in all capital letters.

The following restrictions apply:

  • The + or required operator requires that the term after the + symbol exist somewhere.
  • The - or prohibit operator excludes documents that contain the term after the - symbol.

Example Queries

QueryDescription
squirro AND memonicSearch documents that contain squirro and memonic.
squirro OR memonicSearch documents that contain either squirro or memonic.
+memonic -squirroSearch documents that contain memonic but do not contain squirro.
squirro NOT memonicSearch documents that contain squirro but do not contain memonic.

Grouping

Use brackets for grouping.

Example Queries

QueryDescription
(java AND solr) OR (python AND elasticsearch)Search documents that contain both java and solar, or documents that contain both python and elasticsearch.
nektoon AND (squirro OR memonic)Search documents that contain nektoon and either squirro or memonic.

Phrase Search

Use double quotes at the beginning and ending of a phrase to perform a phrase search. Phrases must match exactly (i.e. no stemming is applied within a phrase). You can also add a slop to the phrase with a tilde ~ at the end of the phrase to do a proximity search.

Example Queries

QueryDescription
"oracle financial services"Search documents where oracle, financial and services match in exact this order and within three terms.
"oracle financial leasing"~3Search documents where oracle, financial and leasing must match in exact this order but allow for up to 3 additional terms between them.

Wildcard Search

Use * and ? to perform a wildcard search. Multiple character wildcard searches looks for 0 or more characters and the single character wildcard search looks for terms that match that with the single character replaced. Leading wildcards are allowed.

Example Queries

QueryDescription
squirr*Search documents that contain e.g. for squirro and squirrel.
*emonicSearch documents that contain e.g. for memonic and mnemonic.
te?tSearch documents that contain e.g. for test and text.

Field Search

Only search in specific fields

QueryDescription
$title:FranceSearch documents that have the term France in the title
$body:FranceSearch document that have the term France in the document body
$item_id:PgnAQM1FTSCP1uNOesoE7QSearch for a specific document by id

$item_created_at >= "2015-02-01T00:00:00"

Search documents created after Feb. 2, 2015
$item_created_at <= "2015-02-01T00:00:00"Search documents created before Feb. 2, 2015

 

Facet Search

Use any document facet to restrict the search.

QueryDescription
Country:FranceSearch documents that have a facet named Country with a value France
Country:"United Kingdom"Search documents that have a facet named Country with a value United Kingdom
"Mixed Sentiment":YesSearch document that have a facet named Mixed Sentiment with a value Yes

 

Sorting

You can use the following query syntax to sort the result:

sort:<field_name>[:<order>]

Where <field_name> is either 'date' (default) or 'relevance' or any item field name you want to sort by and <order> is either 'asc' for ascending or 'desc' for descending. The order suffix is optional, default order is descending.

Additionally you can add a second (or third etc) sorting criteria by adding

[;<2nd_sort_field[:<2nd_order]]

to the query syntax.

Time Increment

It is possible to control the time increments shown in the main timeline and in the dashboard widgets. To do so, add time_increment:<value> to a query.

Here is the Bugzilla Project without a time_increment set:

The same query, with time_increment:year

Possible values are:

time_increment:minute
time_increment:hour
time_increment:day
time_increment:week
time_increment:month
time_increment:quarter
time_increment:year

This can also be combined with values for more flexibility. For example:

time_increment:12hours
time_increment:4days
time_increment:8weeks
time_increment:6months
time_increment:3year

There is a performance impact when using a time increment that results in many individual increments. This impact is both in the user interface, where each increment needs to be drawn, as well as on the Elasticsearch level, where they need to be calculated. So use the time_increment setting carefully.

  • No labels