This is the documentation for FishEye 3.1. View the latest version of

Unknown macro: {spacejump}

or visit the current documentation home page.

FishEye has a powerful search engine that allows you to find changesets, committers and files. There are two methods for searching in FishEye:

  • Quick Search — The Quick Search allows you search all repositories connected to FishEye by entering a single search string. This search is the default search and will suggest "quick nav" results (header search box only). Results are weighted by most recent edit date; files edited within the last twelve months are given greater weighting.
  • Advanced Search — The Advanced Search allows you to search a single repository by entering search criteria against a range of fields, e.g. commit comments, file contents, etc. These parameters can be selected on the standard search interface or specified using the FishEye's custom query language: EyeQL. This search is more complex to use, however you can define more precise search criteria.

On this page:

Using the Quick Search

Before you begin:

  • Cross-repository searching has a 100-repository limitation on searches, to prevent it from becoming unresponsive on FishEye instances that have large numbers of repositories. This means that cross-repository Quick Search is not an exhaustive search if you have more than 100 repositories, as only the first 100 repositories (alphabetically, as defined in FishEye) are included. For faster responses, you should limit your search to a particular repository, if possible. FishEye will also limit the search to the specific repository that you are looking at, if you are already navigating within a specific repository
  • The Quick Search will also return code reviews, if you are using Crucible with FishEye. For information on searching Crucible, see Searching Crucible in the Crucible documentation.

To search FishEye using the Quick Search:

  1. Enter your search criteria in the search box in the FishEye header (i.e. Quick Nav). FishEye offers a number of parameters and functions that you can use to refine your expected results, see Refining your Quick Search Criteria below.
  2. "Quick Nav" results will appear in a dropdown, as you type. "Quick Nav" will attempt to match against the file name, repository, committer and username.
    • If you want to use a quick nav result, use the up- and down-arrows on your keyboard and press enter or use your mouse to select the item.
    • If the quick nav results don't have what you are looking for, press enter to run a search. Ensure that no items in the dropdown are selected when you press enter.
  3. The Quick Search results page will be displayed. You can filter your results further, as described in Filtering Quick Search Results below.
    Results are sorted by relevance and boosted if they were edited recently. A maximum of 10 results are displayed per page.
    • If you have integrated your FishEye instance with a JIRA instance, you can display a summary of any JIRA issues referenced in your search results by hovering over the issue key. For more details, see Jira Integration in Fisheye.
  4. If you want to run another search, enter your new criteria in the main search box or in the search box in the header.
    Note, only the search box in the header provides "quick nav" results.


Screenshot above: Quick Search displaying "quick nav" matches

Refining your Quick Search Criteria

The FishEye Quick Search has a number of powerful tools that you can use to refine your search criteria before executing the search.

Search Tool

Description

Example

CamelCase Pattern Matching

Enter a CamelCase string pattern and FishEye find files and directories that match the pattern.
This is a common search feature in many popular IDEs.

Search for BooQCTest and FishEye will return results like BooleanQueryCoordTest and BooleanQueryClassTest.

Path/File Pattern Matching

Enter a path/file pattern and FishEye will find files and directories that match the pattern.

Search for common/final/Actions and FishEye will return results like /src/common/eu/systemworks/specialprojects/final/Actions.java.

Field Handles

Use a field handle in your criteria to restrict your search to a particular field. Note, you cannot have multiple field handles in a query.

  • file — Search against a file/directory name only.
  • commit — Search against a commit message only.
  • diff — Search against a diff (lines added/removed) only.
  • content — Search against contents of a file only.
  • committer — Search against a committer only.

Search for file:build.xml and FishEye will return files that have a name matching build.xml.

Searching within a Directory (AntGlobs)

AntGlobs can be used in the Quick Search to help search within a specific directory.

Search for /src/**/gwt/*.xml and FishEye will return all files with a .xml suffix that are below both a src and a gwt directory. e.g. src/java/com/atlassian/fecru/gwt/FecruCore.gwt.xml but not src/java/com/atlassian/fecru/ApplicationContext.xml

Searching for Discrete Strings

Enter a specific string within quotation marks and FishEye will match against the exact string. Note, this search is not case-sensitive.

Enter "update version in build" and FishEye will only return results that match that exact string, i.e. it will not return a result with update build version or update version in file.

Filtering Quick Search Results

Once you have a set of search results on the Quick Search page, you can filter them to a subset of the original results. The filter controls are in the left panel of the Quick Search page in the 'Source' section.

Filter

Description

Repositories

Select or enter the name of the repository that you want to restrict your results to. For example, if you enter 'FE' then the search results page will refresh to display only files and directories in the 'FE' repository.
(warning) If you are using Crucible with FishEye, there will be a projects dropdown in the 'Reviews' section. Selecting a Crucible project in this dropdown will not filter the FishEye search results. It is only used to filter reviews returned in the search results. See Searching Crucible.

Files and Directories

Click this link to restrict your results to files and directories that have names that match the search criteria.

Changeset Comments

Click this link to restrict your results to changeset comments that match the search criteria.

Diffs

Click this link to restrict your results to diffs (lines added/removed) that match the search criteria.

Content

Click this link to restrict your results to files that have content that match the search criteria.

Committers

Click this link to restrict your results to committers that match the search criteria.

Using the Advanced Search

The Advanced Search can only be run against a specific repository, however you can specify more precise criteria against a number of fields for that repository.

To search a FishEye repository using the Advanced Search:

  1. Navigate to the repository that you want to search, as described on Browsing through a Repository.
  2. Click the 'Search' tab.
  3. Enter your search criteria, as follows (Click the 'Switch to EyeQL Search'/'Switch to Standard Search' link at the bottom of the 'Search Criteria' panel to switch between the two search methods):

Specifying Search Criteria using the Standard Search Interface

The Advanced Search interface allows you to specify search criteria for multiple fields, order the results, group the results and choose the display fields in the results. You can link to the search results, as well as save the results to a CSV file.


Screenshot: Advanced Search Criteria — Standard Search Interface

Please note the following:

  • 'Contents of files' — Files must be non-binary, less than 5MB, and for svn repositories on trunk only. Only HEAD/tip revisions are searched. For older revisions, use the added/removed text search criteria.
  • 'File names/paths' — Antglobs can be used to specify the criteria for this field.

Specifying Search Criteria using EyeQL

The Advanced Search also allows you to run searches using FishEye's powerful query language, EyeQL.

For information on how to construct an EyeQL query, see the EyeQL reference guide. If you haven't built an EyeQL query before, we recommend that you use the Standard Search Interface interface to build your initial query, then switch to EyeQL to modify that query.


Screenshot above: Advanced Search Criteria — EyeQL Interface

Notes

Related Topics

Searching Crucible (Crucible documentation)

 

 

 Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.