Search Query Language Reference
This page provides a visual breakdown of the Search Query Language with some examples to get you started.
It is complementary to our Search Query Syntax and illustrates syntax using railroad diagrams instead of tables.
How to read railroad diagrams?
Follow the lines in these railroad diagrams to see how pieces of syntax combine. When a line splits, it means there are multiple options available. When it is possible to repeat a previous syntax, the split line will loop back on itself like this:
Basic query
At a basic level, a query consists of search patterns and parameters. Typical queries contain one or more space-separated search patterns that describe what to search, and parameters refine searches by filtering results or changing search behavior.
For example,
Expression
Build query expressions by combining basic queries and operators like AND or OR. Group expressions with parentheses to build more complex expressions. If there are no balanced parentheses, AND operators bind tighter, so foo or bar and baz means foo or (bar and baz). You may also use lowercase and or or.
For example,
Search pattern
A pattern to search. By default, the pattern is searched literally. The kind of search may be toggled to change how a pattern matches:
Perform a regular expression search. We support RE2 syntax. Quoting a pattern will perform a literal search.
For example,
Perform a structural search. See our dedicated documentation to learn more about structural search.
For example,
Parameter
Search parameters allow you to filter search results or modify search behavior.
Repo
Search repositories that match the regular expression. A - before repo excludes the repository. By default, the repository will be searched at the HEAD commit of the default branch. You can optionally change the revision.
For example,
Revision
Search a repository at a given revision, for example, a branch name, commit hash, or Git tag.
For example,
repo:^github\.com/sourcegraph/sourcegraph$@75ba004 get_embeddingsrepo:^github\.com/sourcegraph/sourcegraph$ rev:v5.0.0 get_embeddings
You can search multiple revisions by separating the revisions with :. Specify HEAD for the default branch.
For example,
repo:^github\.com/sourcegraph/sourcegraph$ rev:v4.5.0:v5.0.0 disableNonCriticalTelemetryrepo:^github\.com/sourcegraph/[email protected]:v5.0.0 disableNonCriticalTelemetry
Revision at time
Search a repository at a given time. Optionally, a second parameter can be used to specify a revision which will be used as the starting point of the search.
For example,
repo:^github\.com/sourcegraph/sourcegraph$ rev:at.time(2 years ago) handbookrepo:^github\.com/sourcegraph/sourcegraph$ rev:at.time(2021-01-30, v5.0.0) popular
File
Search files whose full path matches the regular expression. A - before file excludes the file from being searched.
For example,
Language
Only search files in the specified programming language, like typescript or python.
For example,
Content-based language detection (Beta)
Language filters work by checking the file name and extension. They can behave unexpectedly
when a language's extension is ambiguous: for example lang:Objective-C may also match Matlab files, since both
languages use the .m extension.
If this is an issue, you can enable the feature flag search-content-based-lang-detection. When enabled, Sourcegraph
more accurately detects a file's language by checking the file contents in addition to the name and extension.
Content
Set the search pattern to search using a dedicated parameter. Useful, for example, when searching literally for a string like repo:my-repo that may conflict with the syntax of parameters in this Sourcegraph language.
For example,
Select
Selects the specified result type from the set of search results. If a query produces results that aren't of the selected type, the results will be converted to the selected type.
For example, the query file:package.json lodash will return content matches for lodash in package.json files. If select:repo is added, the containing repository will be selected and the repositories that contain package.json files that contain the term lodash will be returned. All selected results are deduplicated, so if there are multiple content matches in a repository, select:repo will still only return unique results.
A query like type:commit example select:symbol will return no results because commits have no associated symbol and cannot be converted to that type.
For example,
Symbol kind
Select a specific kind of symbol. For example type:symbol select:symbol.function zoektSearch will only return functions that contain the literal zoektSearch.
For example,
Modified lines
When searching commit diffs, select only diffs where the pattern matches on added or removed lines. For example, search for recent commits that removed TODOs in your code.
type:diff must be specified in the query.For example,
File kind
Select only directory paths of file results with select:file.directory. This is useful for discovering the directory paths that specify a package.json file, for example.
select:file.path returns the full path for the file and is equivalent to select:file. It exists as a fully-qualified alternative.
For example,
File owners
Select owners associated with the results of a query.
For example, lang:TypeScript select:file.owners displays owners of all TypeScript files.
Type
Set whether the search pattern should perform a search of a certain type. Notable search types are symbol, commit, and diff.
For example,
Case
Set whether the search pattern should be treated case-sensitively. This is synonymous with the toggle button.
For example,
Fork
Set to yes if repository forks should be included or only if only forks should be searched. Repository forks are excluded by default.
For example,
Archived
Set to yes if archived repositories should be included or only if only archives should be searched. Archived repositories are excluded by default.
For example,
Count
Retrieve N results. By default, Sourcegraph stops searching early and returns if it finds a full page of results. This is desirable for most interactive searches. To wait for all results, use count:all.
For example,
Timeout
Set a search timeout. The time value is a string like 10s or 100ms, which is parsed by the Go time package's ParseDuration. By default, the timeout is set to 10 seconds, and the search will optimize for returning results as soon as possible. The timeout value cannot be set to longer than 1 minute.
For example,
timeout:15s count:10000 funcsets a longer timeout for a search that contains a lot of results.
Visibility
Filter results to only public or private repositories. The default is to include both private and public repositories.
For example,
Pattern type
Set whether the pattern should run a keyword search, literal search, regular expression search, or structural search. This parameter is available as a command-line and accessibility option and is synonymous with the visual search pattern toggles.
Built-in repo predicate
Repo has meta
Tagging repositories with key-value pairs is GA as of 5.1.0, but can be disabled by creating the feature flag repository-metadata and setting it to false. Add metadata by following the instructions.
Search only inside repositories that are associated with the provided key-value pair, key, or tag.
For example,
Repo has file and content
Search only inside repositories that contain a file matching the path: with content: filters.
For example,
repo:contains.file(...) is an alias for repo:has.file(...) and behaves identically.Repo has path
Search only inside repositories that contain a file path matching the regular expression.
For example,
repo:contains.path(...) is an alias for repo:has.path(..) and behaves identically.Repo has content
Search only inside repositories that contain file content matching the regular expression.
For example,
repo:contains.content(...) is an alias for repo:has.content(...) and behaves identically.Repo has topic
Search only inside repositories that have the given GitHub/GitLab topic.
For example,
Repo has commit after
Search only inside repositories that contain a commit after some specified time. See git date formats for accepted formats. Use this to filter out stale repositories that don’t contain commits past the specified time frame. This parameter is experimental.
For example,
repo:contains.commit.after(...) is an alias for repo:has.commit.after(...) and behaves identically.Repo has description
Search only inside repositories having a description matching the given regular expression.
For example,
Built-in file predicate
File has content
Search only inside files that contain content matching the provided regexp pattern.
For example,
file:contains.content(...) is an alias for file:has.content(...) and behaves identically.File has owner
Search only inside files that have an owner associated matching given string.
file:has.owner() will include files with any owner assigned and -file:has.owner() will only include files without an owner.File has contributor
Search only inside files that have a contributor whose name or email matches the provided regex pattern.
Regular expression
A string that is interpreted as a RE2 regular expression.
String
An unquoted string is any contiguous sequence of characters not containing whitespace.
Quoted string
Any string, including whitespace, may be quoted with single ' or double " quotes. Quotes can be escaped with \. Literal \ characters will need to be escaped, for example, \\.
Commit parameter
Set parameters that apply only to commit and diff searches.
Author
Include commits or diffs that are authored by the user.
Before
Include results having a commit date before the specified time frame. Times are interpreted as UTC by default. Many forms are accepted for the argument, such as:
november 1 20191 november 20192019.11.111/1/201901.11.2019Thu, 07 Apr 2005 22:13:13 +02002005-04-072005-04-07T22:13:132005-04-07T22:13:13+07:00yesterday5 days ago20 minutes ago2 weeks ago3:003pm16327828091632782809 -0600
For example,
After
Include results having a commit date after the specified time frame. Times are interpreted as UTC by default. Many forms are accepted for the argument, such as:
november 1 20191 november 20192019.11.111/1/201901.11.2019Thu, 07 Apr 2005 22:13:13 +02002005-04-072005-04-07T22:13:132005-04-07T22:13:13+07:00yesterday5 days ago20 minutes ago2 weeks ago3:003pm16327828091632782809 -0600
For example,
Message
Include results having a commit message containing the string.
For example,
Whitespace
