Catalyst

by Zoho
×
Cancel
  • Tutorials
  • FAQ
  • Developer Tools
    CLI
    SDK
    Java Node.js Python Web Android iOS Flutter
    REST API
    Utilities
    Extensions Tools Integrations
    • Go to console

    Implementation

    The implementation section acts as a step-by-step procedure guide on working with Catalyst cache from the Catalyst console.

    You can refer to the Java, Node.js SDK, Python SDK and the API documentation for working with cache from the respective environments.

    Create a Segment

    You can only create a cache segment from the Catalyst console. It cannot be done using the APIs.

    Note: Catalyst allows you to create upto 20 segments in a project in the development environment. The size limit of each segment is 5 MB in the development environment. You can request Catalyst for an increase in these limits by contacting our support at support@zohocatalyst.com. We will address each request on a case-by-case basis. There are no upper limits for segments in the production environment.

    To create a cache segment:

    1. Navigate to Develop, and then Cache. Cache- Create a Segment

    2. Click Create Segment in the Segments page.

    3. Enter the segment name in the pop-up window. Cache- Create a Segment

    4. Click Create.

    Your cache segment will now be created and listed in the Segments page, along with details like segment ID, created by, and created time.

    Cache- Segment Created

    The default segment will already be present in the Segments page.

    Rename a Segment

    To rename a cache segment:

    1. Click the ellipsis icon for the segment that needs to be renamed in the Segments page, and then click Rename.

    Cache- Rename a Segment

    1. Type a new name for your segment and press Enter.

    Cache- Rename a Segment

    Create a Cache Item

    To create a cache item:

    1. Click the name of the segment from the Segments page where the cache item should be created.

    2. Click Create Cache Item.

    Cache- Create a Cache Item

    1. Enter a keyname, value, and the expiration time in hours for the cache item. Cache- Create a Cache Item
    Note:

    • The keyname of a cache item is unique for a segment.

    • If you do not enter a value for the expiry time, it is automatically set to the default validity (two days).

    1. Click Create.

    The cache item will be created and listed in the segment’s page.

    Cache- Cache Item Created

    You can find a particular cache item by searching using its keyname in the search bar.

    Edit a Cache Item

    To edit a cache item:

    1. Click on the name of the segment whose cache item you want to edit, in the Segments page.

    2. Click on the key name and click Edit in the Key Details window.

    3. Make the necessary edits to the cache item.

    Cache- Edit a Cache Item

    1. Click Save.

    The cache item will be updated.

    Delete a Cache Item

    To delete a cache segment:

    1. Click on the name of the segment whose cache item you want to delete, in the Segments page.

    2. Click on the key name and click Delete in the Key Details window.

    Cache- Delete a Cache Item

    1. Click Yes, Proceed in the confirmation window.

    cache

    The cache item will now be deleted permanently.

    Delete a Segment

    To delete a cache segment:

    1. Click the ellipsis icon for the segment that needs to be deleted and click Delete.

    Cache- Delete a Segment

    1. Click Yes, Proceed in the confirmation pop-up window. cache

    The segment will now be deleted permanently.

    Last Updated 2023-08-14 13:22:45 +0530 +0530

    PREVIOUS

    NEXT