Skip to content

[DO] Clarifying DO creation behaviour with location hint #20348

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

Closed
wants to merge 2 commits into from
Closed

[DO] Clarifying DO creation behaviour with location hint #20348

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a28b903
Replacing warning to be more specific
Oxyjun Feb 27, 2025
fb457d2
Directing users to retry in the event of failure.
Oxyjun Feb 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/content/docs/durable-objects/reference/data-location.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,9 @@ let durableObjectStub = OBJECT_NAMESPACE.get(id, { locationHint: "enam" });
```

:::caution
If the location hint cannot be respected when creating a Durable Object, the Durable Object creation will fail.

Hints are a best effort and not a guarantee. Unlike with jurisdictions, Durable Objects will not necessarily be instantiated in the hinted location, but instead instantiated in a data center selected to minimize latency from the hinted location.
This is a [retryable](/durable-objects/best-practices/error-handling/) error. If this happens, retry the operation.
Comment on lines +75 to +77
Copy link
Contributor

@Frederik-Baetens Frederik-Baetens Apr 14, 2025

Choose a reason for hiding this comment

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

I'd take this out of a caution block, since this is a good thing. I'd just get rid of this block together, and add it to one of the paragraphs above. E.g.:

"To manually create Durable Objects in another location, provide an optional locationHint parameter to get(). The Durable Object is guaranteed to be created in the specified region. ..."

This seems better to me, because the "If the location hint cannot be respected" failure condition doesn't really exist in our codebase as it stands. We don't go over all possible locations in a region to store your Durable Object. We just try a location, and if it fails, your request fails in the same way that any Durable Object request can fail. That's also why I would drop the bit about a retryable operation. Not all errors you get when specifying a location hint are retryable. E.g. you can get an overloaded exception back, just like you can without a location hint, and those should generally not be retried.

:::

### Supported locations
Expand Down
Loading