Using FatBug Search

Searching in FatBug is fundamentally different from viewing tickets in filter mode. In filter mode, you are only seeing items from a single bug server. Searching allows you to span multiple bug servers and provides a quick way to perform precise ad-hoc queries. Searching is often the fastest to find a particular ticket or wiki page when you know what you are looking for.

Example Searches

Sample Search What does it do? Additional Notes
Python sqliteFind items with both Python and sqlite
Python -mysqlFind items with Python but not mysql
*nix database?serverFind items with words ending in 'nix' and containing phrase "database server"Uses question mark for space character
Linu* -status:closedFind all Linux issues that do not have status closedDemonstrates using a search field (status) to limit results
(github or coderesort) AND fetchItems with either 'github' or 'coderesort' and also having the word 'fetch'Demonstrates using parentheses for full BOOLEAN logic operations
(status:accepted OR status:new) +component:GUIFind all 'GUI' issues with a status of either 'accepted' or 'new'Demonstrates search field

Search Fields

There are several fields you can utilize in your search queries to help find the items you are looking for. The supported fields are:
  • status
  • type
  • component
  • version
  • milestone
  • severity
  • priority

FatBug uses a sophisticated search engine that provides many search options and fast performance.

To make the most of FatBug search, keep in mind the following features for search syntax:

  • Terms

    A query is broken up into terms and operators. There are two types of terms: Single Terms and Phrases.
    • A Single Term is a single word such as "air" or "quality".
    • A Phrase is a group of words surrounded by double quotes such as "air quality".
    • Multiple terms can be combined together with Boolean operators to form a more complex query.
      • Examples:
        • Searching for air could result in 35 hits (items contain the word air)
        • Searching for quality results in 123 hits (items contain the word quality)
        • Searching for air quality (without quotes) results in 148 hits (items contain the words air or quality or both)
        • Searching for air AND quality results in 10 hits (results contain both words air and quality)
        • Searching for "air quality" (with quotes) results in 7 hits (items contain the words air and quality directly after each other)
        • Searching for title:air results in 5 hits (items contain the word air in the title)
        • Searching for title:quality results in 14 hits (items contain the word quality in the title)
        • Searching for +title:air +title:quality or title:"air quality" results in 2 hits (both items contain both words air and quality in the title)
  • Special Characters

    You must escape special characters that are part of the query syntax. The current list special characters are

    + - && || ! ( ) { } [ ] ^ " ~ * ? : \

    To escape these character use the \ before the character. For example to search for items that contain the scale hit 1:250k use the query: \1\:250k.
  • Wildcard Searches

    Search supports single and multiple character wildcard searches within single terms (not within phrase queries). Note: To match a string anywhere put an asterisk on each end of the word. For example, searching for *ookc* will match bookcase.
    • To perform a single character wildcard search use the "?" symbol.

      The single character wildcard search looks for terms that match that with the single character replaced. For example, to search for "text" or "test" you can use the search:te?t. Often this is the easiest way to match a space in a phrase.
    • To perform a multiple character wildcard search use the "*" symbol.

      Multiple character wildcard searches looks for 0 or more characters. For example, to search for test, tests or tester, you can use the search: test*

      You can also use the wildcard searches in the middle of a term: te*t
  • Fuzzy Searches

    Search supports fuzzy searches based on the Levenshtein Distance, or Edit Distance algorithm. To do a fuzzy search use the tilde, "~", symbol at the end of a Single word Term. For example to search for a term similar in spelling to "air" use the fuzzy search: air~. This search will find items containing terms like air and airplane, but also aid.

  • Proximity Searches

    Search supports finding words that are within a specific distance away. To do a proximity search use the tilde, "~", symbol at the end of a Phrase. For example to search for "air" and "quality" within 10 words of each other in a document use the search: "air quality"~10
  • Boosting a Term

    Search provides the relevance level of matching documents based on the terms found. To boost a term use the caret, "^", symbol with a boost factor (a number) at the end of the term you are searching. The higher the boost factor, the more relevant the term will be. Boosting allows you to control the relevance of a document by boosting its term. For example, if you are searching for air quality and you want the term "air" to be more relevant, boost it using the ^ symbol along with the boost factor next to the term. You would type: air^4 quality. This will make documents with the term air appear more relevant. You can also boost Phrase Terms as in the example: "air quality"^4 "water quality". By default, the boost factor is 1. Although the boost factor must be positive, it can be less than 1 (e.g. 0.2)
  • Boolean Operators

    Boolean operators allow terms to be combined through logic operators. Search supports AND, "+", OR, NOT and "-" as Boolean operators (Note: Boolean operators must be ALL CAPS).
    • The OR operator is the default conjunction operator. This means that if there is no Boolean operator between two terms, the OR operator is used. The OR operator links two terms and finds a matching document if either of the terms exist in a document. This is equivalent to a union using sets. The symbol || can be used in place of the word OR.
    • The AND operator matches documents where both terms exist anywhere in the text of a single document. This is equivalent to an intersection using sets. The symbol && can be used in place of the word AND.
    • The "+" or required operator requires that the term after the "+" symbol exist somewhere in a field of a single document.
    • The NOT operator excludes documents that contain the term after NOT. This is equivalent to a difference using sets. The symbol ! can be used in place of the word NOT. Note: The NOT operator cannot be used with just one term.
  • Grouping

    Search supports using parentheses to group clauses to form sub queries. This can be very useful if you want to control the boolean logic for a query. For example: (air OR water) AND quality will find documents containing the words air and quality or the words water and quality or both.