Skip to content

docs(durable-functions): mark v3 entity-lock API as won't-restore (#317) #331

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
YunchuWang wants to merge 1 commit into from
+5 −2
Closed

docs(durable-functions): mark v3 entity-lock API as won't-restore (#317) #331

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions packages/azure-functions-durable/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,11 @@ changed:
`context.df.isLocked()` and the `DurableLock` / `LockState` / `LockingRulesViolationError` exports
are removed. Acquire locks with the core `context.entities.lockEntities(...entityIds)` (returns a
`LockHandle` — call `release()`, ideally in a `finally`) and query with
`context.entities.isInCriticalSection()`. Restoring the v3 `df.lock` / `isLocked` surface is tracked
in [#317](https://github.com/microsoft/durabletask-js/issues/317).
`context.entities.isInCriticalSection()`. This is the permanent, supported API — the v3 `df.lock` /
`isLocked` surface (and the `DurableLock` / `LockState` / `LockingRulesViolationError` types) will
**not** be restored; use the core `context.entities.*` lock API instead. See
[#317](https://github.com/microsoft/durabletask-js/issues/317) for the cross-SDK rationale (the
Python SDK ships only this core-native lock API and never exposed a `df.lock` / `is_locked` surface).
- **`context.df.callHttp(...)` now throws.** v3 ran durable HTTP as a host-managed activity; the
consolidated gRPC backend has no equivalent primitive. Implement an HTTP activity in your app and
call it from the orchestrator. Restoring `callHttp` as a worker-side durable activity is tracked in
Expand Down
Loading