Skip to content

[DO] KV API status clarification #22577

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

Merged
merged 5 commits into from
May 21, 2025
Merged

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented May 20, 2025

Summary

  1. Clarifying that KV API still remains (since it's supported by SQLite-backed DOs).
  2. Turning the note into a partial file for easy maintenance.
  3. Adding more detail into the note to mention other capabilities SQLite-backed DOs have (thereby further justifying the recommendation).
  4. Moving the table of the API comparison up, so that it appears before the large note components.

Screenshots (optional)

Documentation checklist

  • 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.

@github-actions github-actions bot added the product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ label May 20, 2025
Copy link
Contributor

hyperlint-ai bot commented May 20, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Clarified the status of the KV API and improved documentation structure for SQLite-backed Durable Objects.

  • Clarified that the KV API remains supported due to SQLite-backed Durable Objects.
  • Converted the note into a partial file for easier maintenance.
  • Enhanced the note with additional details about SQLite-backed Durable Objects' capabilities.
  • Repositioned the API comparison table for better visibility.

Modified Files

  • src/content/docs/durable-objects/api/storage-api.mdx
  • src/content/docs/durable-objects/best-practices/access-durable-objects-storage.mdx
  • src/content/docs/durable-objects/reference/durable-objects-migrations.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/durable-objects/ @elithrar, @vy-ton, @joshthoward, @oxyjun, @harshil1712, @cloudflare/pcx-technical-writing
* @cloudflare/pcx-technical-writing

@Oxyjun Oxyjun merged commit 92c1c1a into production May 21, 2025
11 checks passed
@Oxyjun Oxyjun deleted the jun/do/storage-api-clarification branch May 21, 2025 09:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants