Timing and scope of API cache clearing
Timing of API cache clearance
In the content list API, if the contents are updated during the cache's expiration period, the cached content becomes outdated. Therefore, in Kuroco, cache clearance is performed at various timings when cache information needs to be updated.
For example, when updating content through the Kuroco admin panel, the cache for the endpoints related to that content is cleared. However, if we were to clear the cache for content structures that have no relation to the updated content, it would decrease the cache hit rate. Therefore, Kuroco only clears the cache for endpoints related to the updated content within the same content structure.
Operations and scope of cache clearance
Operations from the admin panel for cache clearance
Operations for cache clearance from the admin panel and the scope of cache clearance are as follows:
Operation | Details | Unit of cleared cache |
---|---|---|
Content modification | Create a new content | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. |
Update a content | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Delete a content | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Request a content approval | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Approve a content | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Update sorting order | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Upload content | Upload CSV file | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. |
Edit content category | Create a new content category | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. |
Update a content category | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Delete a content category | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. | |
Wordpress integration (External system integration) | Import | On a content structure ID basis. The cache of endpoints associated with the same content structure and the model category "Content" will be deleted. |
Form modification | Create a new form | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. |
Delete a form | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. | |
Update form basic settings and field settings | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. | |
Form submissions | Upload CSV file | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. |
Member modification | Add a member | On a model category basis. The cache of endpoints associated with the "Member" and "Authentication" model categories will be deleted. |
Update a member | On a model category basis. The cache of endpoints associated with the "Member" and "Authentication" model categories will be deleted. | |
Master modification | Update a master | On a master ID basis. The cache of endpoints associated with the same master ID will be deleted. |
Delete a master | On a master ID basis. The cache of endpoints associated with the same master ID will be deleted. | |
File manager modification | Some operation on files or folders | On a folder basis. Caches related to the same folder will be deleted. |
Tag modification | Delete a tag | On a model category basis. The cache of endpoints associated with the "Tag" model category will be deleted. |
Update sorting order | On a model category basis. The cache of endpoints associated with the "Tag" model category will be deleted. | |
Create a new tag | On a model category basis. The cache of endpoints associated with the "Tag" model category will be deleted. | |
Update a tag | On a model category basis. The cache of endpoints associated with the "Tag" model category will be deleted. |
Operations from the API for cache clearance
API cache can be cleared not only through operations in the admin panel but also when a request is made to an update-related API. Operations via API and the scope of cleared cache are as follows:
Model | Operation | Unit of cleared cache |
---|---|---|
Topics | insert | On a content structure ID basis. Thel cache of endpoints associated with the same content structure in the "Content" model category will be deleted. |
update | On a content structure ID basis. Thel cache of endpoints associated with the same content structure in the "Content" model category will be deleted. | |
delete | On a content structure ID basis. Thel cache of endpoints associated with the same content structure in the "Content" model category will be deleted. | |
accept | On a content structure ID basis. Thel cache of endpoints associated with the same content structure in the "Content" model category will be deleted. | |
bulk_upsert | On a content structure ID basis. Thel cache of endpoints associated with the same content structure in the "Content" model category will be deleted. | |
increment | On a content structure ID basis. Thel cache of endpoints associated with the same content structure in the "Content" model category will be deleted. | |
InquiryForm | insert | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. |
delete | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. | |
update | On a form ID basis. The cache of endpoints associated with the same Form ID in the "Form" model category will be deleted. | |
Comment | insert | The cache of endpoints associated with the "Activity" model category will be deleted. Additionally, if the activity is linked to a content, caches of endpoints associated with the content structure will also be deleted. If the activity is linked to a model other than content, caches of endpoints associated with that model will be deleted. |
update | The cache of endpoints associated with the "Activity" model category will be deleted. Additionally, if the activity is linked to a content, caches of endpoints associated with the content structure will also be deleted. If the activity is linked to a model other than content, caches of endpoints associated with that model will be deleted. | |
delete | The cache of endpoints associated with the "Activity" model category will be deleted. Additionally, if the activity is linked to a content, caches of endpoints associated with the content structure will also be deleted. If the activity is linked to a model other than content, caches of endpoints associated with that model will be deleted. | |
Member | insert | On a model category basis. The cache of endpoints associated with the "Member" and "Authentication" model categories will be deleted. |
update | On a model category basis. The cache of endpoints associated with the "Member" and "Authentication" model categories will be deleted. | |
Master | update | On a master ID basis. The cache of endpoints associated with the same master ID will be deleted. |
delete | On a master ID basis. The cache of endpoints associated with the same master ID will be deleted. | |
Favorite | insert | On a model category basis. The cache of endpoints associated with the target model category for favorites will be deleted. Additionally, the cache for the Topics::list endpoint, which specifies the content structure of the content that had favorites added or removed, will also be cleared. |
delete | On a model category basis. The cache of endpoints associated with the target model category for favorites will be deleted. Additionally, the cache for the Topics::list endpoint, which specifies the content structure of the content that had favorites added or removed, will also be cleared. | |
Tag | delete | On a model category basis. The cache of endpoints associated with the model category "Tag" will be deleted. |
insert | On a model category basis. The cache of endpoints associated with the model category "Tag" will be deleted. | |
Approvalflow | review | Follows the cache deletion logic for each content's approval/rejection. |
Manual cache clearance
Automatic cache clearance does not occur except for the mentioned operations. To clear the cache immediately, click the [Clear cache] button on the endpoint list page and manually clear the cache.
Cache clear confirmation
To confirm the cache clear, check the application log message [1] for the log entry containing purgeAPI
, which indicates a cache clear log.
If message [3] includes topics:1
, it means the cache for the API of Content Definition:1 has been cleared.
More information
Support
If you have any other questions, please contact us or check out Our Slack Community.