Skip to content

Search Quick Reference

Jump to bottom Edit New page
Danil edited this page Aug 14, 2014 · 1 revision

Search Quick Reference

How to search

  • Word
  • Phrase
  • Many words
  • Wildcards
  • Search by field
  • Regular expression
  • Search by attachments
  • Fuzziness
  • Proximity searches
  • Ranges
  • Boosting
  • Boolean operators
  • Grouping
  • Reserved characters
  • Empty query
  • Available search fields

The query string “mini-language” is used by the Query String Query and by the q query string parameter in the search API. The query string is parsed into a series of terms and operators. A term can be a single word — quick or brown — or a phrase, surrounded by double quotes — "quick brown" — which searches for all the words in the phrase, in the same order. Operators allow you to customize the search — the available options are explained below.

Word

For searching a word just type a whole word:

computer

or its part (from begining):

comp

By default search will be performed on these fields:

  • title(Title)
  • description(Description)
  • notes(Notes for Issue) - only for Issue If you enable checkbox "Search titles only" then search will be performed only fo field title(Title).

Phrase

Phrase, surrounded by double quotes "quick brown" whill searches for all the words in the phrase, in the same order.

"quick brown"

Many words

For searching one of words:

fox brown bar

For searching documents with all words you should enable "All words" checkbox.

Wildcards

Wildcard searches can be run on individual terms, using '?' to replace a single character, and '*' to replace zero or more characters:

qu?ck bro*

Be aware that wildcard queries can use an enormous amount of memory and perform very badly — just think how many terms need to be queried to match the query string a* b* c*.

Warning

Allowing a wildcard at the beginning of a word (eg *ing) is particularly heavy, because all terms in the index need to be examined, just in case they match.

Search by field

As mentioned above, the default_fields is searched for the search terms, but it is possible to specify other fields in the query syntax:

  • where the status field is new

    status:new

  • where the title field contains quick or brown

    title:(quick brown)

  • where the author field contains the exact phrase "john smith"

    author:"John Smith"

  • where any of the fields book.title, book.content or book.date contains quick or brown (note how we need to escape the * with a backslash):

    book.\*:(quick brown)

  • where the field title has no value (or is missing):

    _missing_:title

  • where the field title has any non-null value:

    _exists_:title

Search by attachments

You can search issues, projects, news, documents, wiki_pages and messages by attachments. Here an example for searching container with attachment filename "somefile.pdf":

attachments.filename:somefile.pdf

Regular expression

Regular expression patterns can be embedded in the query string by wrapping them in forward-slashes ("/"):

author:/joh?n(ath[oa]n)/

The supported regular expression syntax is explained in Regular expression syntax.

Warning

A query string such as the following would force Elasticsearch to visit every term in the index:

/.*n/

Use with caution!

Fuzziness

We can search for terms that are similar to, but not exactly like our search terms, using the “fuzzy” operator:

quikc~ brwn~ foks~

This uses the Damerau-Levenshtein distance to find all terms with a maximum of two changes, where a change is the insertion, deletion or substitution of a single character, or transposition of two adjacent characters. The default edit distance is 2, but an edit distance of 1 should be sufficient to catch 80% of all human misspellings. It can be specified as:

quikc~1

Proximity searches

While a phrase query (eg "john smith") expects all of the terms in exactly the same order, a proximity query allows the specified words to be further apart or in a different order. In the same way that fuzzy queries can specify a maximum edit distance for characters in a word, a proximity search allows us to specify a maximum edit distance of words in a phrase:

"fox quick"~5

The closer the text in a field is to the original order specified in the query string, the more relevant that document is considered to be. When compared to the above example query, the phrase quick fox would be considered more relevant than "quick brown fox".

Ranges

Ranges can be specified for date, numeric or string fields. Inclusive ranges are specified with square brackets [min TO max] and exclusive ranges with curly brackets {min TO max}.

  • All days in 2013: datetime:[2013-01-01 TO 2013-12-31]

  • Numbers 1..5: count:[1 TO 5]

  • Tags between alpha and omega, excluding alpha and omega: tags:{alpha TO omega}

  • Numbers from 10 upwards: count:[10 TO *]

  • Dates before 2012: datetime:{* TO 2012-01-01}

  • Curly and square brackets can be combined:

    Numbers from 1 up to but not including 5: count:[1..5}

    Ranges with one side unbounded can use the following syntax: age:>10 age:>=10 age:<10 age:<=10

Note To combine an upper and lower bound with the simplified syntax, you would need to join two clauses with an AND operator:

age:(>=10 AND <20)

age:(+>=10 +<20)

Boosting

Use the boost operator ^ to make one term more relevant than another. For instance, if we want to find all documents about foxes, but we are especially interested in quick foxes:

quick^2 fox

The default boost value is 1, but can be any positive floating point number. Boosts between 0 and 1 reduce relevance.

Boosts can also be applied to phrases or to groups:

"john smith"^2 (foo bar)^4

Boolean operators

By default, all terms are optional, as long as one term matches. A search for foo bar baz will find any document that contains one or more of foo or bar or baz. We have already discussed the default_operator above which allows you to force all terms to be required, but there are also boolean operators which can be used in the query string itself to provide more control.

The preferred operators are + (this term must be present) and - (this term must not be present). All other terms are optional. For example, this query:

quick brown +fox -news

states that:

fox must be present

news must not be present

quick and brown are optional — their presence increases the relevance

The familiar operators AND, OR and NOT (also written &&, || and !) are also supported. However, the effects of these operators can be more complicated than is obvious at first glance. NOT takes precedence over AND, which takes precedence over OR. While the + and - only affect the term to the right of the operator, AND and OR can affect the terms to the left and right.

Grouping

Multiple terms or clauses can be grouped together with parentheses, to form sub-queries:

(quick OR brown) AND fox

Groups can be used to target a particular field, or to boost the result of a sub-query:

status:(active OR pending) title:(full text search)^2

Reserved characters

If you need to use any of the characters which function as operators in your query itself (and not as operators), then you should escape them with a leading backslash. For instance, to search for (1+1)=2, you would need to write your query as \(1\+1\)=2.

The reserved characters are: + - && || ! ( ) { } [ ] ^ " ~ * ? : \ /

Failing to escape these special characters correctly could lead to a syntax error which prevents your query from running.

Empty query

If the query string is empty or only contains whitespaces the query string is interpreted as a no_docs_query and will yield an empty result set.

Available search fields

  • Issues
  • Projects
  • News
  • Documents
  • Changesets
  • Wiki pages
  • Messages
  • Files

Issues

  • created_on(datetime): Created
  • subject(title): Subject
  • description: Description
  • author: Author
  • url: URL
  • updated_on: Updated
  • closed_on: Closed
  • due_date: Due date
  • assigned_to: Assignee
  • category: Category
  • status: Status
  • done_ratio: % Done
  • custom_field_values(cfv): Custom fields
  • private(is_private): Private
  • closed(is_closed): Issue closed
  • priority: Priority
  • fixed_version(version): Target version
  • journals.notes(notes): Notes

Projects

  • created_on(datetime): Created
  • name(title): Name
  • description: Description
  • author: Author
  • url: URL
  • homepage: Homepage
  • identifier: Identifier
  • updated_on: Updated
  • custom_field_values(cfv): Custom fields
  • public(is_public): Public

News

  • created_on(datetime): Created
  • title: Title
  • description: Description
  • author: Author
  • url: URL
  • summary: Summary
  • comments_count: Comments

Documents

  • created_on(datetime): Created
  • title: Title
  • description: Description
  • author: Author
  • url: URL
  • category: Category

Changesets

  • committed_on(datetime): Created
  • title: Title
  • comments: Comment
  • committer(author): Author
  • url: URL
  • revision: Revision

Wiki pages

  • created_on(datetime): Created
  • title: Title
  • text(description): Text field
  • author: Author
  • url: URL
  • updated_on: Updated

Messages

  • created_on(datetime): Created
  • subject(title): Subject
  • content(description): Content
  • author: Author
  • url: URL
  • updated_on: Updated
  • replies_count: Replies

Files

  • attachments.created_on: Created
  • attachments.filename: Format
  • attachments.description: Description
  • attachments.author: Author
  • attachments.filesize: Size
  • attachments.digest: MD5 digest
  • attachments.downloads: D/L
  • attachments.file: Attachment content
Add a custom footer
Add a custom sidebar
Clone this wiki locally