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

[Do Not Review] Docs feature branch: SQLite in DO #16903

Draft
wants to merge 5 commits into
base: production
Choose a base branch
from

Conversation

vy-ton
Copy link
Contributor

@vy-ton vy-ton commented Sep 18, 2024

TODO:

  • Overview
  • Pricing, Limits
  • Get started walkthrough
  • (New) Best Practices > Query embedded SQL database: code examples for different SQL tasks
  • API > Transactional Storage: add SQL API
  • (New) Examples > Use the SQL API
  • (New) Examples > SQL schema migrations
  • Reference > Durable Objects migrations: add new_sqlite_classes
  • (New) Platform: D1 vs DO comparison
  • Changelog

@github-actions github-actions bot added product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ size/s labels Sep 18, 2024
Copy link

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 5e60ded
Status: ✅  Deploy successful!
Preview URL: https://9d415e89.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://sqlite-in-do.cloudflare-docs-7ou.pages.dev

View logs

Copy link

@vy-ton
Copy link
Contributor Author

vy-ton commented Sep 18, 2024

We're going to use sqlite-in-do as the docs feature branch. Please open any docs PR against this branch so we can merge it pre-launch.

(New) Examples > Use the SQL API

@harshil1712 Could you work on adding an example or even multiple? Kenton's example in the public blog should be available in docs as well.

@github-actions github-actions bot added size/m and removed size/s labels Sep 19, 2024
Copy link
Contributor

@hyperlint-ai hyperlint-ai bot left a comment

Choose a reason for hiding this comment

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

4 files reviewed, 1 outstanding issue(s) found.

* Optional variable number of arguments that correspond to the `?` placeholders in `query`.

#### Returns
A cursor (`SqlStorageCursor`) that implements Javascript Iterator of query row results as objects with supported methods:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
A cursor (`SqlStorageCursor`) that implements Javascript Iterator of query row results as objects with supported methods:
A cursor (`SqlStorageCursor`) that implements JavaScript Iterator of query row results as objects with supported methods:

Issues:

  • Style Guide - (Terms-error) Use 'JavaScript' instead of 'Javascript'.

Fix Explanation:

The change from 'Javascript' to 'JavaScript' aligns with standard spelling conventions and style guides. This correction is necessary to maintain the quality and accuracy of the documentation. No other issues were identified in the sentence, so only this term needs to be corrected.

@vy-ton vy-ton changed the title Docs feature branch: SQLite in DO [Do Not Review] Docs feature branch: SQLite in DO Sep 19, 2024
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/m
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants