[转]Use advanced search with Jira Query Language (JQL)
本文转自:https://support.atlassian.com/jira-software-cloud/docs/use-advanced-search-with-jira-query-language-jql/
https://support.atlassian.com/jira-software-cloud/docs/advanced-search-reference-jql-fields/
Advanced search reference - JQL fields
This page describes information about fields that are used for advanced searching. A field in JQL is a word that represents a Jira field (or a custom field that has already been defined in your Jira applications). In a clause, a field is followed by an operator, which in turn is followed by one or more values (or functions). The operator compares the value of the field with one or more values or functions on the right, such that only true results are retrieved by the clause. Note: it is not possible to compare two fields in JQL.
Affected version
Search for issues that are assigned to a particular affects version(s). You can search by version name or version ID (i.e. the number that Jira automatically allocates to a version).Note, it is better to search by version ID than by version name. Different projects may have versions with the same name. It is also possible for your Jira administrator to change the name of a version, which could break any saved filters that rely on that name. Version IDs, however, are unique and cannot be changed.
Syntax |
affectedVersion |
---|---|
Field Type | VERSION |
Auto-complete | Yes |
Supported operators | = , != , > , >= , < , <= IS, IS NOT, IN, NOT IN Note
that the comparison operators (e.g. ">") use the version order that
has been set up by your project administrator, not a numeric or
alphabetic order. |
Unsupported operators | ~ , !~ WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions |
When used with the = and != operators, this field supports:
When used with the IN and NOT IN operators, this field supports:
|
Examples |
|
^ top of page
Approvals
Used in Jira Service Management only.
Search for requests that have been approved or require approval. This can be further refined by user.
Syntax |
approvals |
---|---|
Field Type | USER |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
|
Examples |
|
^ top of page
Assignee
Search for issues that are assigned to a particular user. You can search by the user's full name, ID, or email address.
Syntax |
assignee |
---|---|
Field Type | USER |
Auto-complete |
Yes |
Supported operators |
Note that the comparison operators (e.g. ">") use the version order that has been set up by your project administrator, not a numeric or alphabetic order. |
Unsupported operators | ~ , !~ |
Supported functions | When used with the IN and NOT IN operators, this field supports:
When used with the EQUALS and NOT EQUALS operators, this field supports:
|
Examples |
|
^ top of page
Attachments
Search for issues that have or do not have attachments.
Syntax |
attachments |
---|---|
Field Type | ATTACHMENT |
Auto-complete | Yes |
Supported operators | IS, IS NOT |
Unsupported operators | =, != , ~ , !~ IN, NOT IN, |
Supported functions | None |
Examples |
|
^ top of page
Category
Search for issues that belong to projects in a particular category.
Syntax |
category |
---|---|
Field Type | CATEGORY |
Auto-complete | Yes |
Supported operators | =, != IS, IS NOT, IN, NOT IN |
Unsupported operators | ~ , !~
|
Supported functions | None |
Examples |
|
^ top of page
Change gating type
Used in Jira Service Management only.
Search
for types of change gating that are used in change requests.
"Tracked-only" requests are produced by integrations that stand
separately from a change management process. These tools don't respect
approval or change gating strategies. Change requests that are
"tracked-only" are just for record-keeping purposes.
Syntax |
change-gating-type |
---|---|
Field Type | TEXT |
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions |
None |
Examples |
|
^ top of page
Comment
Search for issues that have a comment that contains particular text. Jira text-search syntax can be used.
Syntax |
comment |
---|---|
Field Type | TEXT |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | None |
Examples |
|
^ top of page
Component
Search for issues that belong to a particular component(s) of a project. You can search by component name or component ID (i.e. the number that Jira automatically allocates to a component).
Note, it is safer to search by component ID than by component name. Different projects may have components with the same name, so searching by component name may return issues from multiple projects. It is also possible for your Jira administrator to change the name of a component, which could break any saved filters that rely on that name. Component IDs, however, are unique and cannot be changed.
Syntax |
component |
---|---|
Field Type | COMPONENT |
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions |
When used with the IN and NOT IN operators, component supports:
|
Examples |
|
^ top of page
Created
Search for issues that were created on, before, or after a particular date (or date range). Note that if a time-component is not specified, midnight will be assumed. Please note that the search results will be relative to your configured time zone (which is by default the Jira server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
"yyyy-MM-dd HH:mm"
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w"
(weeks), "d"
(days), "h"
(hours) or "m"
(minutes) to specify a date relative to the current time. The default is "m"
(minutes). Be sure to use quote-marks ("
); if you omit the quote-marks, the number you supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax |
created |
---|---|
Alias |
createdDate |
Field Type | DATE |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions |
When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS, LESS THAN or LESS THAN EQUALS operators, this field supports:
|
Examples |
|
^ top of page
Creator
Search for issues that were created by a particular user. You can search by the user's full name, ID, or email address. Note that an issue's creator does not change, so you cannot search for past creators (e.g. WAS). See Reporter for more options.
Syntax |
creator |
---|---|
Field Type | USER |
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
CHANGED, |
Supported functions |
When used with the IN and NOT IN operators, this field supports:
When used with the EQUALS and NOT EQUALS operators, this field supports:
|
Examples |
|
^ top of page
Custom field
Only applicable if your Jira administrator has created one or more custom fields.
Search for issues where a particular custom field has a particular value. You can search by custom field name or custom field ID (i.e. the number that Jira automatically allocates to an custom field).
Note, it is safer to search by custom field ID than by custom field name. It is possible for a custom field to have the same name as a built-in Jira system field; in which case, Jira will search for the system field (not your custom field). It is also possible for your Jira administrator to change the name of a custom field, which could break any saved filters that rely on that name. Custom field IDs, however, are unique and cannot be changed.
Syntax |
CustomFieldName |
---|---|
Alias |
cf[CustomFieldID] |
Field Type | Depends on the custom field's configuration Note, Jira text-search syntax can be used with custom fields of type 'Text'. |
Auto-complete |
Yes, for custom fields of type picker, group picker, select, checkbox and radio button fields |
Supported operators |
Different types of custom field support different operators. |
Supported operators: number and date fields |
|
Unsupported operators: number and date fields |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported operators: picker, select, checkbox and radio button fields |
= , != |
Unsupported operators: picker, select, checkbox and radio button fields |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported operators: text fields |
|
Unsupported operators: text fields |
= , != ,
|
Supported operators: URL fields |
|
Unsupported operators: URL fields |
WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions |
Different types of custom fields support different functions. |
Supported functions: date/time fields |
When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS,
|
Supported functions: version picker fields |
Version picker fields: When used with the IN and NOT IN operators, this field supports:
|
Examples |
|
^ top of page
Customer Request Type
Used in Jira Service Management only.
Search for requests of a certain request type. You can search by request type name or request type description as configured in the Request Type configuration screen.
Syntax |
"Customer Request Type" |
---|---|
Field Type | Custom field |
Auto-complete |
Yes |
Supported operators |
= , !=
|
Unsupported operators |
|
Note that the Lucene value for Customer Request Type, is |
|
Supported functions |
None |
---|---|
Examples |
|
^ top of page
Description
Search for issues where the description contains particular text. Jira text-search syntax can be used.
Syntax |
description |
---|---|
Field Type | TEXT |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
None |
Examples |
|
^ top of page
Due
Search for issues that were due on, before, or after a particular date (or date range). Note that the due date relates to the date only (not to the time).
Use one of the following formats:
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w"
(weeks) or "d"
(days) to specify a date relative to the current date. Be sure to use quote-marks ("
).
Syntax |
due |
---|---|
Alias |
dueDate |
Field Type | DATE |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS,
|
Examples |
|
^ top of page
Environment
Search for issues where the environment contains particular text. Jira text-search syntax can be used.
Syntax |
environment |
---|---|
Field Type | TEXT |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
None |
Examples |
|
^ top of page
Epic link
Search for issues that belong to a particular epic in company-managed projects. The search is based on either the epic's name, issue key, or issue ID (i.e. the number that Jira automatically allocates to an issue).
To search for issues that belong to a particular epic in team-managed projects, use parent.
Syntax |
"epic link" |
---|---|
Field Type | Epic Link Relationship |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
When used with the IN or NOT IN operators,
|
Examples |
|
^ top of page
Filter
You can use a saved filter to narrow your search. You can search by filter name or filter ID (i.e. the number that Jira automatically allocates to a saved filter).
Note:
- It is safer to search by filter ID than by filter name. It is possible for a filter name to be changed, which could break a saved filter that invokes another filter by name. Filter IDs, however, are unique and cannot be changed.
- An unnamed link statement in your typed query will override an ORDER BY statement in the saved filter.
- You cannot run or save a filter that would cause an infinite loop (i.e. you cannot reference a saved filter if it eventually references your current filter).
Syntax |
filter |
---|---|
Aliases |
request , savedFilter , searchRequest |
Field Type | Filter |
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
|
Supported functions |
None |
Examples |
|
^ top of page
Fix version
Search for issues that are assigned to a particular fix version. You can search by version name or version ID (i.e. the number that Jira automatically allocates to a version).
Note, it is safer to search by version ID than by version name. Different projects may have versions with the same name, so searching by version name may return issues from multiple projects. It is also possible for your Jira administrator to change the name of a version, which could break any saved filters that rely on that name. Version IDs, however, are unique and cannot be changed.
Syntax |
fixVersion |
---|---|
Field Type | VERSION |
Auto-complete |
Yes |
Supported operators |
Note that the comparison operators (e.g. ">") use the version order that has |
Unsupported operators |
|
Supported functions |
When used with the = and != operators, this field supports:
When used with the IN and NOT IN operators, this field supports:
|
Examples |
|
^ top of page
Issue key
Search for issues with a particular issue key or issue ID (i.e. the number that Jira automatically allocates to an issue).
Syntax |
issueKey |
---|---|
Aliases |
id , issue , key |
Field Type | ISSUE |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
When used with the IN or NOT IN operators,
|
Examples |
|
^ top of page
Issue link
Searches for issues linked or not linked to an issue. You can restrict the search to links of a particular type.
Syntax |
|
---|---|
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
|
Supported functions |
None |
Examples |
Find issues:
|
^ top of page
Issue link type
Search for issues that have a particular link type, like blocks or is duplicated by. You can only find issues from the Jira instance you're searching on; remote links to issues on other Jira instances won’t be included.
Use this JQL query to add colors to your issue cards! For example, add a red stripe to issues that have some blockers, and keep all other issues green. This will help you bring the right information to your team’s attention, at a glance. For more info, see Customizing cards.
Syntax |
issueLinkType |
---|---|
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
|
Supported functions |
None |
Examples |
Find issues:
|
Jira issue link types have the following properties:
- Name: The title for the link type
- Outward description: The description of how an issue affects other issues
- Inward description: The description of how an issue is affected by other issues
For example, a link type could have the following properties:
- Name: Problem/Incident
- Outward description: causes
- Inward description: is caused by
When searching issueLinkType
,
Jira searches all three properties. This can mean you're unable to
isolate issues with a specific inward or outward description if the link
type's name and either of the descriptions are the same. This is the
case for the default "Blocks" link type, where the name and outward
description are "blocks".
If you need to be able to search specifically for issues with an outward description of "blocks", for example, a Jira administrator must change the name of the link type to something else. If you're a Jira admin, take a look at Configuring issue linking for more info.
^ top of page
Labels
Search for issues tagged with a label or list of labels. You can also search for issues without any labels to easily identify which issues need to be tagged so they show up in the relevant sprints, queues or reports.
Syntax |
labels |
---|---|
Field Type | LABEL |
Auto-complete |
Yes |
Supported operators |
We recommend using IS or IS NOT to search for a single label, and IN or NOT IN to search for a list of labels. |
Unsupported operators | ~ , !~ , WAS, WAS IN, WAS NOT, WAS NOT IN, CHANGED |
Supported functions | None |
Examples |
|
Last viewed
Search for issues that were last viewed on, before, or after a particular date (or date range). Note that if a time-component is not specified, midnight will be assumed. Please note that the search results will be relative to your configured time zone (which is by default the Jira server's time zone).
Use one of the following formats:
"yyyy/MM/dd HH:mm"
"yyyy-MM-dd HH:mm"
"yyyy/MM/dd"
"yyyy-MM-dd"
Or use "w"
(weeks), "d"
(days), "h"
(hours) or "m"
(minutes) to specify a date relative to the current time. The default is "m"
(minutes). Be sure to use quote-marks ("
); if you omit the quote-marks, the number you supply will be interpreted as milliseconds after epoch (1970-1-1).
Syntax |
lastViewed |
---|---|
Field Type | DATE |
Auto-complete |
No |
Supported operators |
|
Unsupported operators |
|
Supported functions |
When used with the EQUALS, NOT EQUALS, GREATER THAN, GREATER THAN EQUALS, LESS THAN or LESS THAN EQUALS operators, this field supports:
|
Examples |
|
^ top of page
Level
Only available if issue level security has been enabled by your Jira administrator.
Search for issues with a particular security level. You can search by issue level security name or issue level security ID (i.e. the number that Jira automatically allocates to an issue level security).
Note, it is safer to search by security level ID than by security level name. It is possible for your Jira administrator to change the name of a security level, which could break any saved filter that rely on that name. Security level IDs, however, are unique and cannot be changed.
Syntax |
level |
---|---|
Field Type | SECURITY LEVEL |
Auto-complete |
Yes |
Supported operators |
|
Unsupported operators |
|
Supported functions |
None |
Examples |
|
^ top of page
Organization
Used in Jira Service Management only.
Search for all requests shared with an organization. Requests that were kept private won't be returned.
Syntax |
organizations |
---|---|
Field Type | USER |
Auto-complete |
Yes |
Supported operators |
|