Skip to content
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

KV: add bulk gets documentation #21392

Open
wants to merge 10 commits into
base: production
Choose a base branch
from

Conversation

teresalves
Copy link

Summary

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.

Copy link
Contributor

hyperlint-ai bot commented Apr 3, 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

Enhanced KV documentation to include bulk retrieval of key-value pairs.

  • Updated the get() method documentation to support multiple keys retrieval.
  • Added examples for fetching multiple keys and their responses.
  • Introduced getWithMetadata() method for retrieving values with associated metadata.

Modified Files

  • src/content/docs/kv/api/read-key-value-pairs.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.

@thomasgauvin thomasgauvin marked this pull request as ready for review April 4, 2025 13:32
@@ -4,5 +4,5 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
"typescript.tsdk": "node_modules/typescript/lib",
"cSpell.enableFiletypes": ["mdx"],
"files.associations": { "__redirects": "plaintext", "_headers": "plaintext" }
"files.associations": { "__redirects": "plaintext", "_headers": "plaintext", "*.mdx": "markdown" },
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this an intentional change? I don't actually know what this does.

Copy link
Author

Choose a reason for hiding this comment

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

This was me, I was having some issues rendering the mdx files locally. Reverted it :)

@thomasgauvin
Copy link
Contributor

There is not enough size difference between #### and ##### @Oxyjun @KianNH. Any chance we can increase the font size for ####?

@Oxyjun
Copy link
Contributor

Oxyjun commented Apr 8, 2025

There is not enough size difference between #### and ##### @Oxyjun @KianNH. Any chance we can increase the font size for ####?

You're right that the size difference isn't big between H4 and H5. I can raise this for discussion within the team :D

FYI, as a general rule of thumb, we want to avoid H4s and lower - at that level of granularity of headings, users might not find the heading hierarchy very useful. If you have a single page which warrants H5s, I would recommend creating a new chapter it?


You can now retrieve up to 100 keys in a single bulk read request made to Workers KV.

This makes it easier to
Copy link
Contributor

Choose a reason for hiding this comment

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

Incomplete sentence FYI @thomasgauvin

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants