7.7 KiB
| stage | group | info | type |
|---|---|---|---|
| Enablement | Global Search | To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments | reference |
Advanced Search Syntax (PREMIUM)
Use advanced queries for more targeted search results.
This is the user documentation. To install and configure Elasticsearch, visit the administrator documentation.
Overview
The Advanced Search Syntax is a subset of the Advanced Search, which you can use if you want to have more specific search results.
Advanced Search only supports searching the default branch.
Using the Advanced Search Syntax
The Advanced Search Syntax supports fuzzy or exact search queries with prefixes, boolean operators, and much more.
Full details can be found in the Elasticsearch documentation, but here's a quick guide:
- Searches look for all the words in a query, in any order - e.g.: searching
issues for
display bugandbug displaywill return the same results. - To find the exact phrase (stemming still applies), use double quotes:
"display bug" - To find bugs not mentioning display, use
-:bug -display - To find a bug in display or banner, use
|:bug display | banner - To group terms together, use parentheses:
bug | (display +banner) - To match a partial word, use
*. In this example, I want to find bugs with any 500 errors. :bug error 50* - To use one of symbols above literally, escape the symbol with a preceding
\:argument \-last
Syntax search filters
The Advanced Search Syntax also supports the use of filters. The available filters are:
- filename: Filters by filename. You can use the glob (
*) operator for fuzzy matching. - path: Filters by path. You can use the glob (
*) operator for fuzzy matching. - extension: Filters by extension in the filename. Please write the extension without a leading dot. Exact match only.
- blob: Filters by Git
object ID. Exact match only.
To use them, add them to your keyword in the format <filter_name>:<value> without
any spaces between the colon (:) and the value. When no keyword is provided, an asterisk (*) will be used as the keyword.
Examples:
- Finding a file with any content named
search_results.rb:* filename:search_results.rb - The leading asterisk (
*) can be ignored in the case above:filename:search_results.rb - Finding a file named
found_blob_spec.rbwith the textCHANGELOGinside of it:CHANGELOG filename:found_blob_spec.rb - Finding the text
EpicLinksinside files with the.rbextension:EpicLinks extension:rb - Finding any file with the
.yamlextension:extension:yaml - Finding the text
Sidekiqin a file, when that file is in a path that includeselastic:Sidekiq path:elastic - Finding any file in a path that includes
elasticsearch:path:elasticsearch - Finding the files represented by the Git object ID
998707b421c89bd9a3063333f9f728ef3e43d101:* blob:998707b421c89bd9a3063333f9f728ef3e43d101 - Syntax filters can be combined for complex filtering. Finding any file starting with
searchcontainingeventHuband with the.jsextension:eventHub filename:search* extension:js
Excluding filters
Introduced in GitLab Starter 13.3.
Filters can be inverted to filter out results from the result set, by prefixing the filter name with a - (hyphen) character, such as:
-filename-path-extension-blob
Examples:
- Finding
railsin all files butGemfile.lock:rails -filename:Gemfile.lock - Finding
successin all files excluding.po|potfiles:success -filename:*.po* - Finding
importexcluding minified JavaScript (.min.js) files:import -extension:min.js - Finding
docsfor all files outside thedocs/folder:docs -path:docs/
Search by issue or merge request ID
You can search a specific issue or merge request by its ID with a special prefix.