-
Notifications
You must be signed in to change notification settings - Fork 8.6k
[DO] Updating Durable Objects storage API docs #24964
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: production
Are you sure you want to change the base?
Conversation
This PR requires additional review attention because it affects the following areas: RedirectsThis PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:
PartialsThis PR updates partial files, which are pieces of content used across multiple files in our Render component.
|
src/content/partials/durable-objects/api-storage-introduction.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Lambros Petrou <[email protected]>
- 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. |
There was a problem hiding this comment.
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.
src/content/partials/durable-objects/api-storage-introduction.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: Lambros Petrou <[email protected]>
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.
note
component that identifies whether the page is for SQLite-backed DOs or KV-backed DOs.sqlite-storage-api
.Screenshots (optional)
Documentation checklist