[Durable Objects] Document transaction API changes with SQLite. #17698
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kentonv
requested review from
a team,
elithrar,
joshthoward and
vy-ton
as code owners
![hyperlint-ai[bot]](https://avatars.githubusercontent.com/in/718456?s=60&v=4){kind=small}
github-actions
bot
added
size/s
product:durable-objects
Deploying cloudflare-docs with
|
| Latest commit: |
7ebe21f
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c47a2558.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://kenton-transactions-with-sql.cloudflare-docs-7ou.pages.dev |
kentonv
force-pushed
the
kenton/transactions-with-sqlite
branch
from
2e3ebd4 to
2fcdc88
Compare
Contributor
|
Files with changes (up to 15)
|
kentonv
force-pushed
the
kenton/transactions-with-sqlite
branch
2 times, most recently
from
d767663 to
50a6805
Compare
lambrospetrou
approved these changes
Oct 22, 2024
These existing links were just broken. Though, arguably they should actually go to `/durable-objects/best-practices/access-durable-objects-storage/#sqlite-storage-backend`, perhaps? For now I just fixed the links.
kentonv
force-pushed
the
kenton/transactions-with-sqlite
branch
from
ada952b to
7ebe21f
Compare
vy-ton
reviewed
Oct 22, 2024
| * When using [the SQLite-backed storage engine](/durable-objects/best-practices/access-durable-objects-storage/#sqlite-storage-backend), the `txn` object is obsolete. Any storage operations performed directly on the `ctx.storage` object, including SQL queries using [`ctx.storage.sql.exec()`](#sqlexec), will be considered part of the transaction. | ||
|
|
||
| ### transactionSync | ||
|
|
Contributor
There was a problem hiding this comment.
Can we add a working example for reference?
Oxyjun
approved these changes
Oct 23, 2024
kentonv
force-pushed
the
kenton/transactions-with-sqlite
branch
2 times, most recently
from
f825f3c to
3718c36
Compare
Member
Author
|
I added an example but in retrospect it's a bad example because as written it doesn't actually need transactionSync(): we automatically guarantee atomicity of queries performed with no await in between. I need a different example where the thrown exception actually rolls something back. That's the part you can only do with transactionSync(). |
kentonv
force-pushed
the
kenton/transactions-with-sqlite
branch
from
3718c36 to
7ebe21f
Compare
Member
Author
|
I reverted the example, so this is back to what was reviewed and approved previously. I'm just going to merge this as-is without an example rather than let it be delayed further. |
Member
Author
|
For the record this was my example: 3718c36 But again, it's a bad example because it doesn't actually benefit from the use of |
harshil1712
pushed a commit
that referenced
this pull request
Dec 3, 2024
* [Durable Objects] Document transaction API changes with SQLite. * [Durable Objects] Fix broken links to SQLite class creation docs. These existing links were just broken. Though, arguably they should actually go to `/durable-objects/best-practices/access-durable-objects-storage/#sqlite-storage-backend`, perhaps? For now I just fixed the links.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document that:
storage.transaction()API applies to SQL queries.storage.transactionSync()for synchronous transactions.