Exporting a filter result containing more than 1000 issues

Still need help?

The Atlassian Community is here for you.

Ask the community

This article only applies to Atlassian's server products. Learn more about the differences between cloud and server.

Problem

  • From the Issue Navigator, exporting filter results to Excel only exports 1000 issues.
  • Using REST API to get a filter result from your JIRA applications returns a maximum of 1000 issues.

Cause

This is an intentional limitation on JIRA applications to avoid performance-related issues such as an OutOfMemoryException.

Workaround

Perform your export in batches. For Excel exports from the UI this could be done using the "created" field or other criteria to split the result set into batches smaller than 1000 issues.

When using the REST API the startAt and maxResults parameters should be used to paginate the results, looping until the total number of records is reached. The total number of records is provided in the first response. Examples are available at JIRA REST API Example Query Issues

Resolution

JIRA can be configured to increase the limit or bypass it altogether.

Retrieving more than 1000 issues at once may result in an OutOfMemoryException for large result sets. This can cause database corruption or an application crash.

tip/resting Created with Sketch.

As of Jira 8.2, the memory problems no longer apply. We’ve changed the way the exported issues are stored in the cache, significantly reducing the amount of memory required during the export. If you're using Jira 8.2 or later, or one of the latest Enterprise releases, you can safely increase the limit. For more info about this fix and the affected Jira versions, see this issue.


Here is a brief explanation of each configuration property:

  • jira.search.views.default.max - This is the maximum value of issues exported by default when exporting/requesting a search result.
  • jira.search.views.max.limit - This defines the maximum limit for all users, regardless of modifications on the referred URL.

  • jira.search.views.max.unlimited.group - This property sets up a group that will be able to request an unlimited number of issues on a search result. 

You can use these configuration properties to override the default behavior. This is done by editing a file in your JIRA Home Directory, "jira-config.properties".

  1. First, if the jira-config.properties file does not exist in your JIRA Home Directory then create it.
  2. Add the override properties to the config file. Example: 

    jira.search.views.default.max=1500
    jira.search.views.max.limit=2000
    jira.search.views.max.unlimited.group=jira-administrators
  3. Restart JIRA.

The example configuration increases the default result limit to 1500 issues. Users can modify URLs to export up to 2000 records. Members of the jira-administrators group can modify URLs to export an unlimited number of records

To bypass the default and export more records:

  1. Perform your search in the UI
  2. Copy the URL of the format link you choose in the Export menu:
  3. Paste this URL into the URL bar of a new browser tab.
  4. Change the tempMax parameter to the number of issues you want (up to the max limit). Members of the unlimited group can remove this parameter to export the entire result set. 
  5. Click return or go from the URL bar to download the exported results.

Limitations

The group name cannot contain a space as reported in this bug:  JRA-26088 - Getting issue details... STATUS

The value of jira.search.views.max.limit must be at least as large as jira.search.views.default.max.

Instructions for JIRA 4.3.x and earlier

Click here to expand...

Change the limit for a single export

Retrieving more than 1000 issues at once may result in an OutOfMemoryException for large result sets. This can cause database corruption or an application crash.

  1. Right-click the URL for export (either "All Fields" or "Current Fields") and select Copy Link Location. The URL should be similar to:

    http://localhost:8080/sr/jira.issueviews:searchrequest-excel-current-fields/temp/SearchRequest.xls?query=ER%5C+&summary=true&description=true&tempMax=1000
  2. Paste that URL into a different browser tab.
  3. Modify tempMax=1000 to the number of desired issues to be retrieved.

Change the default limit for all exports

This only changes the default number of issues exported. Before JIRA 4.4 all users could modify their export URL to export as many issues as they wanted and there was no feature to limit this for safety.


  1. Edit the file <JIRA_INSTALL_DIR>/atlassian-jira/WEB-INF/classes/jira-application.properties

  2. Find the line that starts with jira.search.views.default.max

  3. Modify the value of the property to the number of issues you want to retrieve.

    ##
    # The maximum number of results to issue navigator will request from a query
    # - set this to zero or negative to be unrestricted (note that the server may forbid this, see below)
    ##
    jira.search.views.default.max=1500
  4. Save the file and restart JIRA.

Last modified on May 21, 2019

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.