Overview
Atlassian JIRA implements different Caches to enhance its performances.
In some cases, you may have to perform some change in Database from your preferred Database Client tools or from the plugin Home Directory and DB Browser for Jira. Before performing such modifications, you have :
- to have to be aware of what you do. Do it carefully !
- to have a good knowledge of what could the impacts
Among these impacts, you have the invalidation of a Cache of JIRA. It is why Atlassian advises to perform them with JIRA stopped.
But in practice, some of them can be with JIRA started on condition that the impacted Cache is cleared.
Below APIs allow you to clear some of most common caches.
APIs for clearing Caches
Opt for one below Clear Cache method. In doubt, use All Cache.
SearchRequest Caches
Goal : Clear the Cache related Filters identified by Name and by Id.
Usages :
- You have updated some SearchRequest/Filters (reqcontent column in searchrequest table) due to
- some CustomField renaming
- Changes in JQL Function parameters
- ...
| API | /rest/extendedAdmin/1.0/cache/clearSearchRequestCache |
|---|---|
| Method | GET |
| Return Code | 200 (Always) |
| Return | Result Message |
Portal Page Caches
Goal : Clear the Cache related Portal Page identified by Name and by Id.
Usages :
- You have updated some Page Daschoard/Portal Page.
| API | /rest/extendedAdmin/1.0/cache/clearPortalPageCache |
|---|---|
| Method | GET |
| Return Code | 200 (Always) |
| Return | Result Message |
User Caches
Goal : Clear the Cache related Users identified by Name and by Id.
Usages :
- You have updated some User Attributes (concerned tables are cwd_* tables, app_user, ), due to some inconsistencies experienced after Remote User Directories synchronisation (LDAP, SAML, ...), like
- misformed mails (trailing blank, ...),
- swapped values (First and Second Name),
- ...
| API | /rest/extendedAdmin/1.0/cache/clearUserCache |
|---|---|
| Method | GET |
| Return Code | 200 (Always) |
| Return | Result Message |
All Caches
Goal : Clear all Caches that can be cleared by the system event : ClearCacheEvent.
Similar feature is provided by Scriptrunner for JIRA.
Usages :
- Above use cases,
- and many others :
- Avatar
- Gadget Configurations
- Porject Components
- Application Properties
- Customfields
- most of Scheme
- ...
| API | /rest/extendedAdmin/1.0/cache/clearAllCache |
|---|---|
| Method | GET |
| Return Code | 200 (Always) |
| Return | Result Message |