Skip to main content

Backups

Deno KV is currently in beta

Deno KV is currently experimental and subject to change. While we do our best to ensure data durability, data loss is possible, especially around Deno updates.

Executing Deno programs that use KV currently requires the --unstable flag, as below:

deno run -A --unstable my_kv_code.ts

KV databases hosted on Deno Deploy can be continuously backed up to your own S3-compatible storage buckets. This is in addition to the replication and backups that we internally perform for all data stored in hosted Deno KV databases to ensure high availability and data durability.

This backup happens continuously with very little lag, enabling point-in-time-recovery and live replication. Enabling backup for KV databases unlocks various interesting use-cases:

  • Retrieving a consistent snapshot of your data at any point in time in the past
  • Running a read-only data replica independent of Deno Deploy
  • Pushing data into your favorite data pipeline by piping mutations into streaming platforms and analytical databases like Kafka, BigQuery and ClickHouse

Configuring backup to Amazon S3​

First, create a bucket on the AWS console with default configuration:

create backup bucket

Next, create an IAM user and grant it PutObject access to the bucket:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Action": "s3:PutObject",
      "Resource": "arn:aws:s3:::kv-backup-demo/*"
    }
  ]
}

Now, add the bucket in Deno Deploy dashboard:

add backup to dashboard

Configuring backup to Google Cloud Storage​

Google Cloud Storage (GCS) is compatible with the S3 protocol, and can also be used as a backup target. First, create a bucket:

create bucket on gcs

Then go to "IAM & Admin" in your GCP console, create a service account, and grant it Storage Object Admin access to the bucket:

grant storage object admin

After the new service account is ready, go to the Settings section in Cloud Storage console, and find the Interoperability tab. Create an HMAC access key for the service account.

create hmac key

Save the access key and secret, and go back to your Deno Deploy dashboard. In KV backup settings, Choose "Google Cloud Storage" and paste the access key and secret values into the "Access key ID" and "Secret access key" fields correspondingly.

Using backups​

S3 backups can be used with the denokv tool. Please refer to the documentation for more details.