Skip to content

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Sep 5, 2025

Summary

We're updating the way we present DO Storage API to clearly delineate between the older API for KV-backed DOs, and the newer APIs for SQLite-backed DOs.

  1. Previous "Durable Object Storage" chapter has been split into:
    • "KV-backed Durable Object Storage (Legacy)"; and,
    • "SQLite-backed Durable Object Storage".
  2. Both of the two new chapters start with the same introduction, explaining the differences between the two.
  3. Both pages start with a note component that identifies whether the page is for SQLite-backed DOs or KV-backed DOs.
  4. Repeated text (e.g. Alarms, Other methods, etc) has been put into partial files.
  5. Pending The KV API for SQLite DOs have been modified to reference the new synchronous KV API.
  6. All of the links have been updated to the most logical route. Unless explicitly required, all links will direct to sqlite-storage-api.

Screenshots (optional)

Documentation checklist

  • Is there a changelog entry (guidelines)? If you don't add one for something awesome and new (however small) — how will our customers find out? Changelogs are automatically posted to RSS feeds, the Discord, and X.
  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@Oxyjun Oxyjun marked this pull request as ready for review September 5, 2025 16:17
@github-actions github-actions bot added size/xl product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ labels Sep 5, 2025
Copy link
Contributor

github-actions bot commented Sep 5, 2025

This PR requires additional review attention because it affects the following areas:

Redirects

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /durable-objects/api/storage-api/

Partials

This PR updates partial files, which are pieces of content used across multiple files in our Render component.

- Returns all keys and values associated with the current Durable Object in ascending sorted order based on the keys' UTF-8 encodings.
- The type of each returned value in the [`Iterable`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_iterable_protocol) will be whatever was previously written for the corresponding key.

- Be aware of how much data may be stored in your Durable Object before calling this version of `list` without options because all the data will be loaded into the Durable Object's memory, potentially hitting its [limit](/durable-objects/platform/limits/). If that is a concern, pass options to `list` as documented below.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is also not a concern with the Iterable unless the user reads the whole thing and stores it in memory. Not sure if we need to change this, but it's a bit different than the eager array result.

@Oxyjun Oxyjun assigned Oxyjun and unassigned KianNH Sep 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ size/xl
Projects
None yet
Development

Successfully merging this pull request may close these issues.