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

[Durable Objects] Adding "What are Durable Objects" chapter. #19570

Merged
merged 13 commits into from
Jan 31, 2025

Conversation

Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Jan 30, 2025

Summary

@lambrospetrou has authored a "What are Durable Objects?" chapter which introduces users to the overall concept of DO.

Thanks to all the contributors: @vy-ton @joshthoward @Frederik-Baetens @justin-mp @a-robinson

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.

@Oxyjun Oxyjun requested review from elithrar, vy-ton and a team as code owners January 30, 2025 18:30
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.

13 files reviewed, 3 total issue(s) found.

Oxyjun and others added 3 commits January 30, 2025 18:31
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
Co-authored-by: hyperlint-ai[bot] <154288675+hyperlint-ai[bot]@users.noreply.github.com>
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.

13 files reviewed, 2 total issue(s) found.

@github-actions github-actions bot added product:durable-objects Durable Objects: https://developers.cloudflare.com/workers/learning/using-durable-objects/ size/m labels Jan 30, 2025
Copy link

cloudflare-workers-and-pages bot commented Jan 30, 2025

Deploying cloudflare-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 7f509ed
Status: ✅  Deploy successful!
Preview URL: https://7b8be0ec.cloudflare-docs-7ou.pages.dev
Branch Preview URL: https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev

View logs

Copy link

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/durable-objects/what-are-durable-objects/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/what-are-durable-objects/
https://developers.cloudflare.com/durable-objects/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/
https://developers.cloudflare.com/durable-objects/api/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/api/
https://developers.cloudflare.com/durable-objects/best-practices/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/best-practices/
https://developers.cloudflare.com/durable-objects/changelog/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/changelog/
https://developers.cloudflare.com/durable-objects/demos/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/demos/
https://developers.cloudflare.com/durable-objects/durable-objects-rest-api/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/durable-objects-rest-api/
https://developers.cloudflare.com/durable-objects/examples/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/examples/
https://developers.cloudflare.com/durable-objects/get-started/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/get-started/
https://developers.cloudflare.com/durable-objects/get-started/tutorial-with-sql-api/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/get-started/tutorial-with-sql-api/
https://developers.cloudflare.com/durable-objects/get-started/tutorial/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/get-started/tutorial/
https://developers.cloudflare.com/durable-objects/observability/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/observability/
https://developers.cloudflare.com/durable-objects/platform/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/platform/
https://developers.cloudflare.com/durable-objects/reference/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/reference/
https://developers.cloudflare.com/durable-objects/tutorials/ https://jun-do-what-is-do.cloudflare-docs-7ou.pages.dev/durable-objects/tutorials/


---

A Durable Object is a special kind of [Cloudflare Worker](/workers/) which uniquely combines compute with storage. Like a Worker, a Durable Object is automatically provisioned geographically close to where it is first requested, starts up quickly when needed, and shuts down when idle. You can have millions of them around the world. However, unlike regular Workers:
Copy link
Contributor

Choose a reason for hiding this comment

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

Might be worth indicating that, unlike a Cloudflare Worker, a Durable Object cannot be accessed directly. Requests from the public internet first need to go through a Worker, the Worker makes a call to the Durable Object via the binding. That's a pretty significant difference

Copy link
Contributor

Choose a reason for hiding this comment

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

In this page there isn't any mention of code specific things, so I believe this doesn't fit well in these sections.

It's important, 100%, but someone new reading this page won't understand that part anyway without code.
The other tutorial/walkthrough pages should cover this detail.

@Oxyjun Oxyjun merged commit b63fa0f into production Jan 31, 2025
12 checks passed
@Oxyjun Oxyjun deleted the jun/do/what-is-do branch January 31, 2025 11:01
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.

6 participants