Skip to content

store-and-sync-state: use this.sql synchronously #25396

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Oct 23, 2025
Merged

store-and-sync-state: use this.sql synchronously #25396

merged 3 commits into from
Oct 23, 2025

Conversation

@mmkal
Copy link
Contributor

@mmkal mmkal commented Sep 24, 2025

Summary

fixes #25018

copying summary from there:

Existing documentation URL(s)

https://developers.cloudflare.com/agents/api-reference/store-and-sync-state/#sql-api

The first example of the this.sql helper uses await which is functional but misleading that it's necessary(?) and doesn't showcase the value:

export class MyAgent extends Agent<Env> {
  async onRequest(request: Request) {
    let userId = new URL(request.url).searchParams.get('userId');

    // 'users' is just an example here: you can create arbitrary tables and define your own schemas
    // within each Agent's database using SQL (SQLite syntax).
    let user = await this.sql`SELECT * FROM users WHERE id = ${userId}`
    return Response.json(user)
  }
}

I think it's also probably misleading to imply the return value from that particular sql query is user given this.sql returns an array? Have I got this wrong?

What changes are you suggesting?

An sync/singular example like

let [user] = this.sql`select * from users where id = ${userId}`

Additional information

Intro blog mentions it's synchronous! https://blog.cloudflare.com/sqlite-in-durable-objects/#reads-and-writes-are-synchronous

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.

@github-actions github-actions bot added product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. September 2025 labels Sep 24, 2025
@mmkal mmkal mentioned this pull request Sep 24, 2025
Closed
threepointone
threepointone approved these changes Oct 23, 2025
View reviewed changes
Copy link
Contributor

@threepointone threepointone left a comment

Choose a reason for hiding this comment

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

lgtm, tweaked to extract first result of users array as user

@threepointone threepointone merged commit 1df77aa into cloudflare:production Oct 23, 2025
2 checks passed
@workers-devprod workers-devprod added the contribution [Holopin] Recognizes a docs contribution, big or small label Oct 23, 2025
@holopin-bot
Copy link

holopin-bot bot commented Oct 23, 2025

Congratulations @mmkal, the maintainer of this repository has issued you a holobyte! Here it is: https://holopin.io/holobyte/cmh3kmkhg005rjr04kypmrsbg

This badge can only be claimed by you, so make sure that your GitHub account is linked to your Holopin account. You can manage those preferences here: https://holopin.io/account.
Or if you're new to Holopin, you can simply sign up with GitHub, which will do the trick!

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

Reviewers

@threepointone threepointone threepointone approved these changes

@Oxyjun Oxyjun Oxyjun approved these changes

@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner

@rita3ko rita3ko Awaiting requested review from rita3ko rita3ko is a code owner

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@thomasgauvin thomasgauvin Awaiting requested review from thomasgauvin thomasgauvin is a code owner

Assignees

@Oxyjun Oxyjun

Labels

contribution [Holopin] Recognizes a docs contribution, big or small product:agents Build and deploy AI-powered Agents on Cloudflare that can act autonomously. September 2025 size/xs

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Durable objects SQL API docs use await unnecessarily

8 participants

@mmkal @threepointone @Oxyjun @elithrar @irvinebroque @rita3ko @thomasgauvin @workers-devprod