Set retention period for Continuous Backups on Helios

{question}

How to set the retention period for Continuous Backups in Helios?

{question}

{answer}

Default Retention Period

• The default retention period in Helios is 7 days.
• For the Standard edition, the maximum retention period is 7 days.
• The Enterprise edition allows extending the retention period up to 90 days or longer.

This article offers guidance on configuring the retention period for Continuous Backup in your Workspace Group (WSG).

Recommended Retention Period

• The minimum recommended retention period is at least 3 days to provide enough time to resolve any issues before the data is permanently deleted.
• The maximum recommended retention period varies depending on individual use cases, where you want to allow enough time for the team to identify issues and restore the data if needed.
  • Be aware that extending the retention period will cause higher storage costs because data will accumulate over time.

How to change the Retention Period

• Ensure your workspace is online and that you've created a key for the Management API.
  • You can follow this guide to create the API key if you haven't already.
• Connect to your workspace through a SQL Editor and verify the current value of the bottomless_gc_retention_period_minutes engine variable using the query below:
  • select @@bottomless_gc_retention_period_minutes;
• The current value will show the retention period in minutes that you have set. For example, if it is 10080, it means that the current retention period is 10080 minutes, which equals 7 days.
• Now, you can go to the SingleStore Management API page using this link.
• On that page, open the Authorize section by clicking on it:

• In the pop-up screen, enter your API key, click on Authorize and close out if once you are authenticated:

• Now scroll down to the API key that updates the retention period and click on it.
  • Its full path is: /v1/workspaceGroups/{workspaceGroupID}/storage/retentionPeriod
• Edit it by clicking on the "Try it out" button and update the following settings in the API:
  • Enter your WokrspaceGroupID in the parameters field.
  • Enter the new desired retention period in the Request body.

• Now, click on "Execute" and review the Response body for any errors.
  • If everything is working correctly, you'll see a 200 response code, indicating the change was successfully applied.
• You can confirm the change by reviewing the updated value of the bottomless_gc_retention_period_minutes engine variable using the below query:
  • select @@bottomless_gc_retention_period_minutes;

For more details, see the official documentation:
Continuous Backups in SingleStore

{answer}